Local documentation¶

This project uses a Python virtual environment and MkDocs with the Material theme.

Prerequisites¶

cd web-examplerep-project
python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt

Use the live-reload server while editing:

mkdocs serve --livereload

Open the URL shown in the terminal (default http://127.0.0.1:8000).

mkdocs build

Output is written to site/ (ignored by git).

If you have push access and need to publish without CI:

mkdocs gh-deploy --force

Prefer the GitHub Actions workflow on the default branch for routine updates.