Aller au contenu principal
Version : 3.2.1

Liens Markdown

Il existe deux façons d'ajouter un lien vers une autre page : par un chemin d'accÚs à l'URL et par un chemin d'accÚs au fichier.

- [chemin d'accĂšs par l'URL vers un autre document](./installation)
- [chemin d'accĂšs par le fichier vers un autre document](./installation.mdx)

Les chemins aux URL ne sont pas traités par Docusaurus, et vous pouvez les considérer comme rendant directement <a href="./installation">, c'est-à-dire qu'ils seront résolus en fonction de l'emplacement de l'URL de la page, plutÎt que de son emplacement dans le systÚme de fichiers.

Si vous voulez faire rĂ©fĂ©rence Ă  un autre fichier Markdown inclus par le mĂȘme plugin, vous pourriez utiliser le chemin relatif du document vers lequel vous voulez Ă©tablir un lien. Le chargeur Markdown de Docusaurus convertira le chemin du fichier vers le chemin de l'URL du fichier cible (et supprimera donc l'extension .md).

Par exemple, si vous ĂȘtes dans docs/dossier/doc1.md et que vous voulez faire rĂ©fĂ©rence Ă  docs/dossier/doc2.md, docs/dossier/sous-dossier/doc3.md et docs/autreDossier/doc4.md :

docs/folder/doc1.md
Je fais référence à un [document](doc2.mdx).

La référence à un autre [document dans un sous-dossier](sousdossier/doc3.mdx).

Le [Document relatif](../autreDossier/doc4.mdx) fonctionne Ă©galement.

Les chemins de fichiers relatifs sont résolus dans le répertoire du fichier courant. Les chemins absolus de fichier, par contre, sont résolus par rapport à la racine de contenu, généralement docs/, blog/, ou des chemins localisés comme i18n/zh-Hans/plugin-content-docs/current.

Les chemins absolus de fichiers peuvent Ă©galement ĂȘtre relatifs au rĂ©pertoire du site. Attention toutefois, les liens qui commencent par /docs/ ou /blog/ ne sont pas mobiles, car vous devrez les mettre Ă  jour manuellement si vous crĂ©ez de nouvelles versions de documents ou si vous les localisez.

Vous pouvez Ă©crire les [liens](/autreDossier/doc4.mdx) relatif Ă  la racine du contenu (`/docs/`).

Vous pouvez également écrire les [liens](/docs/autreDossier/doc4.mdx) par rapport au répertoire du site, mais ce n'est pas recommandé.

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 et de nombreux Ă©diteurs Markdown
  • Vous pouvez personnaliser les slugs des fichiers sans avoir Ă  mettre Ă  jour tous les liens
  • Le dĂ©placement des fichiers dans les dossiers peut ĂȘtre suivi par votre Ă©diteur, et certains Ă©diteurs peuvent mettre Ă  jour automatiquement les liens du fichier
  • Un doc versionnĂ© sera liĂ© Ă  un autre doc de la mĂȘme version
  • Les liens d'URL relatifs sont trĂšs susceptibLes de se rompre si vous mettez Ă  jour la config trailingSlash
attention

Les rĂ©fĂ©rences de fichier Markdown ne fonctionnent que lorsque les fichiers source et cible sont traitĂ©s par la mĂȘme instance de plugin. Ceci est une limitation technique de notre architecture du traitement Markdown et sera corrigĂ© dans le futur. Si vous liez des fichiers entre des plugins (par exemple, un lien vers une page de doc Ă  partir d'un article du blog), vous devez utiliser des liens URL.