Passer au contenu principal
Chaque page est un fichier Markdown. Les types de fichiers .mdx et .md sont tous deux pris en charge. Nous recommandons d’utiliser MDX, qui combine Markdown avec des composants React pour créer une documentation riche et interactive. Le Markdown simple (.md) est pris en charge pour faciliter la migration depuis d’autres plateformes, mais il doit être mis à jour vers MDX pour bénéficier de toutes les fonctionnalités.

​
Métadonnées de page

Chaque page commence par du frontmatter, les métadonnées YAML délimitées par --- au début d’un fichier. Ces métadonnées définissent l’apparence et le comportement de votre page. Utilisez le frontmatter pour contrôler :
  • Titres et descriptions de page
  • Titres, icônes et tags de la barre latérale
  • Mises en page des pages
  • Balises méta SEO
  • Métadonnées personnalisées
​
title
string
required
Le titre de votre page qui apparaît dans la navigation et les onglets du navigateur.
​
description
string
Une brève description du contenu de cette page. Apparaît sous le titre et améliore le SEO.
​
sidebarTitle
string
Un titre court affiché dans la navigation de la barre latérale.
​
icon
string
L’icône à afficher.Options :
​
iconType
string
Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.Options : regular, solid, light, thin, sharp-solid, duotone, brands.
​
tag
string
Un tag qui apparaît à côté du titre de votre page dans la barre latérale.
​
<custom>
string
Tout frontmatter YAML valide. Par exemple, product: "API" ou version: "1.0.0".
Example YAML frontmatter
---
title: "À propos du frontmatter"
description: "Le frontmatter correspond aux métadonnées qui contrôlent l'apparence et le comportement de votre page"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NOUVEAU"
---

​
Mode de page

Contrôlez l’affichage de votre page avec le paramètre mode.

​
Par défaut

Si aucun mode n’est défini, une mise en page standard s’applique avec une navigation dans la barre latérale et une table des matières. 
---
title: "Titre de page par défaut"
---

​
Large

Le mode large masque la table des matières. C’est utile pour les pages sans titres ou si vous préférez profiter de l’espace horizontal supplémentaire. Le mode large est disponible pour tous les thèmes. 
---
title: "Titre de page large"
mode: "wide"
---

​
Personnalisé

Le mode personnalisé propose une mise en page minimaliste qui supprime tous les éléments à l’exception de la barre de navigation supérieure. C’est une toile vierge pour créer des pages d’accueil ou tout autre agencement unique nécessitant des éléments de navigation réduits au minimum. Le mode personnalisé est disponible avec tous les thèmes. 
---
title: "Titre de page personnalisé"
mode: "custom"
---

​
Frame

Le mode Frame propose une mise en page proche du mode personnalisé, tout en conservant la navigation de la barre latérale. Ce mode de page permet d’utiliser du HTML et des composants personnalisés tout en préservant l’expérience de navigation par défaut. Le mode Frame n’est disponible que pour les thèmes Aspen et Almond. 
---
title: "Titre de la page Frame"
mode: "frame"
---

​
Centré

Le mode Centré supprime la barre latérale et la table des matières, et centre le contenu. Il est utile pour le journal des modifications ou d’autres pages où vous souhaitez mettre l’accent sur le contenu. Le mode Centré est disponible pour les thèmes Mint et Linden. 
---
title: "Titre de page centré"
mode: "center"
---

​
Pages d’API

Créez des bacs à sable d’API interactifs en ajoutant une spécification d’API dans votre frontmatter, via api ou openapi. 
---
openapi: "GET /endpoint"
---
En savoir plus sur la création de documentation d’API. Liez des sites externes directement depuis votre navigation avec la metadata url. 
---
title: "Package npm"
url: "https://www.npmjs.com/package/mint"
---

​
Optimisation pour les moteurs de recherche

La plupart des balises meta SEO sont générées automatiquement. Vous pouvez définir manuellement des balises meta SEO pour améliorer le SEO de votre site, le partage sur les réseaux sociaux et la compatibilité des navigateurs.
Les balises meta contenant des deux-points doivent être encadrées de guillemets.
---
"twitter:image": "/images/social-preview.jpg"
---
Consultez SEO pour la liste complète des options de metadata SEO.

​
Mots-clés de recherche internes

Améliorez la découvrabilité d’une page spécifique dans la recherche intégrée en ajoutant keywords dans vos metadata. Ces mots-clés n’apparaîtront ni dans le contenu de la page ni dans les résultats de recherche, mais les utilisateurs qui les saisiront verront la page s’afficher parmi les résultats. 
---
keywords: ['configuration', 'installation', 'premiers pas']
---