To work on the website locally first create a virtual environment and install the required dependencies
python -m venv uppmax_venv
source uppmax_venv/bin/activate
pip install -r requirements.txt
Then serve the website and edit
mkdocs serve
Filename | Descriptions |
---|---|
mlc_config.json | Configuration of the link checker |
.spellcheck.yml | Configuration of the spell checker, use pyspelling -c .spellcheck.yml to do spellcheck locally |
.wordlist.txt | Whitelisted words for the spell checker, use pyspelling -c .spellcheck.yml to do spellcheck locally |