Style Samples¶

For full documentation visit mkdocs.org.

This is a paragraph of text¹ that goes on and on and on. It includes a a couple of footnotes². Text can be bold. Some things can be deleted in a strike out. Other things can be hi-lighted to draw attention to them if necesary. The usual bold, italic and underline etc. are available. You can also do subscripts H₂0 and superscripts A^TA as well and we can show off keys too Ctrl+Alt+Del

Grid Cards¶

Now a Look at Tabs¶

So this is what tabs are like.

Commands¶

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

Sub-Commands would go here¶

This is for sub-commands as an H3 heading.

Project layout¶

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

These are Admonitions¶

Now moving on to buttons¶

Primary Button Secondary Button

This is now a table for interest:¶

You can sort it on columns too!

Now it is time for a Bubble Sort¶

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Flowchart Time¶

Let's have a flowchart:

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];