rspress-page

Scaffold RSPress documentation pages with standardized frontmatter and directory layouts.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/savvy-web/developer-docs --skill rspress-page
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rspress-page
Source: https://github.com/savvy-web/developer-docs/tree/main/.claude/skills/rspress-page
Command: npx skills add https://github.com/savvy-web/developer-docs --skill rspress-page

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating new documentation pages from scratch can be repetitive and error-prone. This Skill scaffolds pages with consistent structure and templates.

Core Features & Use Cases

  • Page Type Scaffolding: Supports Package Overview, Guides, API Reference, and GitHub Actions pages.
  • Directory Structure Guidance: Demonstrates recommended layouts under docs/src/en/ for guides, packages, actions, and API references.
  • Checklist & Best Practices: Provides a creation checklist and Markdown/MDX guidance to ensure consistency.

Quick Start

Create a new page by following the suggested directory layout under docs/src/en/packages/@savvy-web/{package}/api/ or docs/src/en/guide/, including required frontmatter and a single H1 heading.

Frequently Asked Questions about rspress-page

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

FAQPage Schema
How do I create consistent documentation pages in RSPress?

Scaffold new RSPress documentation pages using standardized templates and directory structures under docs/src/en/. The Skill provides templates for Package Overviews, Guides, API References, and GitHub Actions pages with required frontmatter, H1 headings, and markdown validation to enforce consistency across your docs.

What's the recommended directory structure for RSPress docs?

Organize RSPress documentation under docs/src/en/ with subdirectories for guides, packages, actions, and API references. The Skill guides placement—for example, package APIs go in docs/src/en/packages/@savvy-web/{package}/api/—ensuring a predictable layout that scales as your documentation grows.

How do I enforce markdown consistency in RSPress documentation?

Apply lint validation using pnpm lint:md to enforce standardized frontmatter, code blocks with language identifiers, and proper markdown formatting. This Skill includes a creation checklist and best practices to catch issues during page authoring, not after publication.

Can I use this Skill for different types of documentation pages?

Yes. The Skill supports scaffolding Package Overviews, Guides, API References, and GitHub Actions pages. Each page type gets its own template structure, so you can quickly create the right format for installation guides, configuration docs, usage examples, or action documentation.

What frontmatter and structure do RSPress pages require?

RSPress pages require standardized frontmatter and a single H1 heading as the entry point. The Skill provides templates that enforce this structure along with guidance for code blocks with language identifiers, ensuring your pages meet linting requirements and maintain visual consistency.