Cinder Theme Specimen

Typography¶

Typefaces¶

• Headers: Inter
• Body: Open Sans
• Code: Hack

Body Copy¶

You think water moves fast? You should see ice. It moves like it has a mind. Like it knows it killed the world once and got a taste for murder. After the avalanche, it took us a week to climb out. Now, I don't know exactly when we turned on each other, but I know that seven of us survived the slide... and only five made it out.

Now we took an oath, that I'm breaking now. We said we'd say it was the snow that killed the other two, but it wasn't. Nature is lethal but it doesn't hold a candle to man.

Like inline code? Here is a string for you 010101010.

Lead Body Copy¶

Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.

Headings¶

All HTML headings, <h1> through <h6>, are available. .h1 through .h6 classes are also available, for when you want to match the font styling of a heading but still want your text to be displayed inline.

h1. Heading

h2. Heading

h3. Heading

h4. Heading

h5. Heading

h6. Heading

h1. Heading Secondary text

h2. Heading Secondary text

h3. Heading Secondary text

h4. Heading Secondary text

h5. Heading Secondary text

h6. Heading Secondary text

Blockquotes¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lists¶

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs help - Print this help message.

Horizontal Description Lists¶

Something

This is something

SomethingElse

This is something else

Contextual Colors¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

Code¶

Inline Code¶

This is an example of inline code #import requests

Preformatted Code Blocks with Syntax Highlighting

def request(method, url, **kwargs):
    """Constructs and sends a :class:`Request `.
    Usage::
      >>> import requests
      >>> req = requests.request('GET', 'https://httpbin.org/get')
      
    """

    # By using the 'with' statement we are sure the session is closed, thus we
    # avoid leaving sockets open which can trigger a ResourceWarning in some
    # cases, and look like a memory leak in others.
    with sessions.Session() as session:
        return session.request(method=method, url=url, **kwargs)

def get(url, params=None, **kwargs):
    r"""Sends a GET request.
    :param url: URL for the new :class:`Request` object.
    :param params: (optional) Dictionary, list of tuples or bytes to send
        in the body of the :class:`Request`.
    :param \*\*kwargs: Optional arguments that ``request`` takes.
    :return: :class:`Response ` object
    :rtype: requests.Response
    """

    kwargs.setdefault('allow_redirects', True)
    return request('get', url, params=params, **kwargs)

(Source code sample from the Python requests library, Apache License, v2.0)

Syntax highlighting support is available for and of the following languages listed on the highlightjs website. See the mkdocs "styling your docs" hljs_languages section for info on how to load languages dynamically.

Tables¶

Striped Table¶

Bordered Table¶

Buttons¶

Default Buttons¶

Link Button

Styled Buttons¶

Default

Primary

Success

Info

Warning

Danger

Button Sizes¶

Large button Large button

Default button Default button

Small button Small button

Extra small button Extra small button

Block Level Buttons¶

Block level button Block level button

Alerts¶

Callouts¶

Admonitions¶

The following admonitions are formatted like the callouts above but can be implemented in Markdown when you include the admonition Markdown extension in your mkdocs.yml file.

Add the following setting to mkdocs.yml:

markdown_extensions:
  - admonition

and then follow the instructions in the extension documentation to author admonitions in your documentation.

Cinder currently supports note, warning, and danger admonition types.

# this is a note
def func(arg) {
  # notable things are in here!
  return None
}

# this is a warning
def func(arg) {
  # be careful!
  return None
}

# this is dangerous
def func(arg) {
  # BOOM!
  return None
}