fw-vitepress

Name: fw-vitepress
Availability: InStock
Author: xiaolai

Parse VitePress config and sidebar navigation to map source code to documentation templates.

6|Updated Feb 28, 2026

Search Tags:#templates #framework #docs #mapping #sidebar #vitepress

Ready to run

npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-vitepress

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: fw-vitepress
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/frameworks/vitepress
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-vitepress

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

VitePress is a documentation framework, and this skill provides an adapter that parses the sidebar config, detects Vue components, and generates consistent doc templates to help teams organize API references and guides within VitePress.

Core Features & Use Cases

Detects common VitePress project patterns such as .vitepress/config.ts, config.js, or config.mts.
Parses themeConfig.sidebar and themeConfig.nav to derive doc structure and navigation mappings.
Provides guidance for code-to-doc mappings and ready-to-use documentation templates for docs and API references.

Quick Start

Detect your VitePress project and generate initial docs mappings and templates.

Frequently Asked Questions about fw-vitepress

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

FAQPage Schema

How do I generate VitePress documentation templates from my source code?▼

To generate VitePress documentation templates, this adapter parses your project's navigation structures and maps source code to documentation pages. It detects typical configuration locations like .vitepress/config.ts to produce consistent API references and guides.

How does VitePress sidebar configuration parsing work for docs mapping?▼

VitePress sidebar configuration parsing works by reading themeConfig.sidebar and themeConfig.nav to derive documentation structure. The adapter uses these navigation mappings to automatically organize API references and guides within your project.

Can I use this adapter with my existing .vitepress/config.mts file?▼

You can use this adapter with an existing .vitepress/config.mts file, as it detects common VitePress project patterns including config.ts, config.js, and config.mts. It requires these typical configuration locations to map source code correctly.

What is the best way to map Vue components to VitePress documentation pages?▼

The best way to map Vue components to VitePress documentation pages is using an adapter that detects components and applies mapping rules. This approach generates consistent documentation templates and ensures your API references match your source code structure.

Why does my VitePress nav generation not match my source code structure?▼

VitePress nav generation may not match your source code if the configuration file is not located at .vitepress/config.ts or similar supported paths. Accurate mapping requires the adapter to successfully detect and parse these typical config locations.