Welcome to MkDocs

Install MkDocs - https://www.mkdocs.org/#installing-mkdocs

Install Material Theme - https://squidfunk.github.io/mkdocs-material/getting-started/#installation

pip install mkdocs mkdocs-material

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

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

Useful links:

• Material for MkDocs https://squidfunk.github.io/mkdocs-material/

• Admonitions (tip, warning, info boxes) https://squidfunk.github.io/mkdocs-material/reference/admonitions/