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

📦 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 utilisez le preset @docusaurus/preset-classic, vous n'avez pas besoin d'installer ce plugin en tant que dépendance.

Vous pouvez configurer ce plugin via les options du preset.

Configuration#

Champs acceptés :

NomTypePar défautDescription
pathstring'src/pages'Chemin vers les données sur le système de fichiers par rapport au répertoire du site. Les composants de ce répertoire seront automatiquement convertis en pages.
routeBasePathstring'/'Route URL pour la section des pages de votre site. NE PAS inclure un slash de fin.
includestring[]['**/*.{js,jsx,ts,tsx,md,mdx}']Les fichiers correspondants seront inclus et traités.
excludestring[]Voir l'exemple de configurationAucune route ne sera créée pour les fichiers correspondants.
mdxPageComponentstring'@theme/MDXPage'Composant utilisé par chaque page MDX.
remarkPlugins[]any[]Plugins Remark passés à MDX.
rehypePlugins[]any[]Plugins Rehype passés à MDX.
beforeDefaultRemarkPluginsany[][]Les plugins Remark personnalisés sont transmis à MDX avant les plugins Remark par défaut de Docusaurus.
beforeDefaultRehypePluginsany[][]Les plugins Rehype personnalisés sont transmis à MDX avant les plugins Rehype par défaut de Docusaurus.

Exemple de configuration#

Voici un exemple d'objet de configuration.

Vous pouvez le fournir en tant qu'options du preset ou options du plugin.

astuce

La plupart des utilisateurs de Docusaurus configurent ce plugin via les options du preset.

const config = {  path: 'src/pages',  routeBasePath: '',  include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],  exclude: [    '**/_*.{js,jsx,ts,tsx,md,mdx}',    '**/_*/**',    '**/*.test.{js,jsx,ts,tsx}',    '**/__tests__/**',  ],  mdxPageComponent: '@theme/MDXPage',  remarkPlugins: [require('remark-math')],  rehypePlugins: [],  beforeDefaultRemarkPlugins: [],  beforeDefaultRehypePlugins: [],};

Options du preset#

Si vous utilisez un preset, configurez ce plugin à travers les options du preset :

docusaurus.config.js
module.exports = {  presets: [    [      '@docusaurus/preset-classic',      {        pages: {          path: 'src/pages',          // ... configuration object here        },      },    ],  ],};

Options du plugin#

Si vous utilisez un plugin autonome, fournissez des options directement au plugin :

docusaurus.config.js
module.exports = {  plugins: [    [      '@docusaurus/plugin-content-pages',      {        path: 'src/pages',        // ... configuration object here      },    ],  ],};

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