rspress-components

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.