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:
yaml1--- 2pageType: overview 3overview: true 4overviewHeaders: 5 - 2 6 - 3 7---
Home Page Configuration
Configure hero sections and feature cards:
yaml1--- 2pageType: home 3hero: 4 name: Project Name 5 text: Tagline text 6 tagline: Subtitle description 7 actions: 8 - text: Get Started 9 link: /guide/getting-started 10 theme: brand 11 - text: View on GitHub 12 link: https://github.com/user/repo 13 theme: alt 14features: 15 - title: Feature One 16 details: Description of first feature 17 icon: 🚀 18 - title: Feature Two 19 details: Description of second feature 20 icon: ⚡ 21---
Common Examples
Standard documentation page:
yaml1--- 2title: Getting Started 3description: Learn how to install and configure the project 4sidebar: true 5outline: true 6---
Home page:
yaml1--- 2pageType: home 3title: Welcome 4navbar: true 5sidebar: false 6hero: 7 name: My Project 8 text: Build amazing things 9 tagline: Fast, flexible, and powerful 10---
API reference page:
yaml1--- 2title: API Reference 3description: Complete API documentation 4outline: true 5pageType: doc 6---
Blank page (custom layout):
yaml1--- 2pageType: blank 3navbar: false 4sidebar: false 5footer: false 6---
Overview page:
yaml1--- 2title: Guides 3pageType: overview 4overview: true 5---
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
