README.md

Dokdo Documentation

https://docs.dokdo.sh

Dokdo Documentation made with MkDocs Material

Requirements

• Python >= 3.6

Some Debian/Ubuntu systems may need to install python3-venv:
e.g., apt install python3.10-venv

Installation

Dokdo documentation development utilises Python venv:

1: Create the Python Virtual Environment and install dependencies

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Later on, you can exit the virtual environment using the 'deactivate' command.

deactivate

2: Serve locally

mkdocs serve

Then visit: http://127.0.0.1:8000

3: Deploy to GH Pages

(admins-only)

mkdocs build
mkdocs gh-deploy --force