README.md

NTC Handbook

This README should lay technical tasks like how to build the handbook frontend locally. This README is not part of the handbook, it's part of the frontend build process.

Editing the handbook via GitHub

In GitHub, navigate to the file you want to edit and click the edit button.

Click "Commit changes...".

Click "Commit changes".

Running locally

To develop on our handbook (everything in /docs), it's best to use Docker. But if not, it's also possible to use a virtual environment.

docker build -t handbook:latest .

Run a live session locally.

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs handbook

Running locally without Docker

Create a virtual environment and activate it.

python3 -m venv venv
source vent/bin/activate

pip install the same plugins listed in the Dockerfile.

mkdocs serve