Aller au contenu principal
Version: 2.0.0-alpha.72

📦 plugin-content-pages

Le plugin de pages par défaut pour Docusaurus. Le template classic est livré avec ce plugin avec les configurations par défaut. Ce plugin fournit la fonctionnalité de création de pages.

Installation#

npm install --save @docusaurus/plugin-content-pages
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.

Configuration#

docusaurus.config.js
module.exports = {
plugins: [
[
'@docusaurus/plugin-content-pages',
{
/**
* Chemin vers les données
* relatif au répertoire du site
* les composants dans ce répertoire seront automatiquement convertis en pages
*/
path: 'src/pages',
/**
* Chemin URL pour la section de page de votre site
* n'inclut pas de barre oblique à la fin
*/
routeBasePath: '',
include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],
/**
* Aucune route ne sera créée pour les fichiers correspondants
*/
exclude: [
'**/_*.{js,jsx,ts,tsx,md,mdx}',
'**/*.test.{js,ts}',
'**/__tests__/**',
],
/**
* Composant de thème utilisé par les pages de markdown.
*/
mdxPageComponent: '@theme/MDXPage',
/**
* Les plugins Remark et Rehype sont passés à MDX
*/
remarkPlugins: [],
rehypePlugins: [],
/**
* Les plugins personalisé Remark et Rehype sont passés à MDX
* avant ceux de Remark et Rehype par défaut de Docusaurus.
*/
beforeDefaultRemarkPlugins: [],
beforeDefaultRehypePlugins: [],
},
],
],
};

i18n#

Lisez l’introduction i18n en premier.

Emplacement des fichiers de traduction#

  • Chemin de base : website/i18n/<locale>/docusaurus-plugin-content-pages
  • Chemin d'accès multi-instance : website/i18n/<locale>/docusaurus-plugin-content-pages-<pluginId>
  • Fichiers JSON : extrait avec docusaurus write-translations
  • Fichiers Markdown : website/i18n/<locale>/docusaurus-plugin-content-pages

Exemple de structure du système de fichiers#

website/i18n/<locale>/docusaurus-plugin-content-pages
│
│ # traductions pour website/src/pages
├── first-markdown-page.md
└── second-markdown-page.md