Aller au contenu principal
Version: 2.0.0-beta.10 🚧

Introduction de la documentation

La fonction de documentation fournit aux utilisateurs un moyen d'organiser les fichiers Markdown dans un format hiérarchique.

info

Consultez la documentation de référence de l'API du plugin des docs pour une liste exhaustive d'options.

ID du document

Chaque document a un id unique. Par défaut, l'id d'un document est le nom du document (sans l'extension) relatif au répertoire racine de la documentation.

Par exemple, greeting.md a pour id greeting et guide/hello.md a pour id guide/hello.

website # Répertoire racine de votre site
└── docs
   ├── greeting.md
└── guide
└── hello.md

Cependant, la dernière partie de l'id peut être définie par l'utilisateur dans la partie supérieure. Par exemple, si le contenu de guide/hello.md est défini comme ci-dessous, son id final est guide/part1.

---
id: part1
---
Lorem ipsum

Si vous voulez plus de contrôle sur la dernière partie de l'URL du document, il est possible d'ajouter un slug (par défaut l'id).

---
id: part1
slug: part1.html
---
Lorem ipsum
remarque

Il est possible d'utiliser :

  • des slugs absolus : slug: /mySlug, slug: /...
  • des slugs relatifs : slug: mySlug, slug: ./../mySlug...

Docs de la page d'accueil

Si vous voulez qu'un document soit disponible à la racine, et que vous avez un chemin comme https://docusaurus.io/docs/, vous pouvez utiliser le slug du frontmatter :

---
id: my-home-doc
slug: /
---
Lorem ipsum

Mode Docs-uniquement

Si vous ne voulez que la fonction de documentation, vous pouvez faire fonctionner votre site Docusaurus 2 sans page de démarrage et afficher votre page de documentation comme page d'index à la place.

Pour activer le mode Docs-uniquement, définissez le plugin docs routeBasePath: '/', et utilisezslug : / du frontmatter sur le document qui doit être la page d'index (plus d'infos).

caution

Vous devez supprimer la page d'accueil existante ./src/pages/index.js, sinon il y aura deux fichiers qui correspondront à la même route !

tip

Il y a aussi un « mode blog-uniquement » pour ceux qui ne veulent utiliser que la fonction blog de Docusaurus 2. Vous pouvez utiliser la même méthode décrite ci-dessus. Suivez les instructions de configuration sur le mode Blog-only.