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 -h - Print help message and exit.

Project layout

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

References

Usage

Admonitions (callouts)

!!! type "Optional Title"

    Text

Collapsible: change !!! to ???

Collapsible but expanded on load: ???+

Type Color Icon
note blue pencil
abstract lighter blue clipboard
info teal circle i
tip greenish teal flame
success green checkmark
question yellow green circle question mark
warning orange triangle exclamation
failure red x
danger red circle lightning
bug red shield bug
example purple test tube
quote gray quotes

Annotations

Requires: a marker, the annotate class, the content.

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

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

Footnotes

Footnote reference: [^1], [^2]

[^1]: Same line.

[^2]:
    Paragraph starts on next line and is indented by 4 spaces.

Formatting

Text can be deleted and replacement text added. This can also be combined into `onea single` operation. Highlighting is also possible and comments can be added inline.



Formatting can also be applied to blocks by putting the opening and closing tags on separate lines and adding new lines between the tags and the content.
  • This was marked ==highlight==
  • This was inserted ^^underline^^
  • This was deleted ~~strikethrough)~~
  • Subscripts use ~: H~2~O gives H2O
  • Superscripts use ^: A^T^A gives ATA
  • Keyboard keys use ++<key>++: ++ctrl+alt+del++
  • Key symbols

Definition Lists

Term

:   Definition

Task Lists

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

Tooltips

Link with tooltip, inline:

[Hover me](https://example.com "I'm a tooltip!")

Anything else:

Some content here.{ title="Important information" }

Abbreviations

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium