Frontmatter

Chaque fichier MDX commence par un bloc YAML délimité par des marqueurs ---. Ces métadonnées contrôlent le titre de votre page, l'apparence de la barre latérale, ainsi que l'aspect de la page lorsqu'elle est partagée sur les réseaux sociaux ou dans les résultats de recherche.

Frontmatter de base

Chaque page nécessite au moins un titre :

---
title: Getting Started
description: Learn the basics in 5 minutes
---

Champs disponibles

Requis

Recommandé

Facultatif

Date de dernière mise à jour

Lorsque metadata.timestamp est activé dans docs.json, chaque page affiche la date du dernier commit qui a modifié son fichier. lastUpdatedDate remplace cette date sur une page donnée :

---
title: Authentication
lastUpdatedDate: "2026-09-01"
---

Utilisez ce champ lorsque vous avez révisé une page et souhaitez l'indiquer, ou lorsqu'un commit de mise en forme a modifié la date sans rien changer que le lecteur remarquerait.

Mettez la valeur entre guillemets. Un 2026-09-01 non entouré de guillemets est interprété comme un timestamp plutôt qu'une date et peut afficher un jour décalé. Une valeur qui n'est pas une date est ignorée et la date du commit s'affiche à la place, si bien qu'une faute de frappe ne vide jamais la ligne.

Cette substitution définit également dateModified dans les données structurées de la page, afin que les moteurs de recherche et les assistants IA voient la même date que vos lecteurs.

SEO et réseaux sociaux

Contrôlez l'apparence de la page dans les résultats de recherche et les aperçus sociaux. Définissez ces champs comme des clés de premier niveau, ou dans un bloc imbriqué seo:. Les deux fonctionnent, et les valeurs propres à chaque page l'emportent sur les valeurs par défaut seo.metatags de votre docs.json.

---
title: API Reference
description: REST endpoints and authentication
"og:image": /images/api-card.png
"twitter:card": summary_large_image
canonical: https://docs.acme.com/api-reference
---

Consultez Optimisation SEO pour la liste complète des balises prises en charge et des exemples.

Exemples

Page de documentation standard

---
title: Authentication
description: Secure your API with OAuth 2.0 and API keys
icon: lock
---

Titre long avec substitution de barre latérale

---
title: Configuring Single Sign-On with SAML 2.0
sidebarTitle: SSO Setup
description: Set up enterprise SSO for your organization
---

Le titre complet apparaît sur la page, tandis que le sidebarTitle, plus court, garde la navigation lisible.

Mise en page large

---
title: API Reference
description: Complete API documentation
mode: wide
---

Le mode large supprime la table des matières et étend le contenu sur toute la largeur. Utile pour les pages de référence API ou le contenu comportant des tableaux larges.

Masquer le pied de page

---
title: Custom Landing
description: A focused landing page experience
hideFooter: true
---

Utilisez hideFooter pour les pages d'atterrissage, les pages de changelog, ou toute page où vous souhaitez un bas de page plus épuré, sans liens sociaux.

Bonnes pratiques SEO

# Good - clear and keyword-rich
title: Deploy to Production

# Avoid - vague or too long
title: How to Deploy Your Application to Production Servers

# Good - actionable and specific
description: Deploy your docs to production in under 2 minutes with zero configuration

# Avoid - generic or missing
description: Documentation page

Validation

Jamdesk valide le frontmatter lors du build. Erreurs courantes :

Error: Page "api/auth.mdx" is missing required field: title

Error: Invalid frontmatter in "guide.mdx": unexpected token

Et ensuite ?