Agent skill
rspress-frontmatter
Configure RSPress frontmatter for documentation pages. Use when setting up page metadata, controlling layout options, or configuring home page hero/features sections.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/rspress-frontmatter
SKILL.md
RSPress Frontmatter Configuration
Configure YAML frontmatter in RSPress markdown/mdx files to control page metadata, layout, and special page types.
Core Metadata Fields
| Field | Type | Description |
|---|---|---|
title |
string | Page title (overrides H1 heading) |
description |
string | Page description for SEO meta tags |
titleSuffix |
string | Custom suffix for page title |
Page Layout Control
| Field | Type | Description |
|---|---|---|
pageType |
string | Page type: doc, home, blank, custom |
sidebar |
boolean | Show/hide sidebar (default: true) |
outline |
boolean | Show/hide table of contents outline (default: true) |
footer |
boolean | Show/hide footer (default: true) |
navbar |
boolean | Show/hide navigation bar (default: true) |
Overview Page Configuration
Configure automatic overview pages that list child pages:
---
pageType: overview
overview: true
overviewHeaders:
- 2
- 3
---
Home Page Configuration
Configure hero sections and feature cards:
---
pageType: home
hero:
name: Project Name
text: Tagline text
tagline: Subtitle description
actions:
- text: Get Started
link: /guide/getting-started
theme: brand
- text: View on GitHub
link: https://github.com/user/repo
theme: alt
features:
- title: Feature One
details: Description of first feature
icon: 🚀
- title: Feature Two
details: Description of second feature
icon: ⚡
---
Common Examples
Standard documentation page:
---
title: Getting Started
description: Learn how to install and configure the project
sidebar: true
outline: true
---
Home page:
---
pageType: home
title: Welcome
navbar: true
sidebar: false
hero:
name: My Project
text: Build amazing things
tagline: Fast, flexible, and powerful
---
API reference page:
---
title: API Reference
description: Complete API documentation
outline: true
pageType: doc
---
Blank page (custom layout):
---
pageType: blank
navbar: false
sidebar: false
footer: false
---
Overview page:
---
title: Guides
pageType: overview
overview: true
---
Notes
- Frontmatter must be at the very top of the file
- All frontmatter blocks must use triple-dash (
---) delimiters - Use YAML syntax for all field values
- Boolean values should be lowercase:
true,false - The
titlefield overrides the first H1 heading in the document
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?