Skip to content

MkDocs Basics

For full documentation visit mkdocs.org.

Commands

  • 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.
    /Meeting Minutes    # Minutes of general meetings.
    /Templates          # Markdown templates for creating new pages.
    ...                 # Other markdown pages, images and other files.