Chaque page est un fichier MDX, qui combine du contenu Markdown avec des composants React pour vous permettre de créer une documentation riche et interactive.
Chaque page commence par un frontmatter, des métadonnées YAML délimitées par --- au début du fichier. Ces métadonnées déterminent l’apparence et le comportement de votre page.
Utilisez les métadonnées pour contrôler :
- Les titres et descriptions des pages
- Les titres, icônes et tags de la barre latérale
Le titre de votre page qui apparaît dans la navigation et les onglets du navigateur.
Une brève description du contenu de cette page. Apparaît sous le titre et améliore le SEO.
Un titre court affiché dans la navigation de la barre latérale.
L’icône à afficher.Options :
- Nom de l’icône Font Awesome
- Nom de l’icône Lucide
- URL d’une icône hébergée en externe
- Chemin vers un fichier d’icône dans votre projet
Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.Options : regular, solid, light, thin, sharp-solid, duotone, brands. Un tag qui apparaît à côté du titre de votre page dans la barre latérale.
Exemple d’enveloppe de frontmatter YAML
mode.
Si aucun mode n’est défini, la mise en page par défaut est un agencement standard avec une navigation latérale et une table des matières.
Le mode large masque la table des matières. Il est utile pour les pages sans titres ou si vous préférez bénéficier d’un espace horizontal supplémentaire. Le mode large est disponible pour tous les thèmes.
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 toute autre mise en page spécifique nécessitant une navigation minimale. Le mode Personnalisé est disponible pour tous les thèmes.
Le mode Cadre propose une mise en page semblable au mode personnalisé, tout en conservant la navigation dans 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 Cadre est uniquement disponible avec les thèmes Aspen et Almond.
Le mode Centré supprime la barre latérale et la table des matières et centre le contenu. Il est utile pour les journaux des modifications (changelogs) 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.
Créez des terrains de jeu API interactifs en ajoutant une spécification d’API dans votre frontmatter, api ou openapi.
En savoir plus sur la création de documentation d’API.
Liez des sites externes directement depuis votre navigation à l’aide de la métadonnée url.
Optimisation pour les moteurs de recherche
Les balises méta contenant des deux-points doivent être placées entre guillemets.
Mots-clés de recherche internes
keywords à vos métadonnées. Ces mots-clés n’apparaîtront ni dans le contenu de la page ni dans les résultats de recherche, mais si un utilisateur les saisit, la page sera proposée en résultat.
