preview

Start a local MkDocs preview server via Docker or uv on port 8000.

261|325|Updated Aug 27, 2020
One-click install
npx skills add https://github.com/nextflow-io/training --skill preview-nextflow-io
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: preview
Source: https://github.com/nextflow-io/training/tree/main/.claude/skills/preview
Command: npx skills add https://github.com/nextflow-io/training --skill preview-nextflow-io

SYSTEM DOCUMENTATION & REQUIREMENTS

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

Frequently Asked Questions about preview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I preview MkDocs documentation changes locally before committing?▼

Preview MkDocs documentation changes locally by starting a server with Docker using the training-mkdocs image or by running the uv serve script, which hosts the site on port 8000 with live-reload.

What is the best way to run a local documentation server for training materials?▼

The best way to run a local documentation server for training materials is using Docker with the ghcr.io/nextflow-io/training-mkdocs:latest image, mounting your working directory to serve content on port 8000.

Can I use uv instead of Docker to serve MkDocs locally?▼

Yes, you can use uv instead of Docker to serve MkDocs locally by running the _scripts/docs.py serve script, providing a quick alternative for testing how documentation content renders.

How do I check if a local MkDocs preview server is already running?▼

Check if a local MkDocs preview server is already running by executing docker ps with a filter for the training-mkdocs ancestor image, which returns the container ID if the server is active.

Does the MkDocs local preview server automatically refresh when I save changes?▼

Yes, the MkDocs local preview server automatically refreshes pages when you save changes to your documentation, allowing you to instantly check formatting and test how content renders.

How do I stop a running local preview server?▼

Stop a running local preview server by using the /stop-preview command or pressing Ctrl+C in the console, which halts the Docker container or uv process serving the documentation.