Skills Guide

RSPress Frontmatter Configuration

VerifiedSafe

Configure YAML frontmatter in RSPress markdown/mdx files to control page metadata, layout, and special page types. Use for setting page titles, descriptions, SEO tags, toggling sidebar/outline/footer/navbar, and configuring home or overview pages. Particularly helpful when building documentation sites with hero sections or feature cards.

Download and use
Sby Skills Guide Bot
DocumentationBeginner
3/4/2026
Claude Code
#rspress#frontmatter#yaml#static-site#page-metadata

Recommended for

Claude CodeAuto documentation

Automated summary

This skill helps write and configure YAML frontmatter for RSPress documentation pages, controlling metadata, layout options, and special page types.

Strengths

  • Provides clear reference tables for metadata and layout fields
  • Includes complete copy-ready examples for home, overview, API, and blank pages
  • Covers hero and feature sections for home pages with exact syntax

Limitations

  • Covers RSPress frontmatter only, not Markdown content or site configuration
  • Documents just the listed fields, not every advanced RSPress option
  • Assumes prior familiarity with an RSPress project structure
When to use it

Use it when adding or fixing page metadata, layout, or page type in an RSPress documentation site.

When not to use it

Avoid it for configuring the global RSPress config file or for writing the body content of a Markdown page.

Security analysis

Safe
Quality score85/100

The skill only documents RSPress YAML frontmatter fields and examples. Declared tools are limited to Read, Write, Edit, and Glob, with no commands, network access, secrets handling, or destructive behavior.

No concerns found

How this analysis is made

Examples

Set up a home page
Add frontmatter to my RSPress index.mdx so it renders a home page with a hero section (name, tagline, two action buttons) and three feature cards with icons.
Hide sidebar on a page
Write the RSPress frontmatter for an API reference page titled 'API Reference' with a description, keeping the outline visible but hiding the sidebar and footer.
Create an overview page
Configure frontmatter for a Guides overview page in RSPress that lists child pages using overview headers levels 2 and 3.

name: rspress-frontmatter description: Configure RSPress frontmatter for documentation pages. Use when setting up page metadata, controlling layout options, or configuring home page hero/features sections. allowed-tools: Read, Write, Edit, Glob agent: rspress-doc-agent

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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/rspress-frontmatter-configuration-mmbizkah' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/rspress-frontmatter-configuration-mmbizkah/download' --output '.skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md.part' && mv '.skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md.part' '.skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Write, Edit, Glob

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md' && test -s '.skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/rspress-frontmatter' && cp -R '.skill-downloads/rspress-frontmatter-configuration-mmbizkah' '.claude/skills/rspress-frontmatter'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/rspress-frontmatter-configuration-mmbizkah'

openskills read 'rspress-frontmatter-configuration-mmbizkah'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot