Passer au contenu principal
Chaque page est un fichier Markdown. Vous pouvez utiliser les types de fichiers .mdx ou .md pour vos pages. Nous recommandons d’utiliser MDX, qui combine Markdown avec des composants React pour créer une documentation riche et interactive. Le Markdown simple (.md) peut accélérer la migration depuis d’autres plateformes, mais passer à MDX permet de bénéficier de davantage de fonctionnalités.

​
Métadonnées de page

Chaque page commence par du frontmatter, les métadonnées YAML délimitées par --- en haut d’un fichier. Ces métadonnées contrôlent 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
requis
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. S’affiche 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
Uniquement pour les icônes Font Awesome. Le style de l’icône.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.
​
hidden
boolean
Définir sur true pour retirer la page de la navigation de la barre latérale. Les utilisateurs peuvent toujours accéder à la page via son URL, mais les moteurs de recherche ne l’indexent pas. Voir Pages masquées pour plus de détails.
​
noindex
boolean
Définir sur true pour empêcher les moteurs de recherche d’indexer la page. Voir Désactiver l’indexation pour plus de détails. Toutes les pages avec hidden: true dans leur frontmatter reçoivent automatiquement noindex: true.
​
<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 la mise en page de votre page avec le paramètre mode.

​
Par défaut

Si vous ne définissez aucun mode, la page utilise une mise en page standard 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. Utilisez ce mode pour les pages sans titres ou si vous souhaitez disposer d’un espace horizontal supplémentaire. Tous les thèmes prennent en charge le mode large. 
---
title: "Titre de page large"
mode: "wide"
---

​
Personnalisé

Le mode personnalisé offre une mise en page minimaliste et supprime tous les éléments à l’exception de la barre de navigation supérieure. Considérez le mode personnalisé comme une toile vierge pour créer des pages de destination (landing pages) ou des mises en page uniques avec une navigation réduite au minimum. Tous les thèmes prennent en charge le mode personnalisé. 
---
title: "Titre de page personnalisé"
mode: "custom"
---
La propriété style dans les pages en mode personnalisé peut provoquer un décalage de la mise en page lors du chargement de la page. Privilégiez Tailwind CSS ou un CSS personnalisé pour éviter ce problème.

​
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. Utilisez le mode Centré pour le journal des modifications ou d’autres pages où vous souhaitez mettre l’accent sur le contenu. Les thèmes Mint et Linden prennent en charge le mode Centré. 
---
title: "Titre de page centré"
mode: "center"
---

​
Pages d’API

Pour créer un bac à sable d’API interactif, ajoutez une spécification d’API dans votre frontmatter en définissant api ou openapi. 
---
openapi: "GET /endpoint"
---
En savoir plus sur la création de la 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

Mintlify génère automatiquement la plupart des balises meta SEO. Vous pouvez définir manuellement des balises meta SEO pour personnaliser votre approche du SEO, le partage sur les réseaux sociaux et la compatibilité des navigateurs.
Encadrez toujours de guillemets les balises meta contenant des deux-points.
---
"twitter:image": "/images/social-preview.jpg"
---
Consultez SEO pour la liste complète des options de metadata SEO.

​
Mots-clés de recherche internes

Aidez les utilisateurs à découvrir une page spécifique dans les résultats de recherche en ajoutant keywords dans vos metadata. Ces mots-clés n’apparaissent pas dans le contenu de la page. Si des utilisateurs recherchent ces mots-clés, la page s’affiche dans les résultats de recherche. 
---
keywords: ['configuration', 'installation', 'premiers pas']
---

​
Horodatage de la dernière modification

Affichez la mention « Dernière modification le [date] » sur toutes les pages en activant metadata.timestamp dans vos paramètres globaux.
docs.json
"metadata": {
  "timestamp": true
}
Pour remplacer le paramètre global d’horodatage pour une page individuelle, utilisez le champ de frontmatter timestamp. Utilisez ce champ pour afficher ou masquer les horodatages sur des pages spécifiques. 
---
title: "Titre de la page"
timestamp: false
---
Si vous définissez timestamp: true, la page affiche toujours l’horodatage même si le paramètre global est false. Si vous définissez timestamp: false, la page masque l’horodatage même si le paramètre global est true.