CONTRIBUTING.md

Contributing

Install requirements

• Python 3.11 or newer
• VENV is highly recommended
• Linux-based host highly recommended

Setup

# create a venv at project root with name of {path}
source .venv/{path} # will be gitignored
pip install mkdocs
pip install -r requirements.txt
pip install mkdocs-material

Dev Interactively

mkdocs serve

changes made in docs/ will be reflected in the browser session.

References

• MKDocs Installation
• Mkdocs-material Installation