Technology Documentation

View the page

Host Locally

Linux

1. Install dependencies (recommended inside a venv) requirements file:

   python -m venv .venv && . .venv/bin/activate && pip install -r requirements.txt

2. Serve the site for live preview (bind to all interfaces for dev containers):

   mkdocs serve -a 0.0.0.0:8000

   Open the preview in the host browser:

   "$BROWSER" http://localhost:8000

Windows

1. Install dependencies (recommended inside a venv) requirements file:

   python -m venv .venv
   .\.venv\Scripts\Activate.ps1
   pip install -r requirements.txt

2. Serve the site for live preview (bind to all interfaces for dev containers):

   mkdocs serve -a 0.0.0.0:8000

   Open the preview in the host browser:

   Start-Process http://localhost:8000