Back to Skills

preview

verified

Documentation view expert for Docusaurus integration. Launches interactive server for SpecWeave living documentation with hot reload, auto-generated sidebar, and Mermaid diagrams. Works in ANY SpecWeave project with auto-setup. Supports both internal (port 3015) and public (port 3016) docs. Activates for preview docs, view documentation, Docusaurus server, docs UI, documentation website, local docs server, hot reload docs, static site build.

View on GitHub

Marketplace

specweave

anton-abyzov/specweave

Plugin

sw-docs

productivity

Repository

anton-abyzov/specweave
27stars

plugins/specweave-docs/skills/preview/SKILL.md

Last Verified

January 25, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/anton-abyzov/specweave/blob/main/plugins/specweave-docs/skills/preview/SKILL.md -a claude-code --skill preview

Installation paths:

Claude
.claude/skills/preview/
Powered by add-skill CLI

Instructions

# Documentation View Skill

Expert in launching and managing Docusaurus documentation server for SpecWeave projects.

## What I Do

I help you view your SpecWeave living documentation with Docusaurus:

### Key Features
- **Zero-config setup** - Works in any SpecWeave project automatically
- **Internal & Public docs** - Internal on port 3015, public on port 3016
- **Cached installation** - Docusaurus cached in `.specweave/cache/docs-site/` (gitignored)
- **Hot reload** - Edit markdown, see changes instantly
- **Mermaid diagrams** - Architecture diagrams render beautifully
- **Auto sidebar** - Generated from folder structure
- **Bypasses private registries** - Uses public npm to avoid Azure DevOps/corporate issues

## How It Works

1. **First run (~30 seconds)**:
   - Creates Docusaurus in `.specweave/cache/docs-site/` (internal) or `.specweave/cache/docs-site-public/` (public)
   - Installs dependencies from public npm registry
   - Configures to read from `.specweave/docs/internal/` or `.specweave/docs/public/`

2. **Subsequent runs (instant)**:
   - Uses cached installation
   - Starts server immediately

## Available Commands

### View Internal Documentation (Default)
```bash
/sw-docs:view
```

**What it does:**
1. Checks if `.specweave/docs/internal/` exists
2. Runs pre-flight validation (auto-fixes common issues)
3. Sets up Docusaurus in cache (if first run)
4. Starts dev server on **http://localhost:3015**
5. Enables hot reload

### View Public Documentation
```bash
/sw-docs:view --public
```

**What it does:**
1. Checks if `.specweave/docs/public/` exists
2. Runs pre-flight validation (auto-fixes common issues)
3. Sets up Docusaurus in cache (if first run)
4. Starts dev server on **http://localhost:3016**
5. Enables hot reload

### Build Static Site
```bash
/sw-docs:build
```

**What it does:**
1. Builds production-ready static site
2. Outputs to `.specweave/cache/docs-site/build/`
3. Ready for deployment to any static host

## When to Use This Skill

### Acti

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
3433 chars