rspress-frontmatter

Configure RSPress page metadata and layout options via YAML frontmatter.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Frontmatter config provides control over page metadata, layout options, and special page types, enabling consistent, theme-aware documentation.

Core Features & Use Cases

  • Core Metadata Fields: title, description, and optional titleSuffix to influence page titles and SEO.
  • Layout Flags: pageType, sidebar, outline, footer, and navbar to tailor page chrome.
  • Common Page Configs: Examples for overview, home, API reference, blank/custom layouts, and how frontmatter drives rendering.

Quick Start

Add a YAML frontmatter block at the very top of your page to configure metadata, layout, and navigation visibility.

Frequently Asked Questions about rspress-frontmatter

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

FAQPage Schema
How do I configure frontmatter metadata for RSPress documentation pages?

Frontmatter is YAML at the top of your RSPress file that controls page metadata, layout, and navigation. Add a YAML block with fields like `title`, `description`, `pageType`, and boolean flags (`sidebar`, `outline`, `footer`, `navbar`) to configure how pages render and appear in navigation.

What YAML fields does RSPress frontmatter support?

RSPress frontmatter supports core metadata fields (`title`, `description`, `titleSuffix`), layout flags (`pageType`, `sidebar`, `outline`, `footer`, `navbar`), and specialized blocks for home and overview pages. Boolean fields use lowercase values, and you can define hero and features sections for home page types.

Can I hide pages from sidebar or outline navigation in RSPress?

Yes. Use frontmatter boolean flags: set `sidebar: false` to remove a page from sidebar navigation and `outline: false` to hide its headings from the outline. Similarly, `navbar: false` and `footer: false` control header and footer visibility.

How do I set up different page layouts like home or API reference in RSPress?

Specify the `pageType` field in frontmatter to define page layout type—such as home, overview, or custom. Include corresponding configuration blocks (hero, features for home pages) in your YAML to customize the rendered layout and content sections for each page type.

Does RSPress frontmatter affect SEO and page titles?

Yes. The `title` and `description` frontmatter fields control page metadata for SEO. The optional `titleSuffix` appends text to browser titles. These fields ensure consistent, theme-aware documentation that search engines and browsers correctly represent.