For full documentation visit mkdocs.org. For theme documentation visit Material for MkDocs.
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.
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
- Create local venv:
python3 -m venv .venv
- Install deps:
pip install mkdocs-material
- Serve page:
mkdocs serve