Ir para o conteúdo principal
Version: 2.0.0-beta.5

Plugins

Você pode expandir as funcionalidades MDX usando plugins.

Plugins de conteúdo do Docusaurus suportam tanto o Remark como Rehype que funcionam com o MDX.

Configurando plugins#

Um plugin MDX geralmente é um pacote npm, então você os instala como outros pacotes npm usando npm.

Primeiro, instale seus plugins Remark e Rehype.

Por exemplo:

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

Em seguida, importe os plugins:

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

Finalmente, adicione-os às opções @docusaurus/preset-classic em docusaurus.config.js:

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

Configurando opções do plugin#

Alguns plugins podem ser configurados e aceitar suas próprias opções. Nesse caso, use a sintaxe [plugin, pluginOptions], assim:

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

Veja mais informações na documentação MDX.