跳到主要内容

插件

你可以利用插件来扩展 MDX 的功能。

Docusaurus 的内容插件能够与支持 MDX 的 RemarkRehype 插件一起使用。

配置插件#

MDX 插件通常是 npm 软件包,因此你可以像使用其它 npm 软件包一样利用 npm 安装它们。

首先,安装 RemarkRehype 插件。

例如:

npm install --save remark-images
npm install --save rehype-truncate

接下来,导入(import)插件:

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

最后,将它们添加到 docusaurus.config.js 配置文件中的 @docusaurus/preset-classic 配置项中:

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

配置插件的参数#

某些插件能够接受其独有的参数。在这种情况下,请使用 [plugin, pluginOptions] 语法,如下所示:

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

请参阅 MDX 文档 以了解更多信息。