Aller au contenu principal

Glossaire Docusaurus

Ce glossaire regroupe les principaux termes utilisés dans les guides de cette section.

Fil d'Ariane affiché en haut d'une page de doc. Il aide a situer la page dans l'arborescence et inclut ici le lien List docs.

Doc ID​

Identifiant interne utilise par Docusaurus pour relier un fichier de documentation a la sidebar et a la navigation. Il correspond au chemin relatif sous docs/, sans extension .md, et sans prefixe numerique.

Exemple : docs/docusaurus/05_gerer_erreurs.md devient docusaurus/gerer_erreurs.

DocPaginator​

Composant Docusaurus qui affiche les liens de pagination Prev/Next en bas des pages de doc.

Docs​

Section documentaire servie ici sous /docs. Elle est geree par le preset classique Docusaurus configure dans docusaurus.config.js.

Pied de page global du site. Il est configure dans themeConfig.footer.

Frontmatter​

Bloc YAML place au debut d'un fichier Markdown entre deux lignes ---. Il sert a definir des metadonnees comme title, slug ou sidebar_label.

Header / Navbar​

Barre de navigation horizontale en haut du site. Elle est configuree dans themeConfig.navbar.

List docs​

Lien de retour vers l'index principal des documentations, accessible via /docs.

Markdown​

Format texte simple utilise pour rediger les pages .md avec titres, listes, tableaux, liens et blocs de code.

MDX​

Extension de Markdown qui permet d'inserer des composants JSX interactifs dans une page de documentation.

routeBasePath​

Option de configuration qui definit la racine des docs dans l'URL. Dans ce projet, elle vaut docs.

Menu lateral gauche des documentations. Dans ce projet, son ordre et sa structure sont definis manuellement dans sidebars.js.

Texte affiche dans la sidebar pour une page ou une categorie. Il peut etre defini dans sidebars.js ou via le frontmatter selon le cas.

Slug​

Partie lisible de l'URL d'une page. Docusaurus peut le deduire automatiquement du fichier ou le personnaliser via le frontmatter.

TOC​

Table of Contents, ou sommaire de droite. Il est genere a partir des titres de niveau 2 et plus presents dans la page.

Lien interne ou externe qui pointe vers une cible invalide. Docusaurus peut les detecter au build.

Retour : Vue d'ensemble du guide Docusaurus