URL: https://docs.sourcebots.co.uk

To run this project locally, you'll need:

• Python (>=3.6, <3.12)
• pip

It's recommended to use a virtual environment:

python -m venv env
env\Scripts\activate.bat  # on windows
source env/bin/activate  # on macOS / Linux

Then, install dependencies:

pip install -r requirements.txt

mkdocs serve

This will launch a server on http://localhost:8000. Content in the server will live-reload as changes are made. If large refactors of the site structure are made, it's advisable to stop the server, make the changes, then restart it.

mkdocs build

This will build the site once, and place it in site/ in the root of the project. This may be useful to see which files are rendered, and how exactly to access them.

This project uses cspell for spell checking. Plugins are available for a variety of editors and a command line runner is available through npm:

npm install

npm run spellcheck

Words that cspell is unaware of can be added to the .spelling file.