Skip to content

MkDocs build steps

[!NOTE] For the latest implementation status, please refer to Functional Implementation Status (Remaining Functionality).

Recommended: Create a virtual environment and install dependencies.

python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocs-static-i18n mkdocs-git-revision-date-localized

Build/local serve:

cd Docs
mkdocs build
# or check locally: mkdocs serve -a 0.0.0.0:8001

If you get an error that a plugin or extension is missing, please add the necessary packages according to the error message.