How do I install the Rspress Frontmatter skill?

Run npx skillmds add majiayu000/rspress-frontmatter in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Rspress Frontmatter safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: makes network calls. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Rspress Frontmatter?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Rspress Frontmatter free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Rspress Frontmatter?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Rspress Frontmatter by majiayu000 — Agent Skill

Name: Rspress Frontmatter
Rating: 4.2 (5 reviews)
Author: majiayu000

File contents

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 title field overrides the first H1 heading in the document

---name: rspress-frontmatterdescription: Configure RSPress frontmatter for documentation pages. Use when setting up page metadata, controlling layout options, or configuring home page hero/features sections.--- # 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: ```yaml --- pageType: overview overview: true overviewHeaders: - 2 - 3 --- ``` ## Home Page Configuration Configure hero sections and feature cards: ```yaml --- 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:** ```yaml --- title: Getting Started description: Learn how to install and configure the project sidebar: true outline: true --- ``` **Home page:** ```yaml --- pageType: home title: Welcome navbar: true sidebar: false hero: name: My Project text: Build amazing things tagline: Fast, flexible, and powerful --- ``` **API reference page:** ```yaml --- title: API Reference description: Complete API documentation outline: true pageType: doc --- ``` **Blank page (custom layout):** ```yaml --- pageType: blank navbar: false sidebar: false footer: false --- ``` **Overview page:** ```yaml --- 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 `title` field overrides the first H1 heading in the document

Frequently asked questions