MkDocs

For full documentation visit mkdocs.org.

Docker:

sudo pip3 install mkdocs-material jinja2==3.0.3
mkdocs serve --dev-addr 172.17.0.5:80

Commands

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

Lists of extensions:

• mkdocs.org
• mkdocs-material
• emojis

Project layout

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

Dashes

• qwer
• asdf
• one-dash
• two – dashes
• tree — dashes

Abbrs

The HTML specification is maintained by the W3C.

Math

\[ \operatorname{ker} f=\{g\in GG:f(g)=e_{H}\}{\mbox{.}} \]

The homomorphism \(f\) is injective if and only if its kernel is only the singleton set \(e_G\), because otherwise \(\exists a,b\in G\) with \(a\neq b\) such that \(f(a)=f(b)\).

Lists

Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus tellus non sem sollicitudin, quis rutrum leo facilisis.

Cras arcu libero

Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla. Nullam dignissim ultrices urna non auctor.

• Lorem ipsum dolor sit amet, consectetur adipiscing elit
• Vestibulum convallis sit amet nisi a tincidunt
  • In hac habitasse platea dictumst
  • In scelerisque nibh non dolor mollis congue sed et metus
  • Praesent sed risus massa
• Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

1. Loosely speaking, “CPU inside CPU” starts first. More precisely, Firmware inside PCH (platform controller hub) or BMC (baseboard management controller) is executed first. Intel Management Engine runs in the PCH and starts before the CPU.
2. It performs basic hardware configuration and allows the CPU to come out of reset.
3. The first instruction that CPU executes is the instruction from 16-bytes below 4GB.
   • What is there?”
     • SPI flash memory is mapped to the top of the 32-bit address space.
     • Reads are forwarded by the chipset to the flash device.
     • The instruction at 0xFFFFFFF0 is a JMP instruction to the start of the UEFI platform initialization code (SEC phase)

Formatting

Highlighting is also possible and comments can be added inline.

This was deleted

H₂0

A^TA

Ctrl+Alt+Del

Tabs and code blocks

Tab 1Tab 2

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] # (1)!

1. I’m an annotation!

Phasellus posuere in sem ut cursus (1)

The range() function is used to generate a sequence of numbers.

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

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

Admonitions

Phasellus posuere in sem ut cursus

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

collapsible abstract

Lorem

collapsible info

Lorem

collapsible tip

asdf

collapsible success

asdf

collapsible question

asdf

collapsible warning

asdf

collapsible failure

asdf

collapsible danger

asdf

collapsible bug

asdf

collapsible example

asdf

collapsible quote

asdf

Inline

On the left:

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat Curabitur feugiat, tortor non consequat

On the right:

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat Curabitur feugiat, tortor non consequat