Welcome to MkDocs

For full documentation visit mkdocs.org.


  • 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.


Nav default: By default nav will contain an alphanumerically sorted, nested list of all the Markdown files found within the docs_dir and its sub-directories. Index files will always be listed first within a sub-section.

Project layout

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