MkDocs

This wiki is generated by the MkDocs static site generator.

For full documentation visit mkdocs.org. You can find its source code on github.

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.

Themes

Material

• adding admonitions (notes, warnings, etc)

Localization

While the built-in¹ MkDocs themes ship with translations, an MkDocs site's content is commonly internationalized with static markdown files via the mkdocs-static-i18n plugin. An alternative approach using the mdpo utility would leverage standard PO files.