Skip to content

Local Preview and Build

Use MkDocs locally to preview the documentation site and generate deployable static HTML.

Preview Locally

cd c:\Users\MichaelBrazell\tychonio\tychon-network-sniffer
& "C:\Program Files\Python312\python.exe" -m pip install --user -r docs-requirements.txt
& "C:\Program Files\Python312\python.exe" -m mkdocs serve

cd /path/to/tychon-network-sniffer
python3 -m pip install --user -r docs-requirements.txt
python3 -m mkdocs serve

Local preview URL:

http://127.0.0.1:8000/

Build Static HTML

python3 -m mkdocs build

Generated site output:

site/

Suggested Review Flow

  1. Refresh the browser after each content change.
  2. Check the homepage, nav, and at least one inner page.
  3. Verify mobile-sized layouts as well as desktop.
  4. Build static HTML before preparing the PR.