Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

• 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.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Fenced code

public float GetMaxPowerTorque (float rpm)
    {
    float engineTorque;

    if (rpm < parameters.idleRpm)
        {
        engineTorque = CommonTools.CubicLerp(
            0.0f, GetFrictionTorque(0), parameters.idleRpm,
            GetFrictionTorque(parameters.idleRpm) + parameters.idleRpmTorque,
            rpm);
        }
    }

Tables

Standard table:

With surrounding borders:

Absolutely minimum tables:

Alerts

Testing Bootstrap CSS Pretty nice out of the box...

Now with a link matching the alert style.

Admonitions

Text effects

Strikethrough text.

Underline

Use altf4 to enter God mode. Ctrlq to quit.

Math

The Gamma function satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral

$$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.$$

Tip: To make sure mathematical expressions are rendered properly on your website, include MathJax into your template:

<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
</script>

Responsive vector graphics

Uses a custom build of Fabric.js that includes Text and Shadow modules.

And now our own texturecanvas.js helper using Fabric.js internally:

Markdown NPP

Test document

This document tests Markdown highlighting features.

Firstly, a single italic or bold or otherwise emphasised word. A run of italic words together or bold words together or an emphasised passage should work too.

Emphasis can be used in the middle of a word:

unfriggingbelievable oh_my_god

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formatting syntax. For example, if you wanted to surround a word with literal asterisks (instead of an HTML <em> tag), you can use backslashes before the asterisks, like this:

*literal asterisks*

A single word of inline code or longer inline code phrase. To include a literal backtick character within a code span, you can use multiple backticks as the opening and closing delimiters:

There is a literal backtick (`) here.

A block of code follows:

int myThing()
{
    return 2 + 2;
}

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.

Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:

This is a header.

1. This is the first list item.
2. This is the second list item.

Here's some example code:

return shell_exec("echo $input | $markdown_script");

Here are bullet points represented all the different valid ways:

• First point
• Second point
• Third point

Same bullet points with more space between bullets:

• First point

• Second point

• Third point

Now some longer bullet points:

• A point which is a bit longer and drops down onto another line.

  In fact it even has another paragraph, which is fine.

• Another point in the same format as the third

Here is a numbered list:

1. Write code
2. Test code

3. Drink coffee

   3.1 Eat a biscuit

This text will catch any formatting which has overflowed from a delimiter.