Aller au contenu principal
Version: 2.0.0-beta.0

Plugins

Vous pouvez étendre les fonctionnalités MDX en utilisant des plugins.

Les plugins de contenu Docusaurus supportent à la fois les plugins Remark et Rehype qui fonctionnent avec MDX.

Configuration des plugins#

Un plugin MDX est généralement un paquet npm, donc vous les installez comme les autres paquets npm en utilisant npm.

Tout d'abord, installez vos plugins Remark et Rehype.

Par exemple :

npm install --save remark-imagesnpm install --save rehype-truncate

Ensuite, importez les plugins :

const remarkImages = require('remark-images');const rehypeTruncate = require('rehype-truncate');

Enfin, ajoutez-les aux options @docusaurus/preset-classic dans docusaurus.config.js :

docusaurus.config.js
module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          sidebarPath: require.resolve('./sidebars.js'),          // ...          remarkPlugins: [remarkImages],          rehypePlugins: [rehypeTruncate],        },      },    ],  ],};

Configuration des options du plugin#

Certains plugins peuvent être configurés et recevoir leurs propres options. Dans ce cas, utilisez la syntaxe [plugin, pluginOptions] , comme suit :

docusaurus.config.js
module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          sidebarPath: require.resolve('./sidebars.js'),          // ...          remarkPlugins: [            plugin1,            [plugin2, {option1: {...}}],          ],        },      },    ],  ],};

Voir plus d'informations dans la documentation MDX.