Aller au contenu principal
Version : 2.0.0-beta.18

Fonctionnalités Markdown des docs

Les Docs peuvent utiliser n'importe quelle fonctionnalité Markdown et ont quelques fonctionnalités de Markdown spécifiques aux docs.

Markdown frontmatter

Les docs Markdown ont leur propre API Markdown frontmatter.

Référencement d'autres documents

Si vous souhaitez faire référence à un autre fichier de document, vous pouvez utiliser le chemin d'accès relatif du document vers lequel vous souhaitez créer un lien.

Docusaurus convertira le chemin du fichier pour être le chemin de l'url du document final (et supprimera l'extension .md).

Par exemple, si vous êtes dans dossier/doc1.md et que vous voulez faire référence à dossier/doc2.md, dossier/sous-dossier/doc3.md et autreDossier/doc4.md :

Je fais référence à un [document](doc2.md).

Référence vers un autre [document dans un sous-dossier](sous-dossier/doc3.md).

Le référencement de [document relatif](../autreDossier/doc4.md) fonctionne également.
astuce

L'utilisation des chemins relatifs du fichier (avec des extensions .md) au lieu des liens URL relatifs fournit les avantages suivants :

  • les liens continueront à fonctionner sur l'interface GitHub
  • vous pouvez personnaliser les slugs du document sans avoir à mettre à jour tous les liens
  • un doc versionné sera lié à un autre doc de la même version
  • les liens relatifs sont très susceptibles de se rompre si vous mettez à jour la config trailingSlash