Version: 2.0.0-alpha.72
📦 plugin-content-docs
Fournit la fonctionnalité Docs et c'est le plugin docs par défaut pour Docusaurus.
#
Installation- npm
- Yarn
astuce
Si vous avez installé @docusaurus/preset-classic
, vous n'avez pas besoin de l'installer en tant que dépendance. Vous pouvez également le configurer via les options du preset classic au lieu de le faire comme ci-dessous.
#
Configurationdocusaurus.config.js
#
Markdown FrontmatterLes documents Markdown peuvent utiliser les champs de métadonnées markdown frontmatter suivants, entourés par une ligne ---
de chaque côté :
id
 : Un id de document unique. Si ce champ n'est pas présent, l'id
du document par défaut est son nom de fichier (sans l'extension)title
 : Le titre de votre document. Si ce champ n'est pas présent, letitle
du document sera par défaut celui de sonid
hide_title
 : S'il faut cacher le titre en haut du doc. Par défaut, c'estfalse
hide_table_of_content
 : S'il faut cacher la table des matières à droite. Par défaut, c'estfalse
sidebar_label
 : Le texte affiché dans la barre latérale du document et dans le bouton suivant/précédent pour ce document. Si ce champ n'est pas présent, lesidebar_label
du document sera par défaut celui de sontitle
custom_edit_url
 : L'URL pour modifer le document. Si ce champ n'est pas présent, l'URL de modification du document sera renvoyée verseditUrl
à partir des champs d'options passés Ãdocusaurus-plugin-content-docs
keywords
: Tag méta des mots clés pour la page du document, pour les moteurs de recherchedescription
: La description de votre document qui sera fournit dans<meta name="description" content="..."/>
et<meta property="og:description" content="..."/>
du<head>
, utilisé par les moteurs de recherche. Si ce champ n'est pas présent, il reprendra par défaut la première ligne du contenuimage
 : Image de couverture ou vignette qui sera utilisée lors de l'affichage du lien vers votre articleslug
 : Permet de personnaliser l'url du document
Exemple :
#
i18nLisez l’introduction i18n en premier.
#
Emplacement des fichiers de traduction- Chemin de base :
website/i18n/<locale>/docusaurus-plugin-content-docs
- Chemin d'accès multi-instance :
website/i18n/<locale>/docusaurus-plugin-content-docs-<pluginId>
- Fichiers JSONÂ : extrait avec
docusaurus write-translations
- Fichiers Markdown :
website/i18n/<locale>/docusaurus-plugin-content-docs/<version>