Mkdocs examples

Admonitions¶

Standard¶

Custom name text

Look in documentation for alternative icon options.

Standard type qualifiers (for the icon): note; abstract; info; tip; success; question; warning; failure; danger; bug; example; quote

Collapsible¶

Custom name text

This is defined with ??? rather than !!! to start the admonition. ???+ defaults to open while ??? defaults closed.

Annotations¶

Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.

I'm an annotation! I can contain code, formatted text, images, ... basically anything that can be expressed in Markdown.

Nested¶

Phasellus posuere in sem ut cursus (1)

Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

I'm an annotation!
I'm an annotation as well!

Buttons¶

Test Button

Code Blocks¶

Include Code Blocks with copy feature

import pandas as pd

bubble_sort_example.py
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]

theme:
  features:
    - content.code.annotate # (1) (2)

I'm a code annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.
This is another

Content Tabs¶

TAB 1TAB 2

Add content here

tab 2 content here.