Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

• python -m mkdocs new [dir-name] - Create a new project.
• python -m mkdocs serve - Start the live-reloading docs server.
• python -m mkdocs build - Build the documentation site.
• python -m mkdocs gh-deploy - Deploys site to the gh-pages branch.
• python -m 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.