rspress-guide

Generate MDX pages and navigation metadata for RSPress documentation sites with Twoslash code blocks.

Updated Jan 20, 2026
One-click install
npx skills add https://github.com/spencerbeggs/claude-design-coordinator --skill rspress-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rspress-guide
Source: https://github.com/spencerbeggs/claude-design-coordinator/tree/main/.claude/skills/rspress-guide
Command: npx skills add https://github.com/spencerbeggs/claude-design-coordinator --skill rspress-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of structured, progressive learning guides for RSPress documentation sites, enabling teams to generate concept pages, how-to guides, and examples with Twoslash code blocks.

Core Features & Use Cases

  • Template-based page generation for concept, guide, and example pages
  • Twoslash code blocks with realistic, compilable examples
  • Cross-links to API documentation and automated navigation metadata updates
  • Progressive disclosure patterns and linked content across concepts, guides, and examples

Quick Start

Invoke the rspress-guide command with a type and topic to generate a page for a given concept, guide, or example.

Frequently Asked Questions about rspress-guide

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

FAQPage Schema
How do I generate progressive learning guides for RSPress documentation?▼

Twoslash code blocks in RSPress documentation provide realistic, compilable code examples that enhance progressive learning guides by enabling inline type checking and accurate syntax highlighting within MDX pages.

How do I update navigation metadata across RSPress documentation modules?▼

Update navigation metadata across RSPress modules by relying on design.config.json for module resolution and rspress.config.ts to determine dependencies, which automatically adjusts cross-references and navigational structure when generating new pages.

What do I need to set up before generating RSPress documentation pages?▼

Before generating RSPress documentation pages, you need design.config.json for module resolution, design templates in .claude/templates, and rspress.config.ts to determine dependencies, ensuring structured MDX output and accurate cross-links to API docs.

What is the best way to structure RSPress documentation with concept, guide, and example pages?▼

The best way to structure RSPress documentation is through progressive disclosure patterns that link concept pages, how-to guides, and examples together, using template-driven MDX generation to maintain cross-references to API documentation across module sections.

Does RSPress guide generation support cross-references to existing API documentation?▼

RSPress guide generation supports cross-references to API documentation by reading rspress.config.ts dependencies and design.config.json module resolution, automatically linking generated MDX concept and example pages to relevant API docs.