Skip to content

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

Text Only
1
2
3
4
mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Admonitions

Attention grabber, can be used as a call out in a document.

Admonition examples

Basic

Note

Lorem ipsum

Text Only
1
2
!!! note
    Lorem ipsum

With custom title

Custom title

Lorem ipsum

Text Only
1
2
!!! note "Custom title"
    Lorem ipsum

Without title

Lorem ipsum

Text Only
1
2
!!! note ""
    Lorem ipsum

Collapsible (starts collapsed)

Note

Lorem ipsum

Text Only
1
2
??? note
    Lorem ipsum

Collapsible (starts expanded)

Note

Lorem ipsum

Text Only
1
2
???+ note
    Lorem ipsum

Types

The following types can be used: - note - abstract - info - tip - success - question - warning - failure - danger - bug - example - quote

More info

https://squidfunk.github.io/mkdocs-material/reference/admonitions