Markdown¶

Please Note: MkDocs uses python-markdown.

"#"¶

# page name

each additional bash is a heading

##  - h2

### - h3

#### - h4

##### - h5

The table of contents on the right of the webpage will draw its order of hierarchy from these "#" headings.

Dividers¶

You can create a line to divide the page with 3 consecutive hyphens.

---

Code Blocks¶

The code-blocks with the cool little copy buttons? It's three backticks for the beginning, and three to mark the end of the square, like so.

    ```
    ```

like this

Help Boxes¶

You can create this monstrosity:

Button

They can be nested using the indentation on the current line:

Another Button?

    ??? note "Need HELP?"
        ??? note "No, seriously????"    
            And then here is the content

    ??? note "Need HELP?"
        Here is some content.
        ??? note "No, seriously????"    
            Even more content.

Line Break¶

Sometimes your lines of text appear as a big paragraph even though the words are on different lines in your file this is because there are no line breaks. This short paragraph was written like this, for example:

Sometimes
your
lines
of
text
appear
as
a
big
paragraph
even though
the words are on different lines
in your file
this is because there are no line breaks.

In python markdown, you can separate the lines in a paragraph, without creating a new paragraph, using:

    <br>

Example:

    Sometimes your lines of text <br>
    Appear as a big paragraph <br>
    Even though they should not <br>

Sometimes your lines of text
Appear as a big paragraph
Even though they should not

Sources¶