Chaque page est un fichier MDX, qui combine du contenu en Markdown avec des composants React pour vous permettre de créer une documentation riche et interactive.
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 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. S’affiche sous le titre et améliore le SEO (Search Engine Optimization).
Un titre court qui s’affiche dans la navigation de la barre latérale.
L’icône à afficher.Options : 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.
mode.
Si aucun mode n’est défini, une mise en page standard est utilisée, avec une navigation dans la barre 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 profiter de l’espace horizontal supplémentaire. Le mode large est disponible pour tous les thèmes.
Le mode personnalisé offre 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 un minimum d’éléments de navigation. Le mode personnalisé est disponible pour tous les thèmes.
Le mode Frame propose une mise en page similaire au mode personnalisé, tout en conservant la navigation de la barre latérale. Ce mode de page permet d’utiliser du HTML personnalisé et des composants tout en préservant l’expérience de navigation par défaut. Le mode Frame est uniquement disponible avec les thèmes Aspen et Almond.
Le mode Centrage 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 Centrage est disponible pour les thèmes Mint et Linden.
Créez des bacs à sable d’API interactifs en ajoutant une spécification d’API à votre frontmatter, api ou openapi.
En savoir plus sur la création de documentation d’API.
Créez des liens vers des sites externes directement depuis votre navigation à l’aide de la metadata url.
Optimisation pour les moteurs de recherche
Les balises meta contenant des deux-points doivent être entourées de guillemets.
Mots-clés de recherche internes
keywords dans votre 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.
