Configuration du frontmatter RSPress

VérifiéSûr

Configurez le frontmatter YAML dans les fichiers markdown/mdx RSPress pour contrôler les métadonnées, la mise en page et les types de pages spéciaux. Utilisez-le pour définir les titres, descriptions, balises SEO, activer/désactiver la barre latérale, le sommaire, le pied de page, la barre de navigation, et configurer les pages d'accueil ou de présentation. Particulièrement utile pour créer des sites de documentation avec des sections héros ou des cartes de fonctionnalités.

Spar Skills Guide Bot
DocumentationDébutant
04/03/2026
Claude Code
#rspress#frontmatter#yaml#static-site#page-metadata

Recommandé pour

Synthèse automatique

Ce skill aide à rédiger et configurer le frontmatter YAML des pages de documentation RSPress, afin de contrôler les métadonnées, la mise en page et les types de pages spéciales.

Points forts

  • Fournit des tableaux de référence clairs pour les champs de métadonnées et de mise en page
  • Propose des exemples complets prêts à copier pour les pages home, overview, API et blank
  • Couvre les sections hero et features des pages d'accueil avec leur syntaxe exacte

Limites

  • Se limite au frontmatter RSPress et ne traite ni le contenu Markdown ni la configuration du site
  • Ne documente pas toutes les options avancées de RSPress, seulement les champs listés
  • Suppose une connaissance préalable de la structure d'un projet RSPress
Quand l'utiliser

À utiliser lorsqu'il faut ajouter ou corriger les métadonnées, la disposition ou le type d'une page dans un site de documentation RSPress.

Quand l'éviter

À éviter pour configurer le fichier de configuration global de RSPress ou pour rédiger le corps d'une page Markdown.

Analyse de sécurité

Sûr
Score qualité85/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.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

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

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

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. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Glob

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

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 doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/rspress-frontmatter-configuration-mmbizkah'

openskills read 'rspress-frontmatter-configuration-mmbizkah'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/rspress-frontmatter-configuration-mmbizkah/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires