Building Documentation with MkDocs

Project is built automatically using MkDocs and hosted on GitHub Pages.

Project layout

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

Commands

• pdm install - Install the project dependencies.
• pdm run mkdocs serve - Start the live-reloading docs server.

Other commands you can use:

• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.