rspress-components

Enforce correct usage of RSPress built-in components in MDX documentation pages.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Static documentation can be hard to skim and understand. This Skill shows you how to enrich pages with RSPress built-in components and MDX features, making docs more navigable and engaging.

Core Features & Use Cases

  • MDX Component Library: Import built-in components from rspress/theme for reuse across pages.
  • Common Components: Use Badge, Tabs, and Steps to convey status, organize content, and guide readers.
  • Code Block & MDX Features: Leverage syntax highlighting, inline components, and MDX mixing of Markdown and JSX.
  • Best Practices: Use components sparingly to minimize bundle size and keep pages readable.

Quick Start

Import the components into an MDX page and render examples, for instance:

  • import { Badge, Tabs, Tab } from 'rspress/theme';
  • Use <Badge type="info" text="Info" /> in your content.

Frequently Asked Questions about rspress-components

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

FAQPage Schema
How do I add interactive components like Tabs and Badge to RSPress documentation?

Import built-in components from `rspress/theme` into your MDX pages. Components like Badge, Tabs, Steps, and PackageManagerTabs are available ready-to-use; import selectively and render them inline with your Markdown content to add interactivity without extra dependencies.

What's the best way to organize content in RSPress docs using MDX components?

Use Tabs to group related sections, Steps for sequential workflows, and Badge for status indicators. RSPress components integrate directly with MDX syntax, letting you mix Markdown and JSX to create structured, scannable documentation while keeping bundle size minimal through selective imports.

Can I use code blocks with syntax highlighting and tabs in RSPress documentation?

Yes. RSPress supports code groups in tabbed and callout sections with language annotations for syntax highlighting. Combine code blocks with MDX composition rules to display multi-language examples or alternative implementations in organized, interactive tabs within your docs.

When should I use NoSSR components in RSPress MDX documentation?

Use NoSSR when components require browser APIs unavailable during server-side rendering. RSPress enforces SSR safeguards to prevent runtime errors; wrap client-only interactive elements in NoSSR to defer rendering to the client and maintain static site performance.

What are the limits of RSPress built-in components for documentation workflows?

RSPress components are optimized for documentation tasks like tabbed content, steps, and code examples. They prioritize bundle efficiency and readability; avoid overusing components on a single page as excessive interactivity can degrade navigation clarity and increase cognitive load for readers.