What problem does it solve?
Start a local MkDocs preview server to view training material changes.
Core Features & Use Cases
- Live preview of documentation changes before committing.
- Docker-based server startup using the official training-mkdocs image.
- Alternative local server using uv for quick testing.
Quick Start
Check if a server is already running:
docker ps --filter "ancestor=ghcr.io/nextflow-io/training-mkdocs:latest" --format "{{.ID}}"
- If a container ID is returned, the server is already running at http://127.0.0.1:8000/
- If no output, start a new server
Start the server using Docker (recommended):
docker run --rm -d -p 8000:8000 -v ${PWD}:/docs -w /docs/docs/en ghcr.io/nextflow-io/training-mkdocs:latest
Alternative - using uv:
uv run _scripts/docs.py serve
After starting the server:
- Open http://127.0.0.1:8000/ (or http://0.0.0.0:8000/ for Docker)
- Pages auto-refresh when you save changes
- Check console for any build errors
- Use /stop-preview command or Ctrl+C to stop the server