docs-serve

Launch a MkDocs preview server and local review API for documentation approvals.

6|2|Updated Apr 5, 2026
One-click install
npx skills add https://github.com/i-standard1/yamasaki --skill docs-serve
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-serve
Source: https://github.com/i-standard1/yamasaki/tree/main/.claude/skills/docs-serve
Command: npx skills add https://github.com/i-standard1/yamasaki --skill docs-serve

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill runs a MkDocs preview server alongside a local review API to streamline documentation workflows, eliminating the need to juggle separate processes during doc development and review.

Core Features & Use Cases

  • MkDocs preview: Start a live preview of documentation at http://localhost:8000 for rapid iteration.
  • Approval API: Access a local endpoint at http://localhost:8765 to view and approve pending documentation changes.
  • Use Case: A developer or technical writer can edit docs, preview changes, and push approvals without leaving the local development environment.

Quick Start

Run the docs_serve script from the project root to start both the MkDocs preview and the approval API.

Frequently Asked Questions about docs-serve

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

FAQPage Schema
How do I preview MkDocs changes locally while managing documentation approvals?

MkDocs local preview is handled by running a single script that starts a live server on port 8000 and a local review API on port 8765. This allows developers and technical writers to iterate on documentation and manage approvals without juggling separate processes.

What is the best way to run a MkDocs preview server alongside a review API?

The best way to run a MkDocs preview server alongside a review API is to use an automated script that orchestrates both processes simultaneously. This eliminates the need to manually start and manage separate local servers during your documentation development workflow.

Can I change the default port for the local approval API when previewing docs?

Yes, you can change the default port for the local approval API. The script supports an optional REVIEW_API_PORT environment variable override, allowing you to specify a custom port instead of the default 8765 for the local review endpoint.

Does the local documentation review workflow require any external dependencies?

No external dependencies are required for the local documentation review workflow. The skill operates independently using a Python script to orchestrate the MkDocs preview and the local REST API, streamlining the development workflow without needing additional packages.

Why use a local server for MkDocs documentation review instead of a remote deployment?

Using a local server for MkDocs documentation review enables rapid iteration and allows you to view and approve pending documentation changes directly in your local environment. This approach avoids the overhead of deploying to a remote server for every documentation update.