Version: 3.0.1

使用插件

Docusaurus 核心本身不提供任何功能。 所有功能都委托给各个插件：由 docs 插件提供的 docs 功能；由 blog 插件提供的 blog 功能；或由 pages 插件提供的 pages 功能。如果没有安装任何插件，站点将不包含任何路由。

您可能不需要逐一安装常用插件：它们可以作为捆绑包在预设中分发。对于大多数用户来说，插件是通过预设配置进行配置的。

我们维护了一个官方插件列表，但社区也创建了一些非官方插件。如果你想添加任何功能：自动生成文档页面、执行自定义脚本、集成其他服务... 一定要查看列表：可能已经有人为你实现了！

如果你感到精力充沛，你也可以阅读插件指南或插件方法参考，了解如何自己制作一个插件。

安装插件

插件通常是一个 npm 包，因此你可以像使用 npm 安装其他 npm 包一样安装它们。

npm
Yarn
pnpm

npm install --save docusaurus-plugin-name

yarn add docusaurus-plugin-name

pnpm add docusaurus-plugin-name

然后你可以在你网站的docusaurus.config.js的plugins选项中添加它：

docusaurus.config.js
export default {
  // ...
  plugins: ['@docusaurus/plugin-content-pages'],
};

Docusaurus 也可以从您的本地目录加载插件，如下所示：

docusaurus.config.js
export default {
  // ...
  plugins: ['./src/plugins/docusaurus-local-plugin'],
};

路径应为绝对路径或相对于配置文件的路径。

配置插件

对于插件的最基本用法，您可以仅提供插件名称或插件的路径。

然而，插件可以通过在配置中将名称和选项对象包装在一个双成员元组中来指定选项。这种风格通常被称为“Babel风格”。

docusaurus.config.js
export default {
  // ...
  plugins: [
    [
      '@docusaurus/plugin-xxx',
      {
        /* options */
      },
    ],
  ],
};

示例：

docusaurus.config.js
export default {
  plugins: [
    // Basic usage.
    '@docusaurus/plugin-debug',

    // With options object (babel style)
    [
      '@docusaurus/plugin-sitemap',
      {
        changefreq: 'weekly',
      },
    ],
  ],
};

多实例插件和插件ID

所有Docusaurus内容插件都可以支持多个插件实例。例如，拥有多个文档插件实例或多个博客可能很有用。需要为每个插件实例分配一个唯一的ID，默认情况下，插件ID是default。

docusaurus.config.js
export default {
  plugins: [
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'docs-1',
        // other options
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'docs-2',
        // other options
      },
    ],
  ],
};

note

最多只能有一个插件实例作为“默认插件实例”，通过省略id属性，或使用id: 'default'。

使用主题

主题的加载方式与插件完全相同。从用户的角度来看，在安装和配置插件时，themes 和 plugins 条目是可以互换的。唯一的细微差别是主题在插件之后加载，并且主题可以覆盖插件的默认主题组件。

tip

themes 和 plugins 选项会导致不同的简写解析，因此如果你想利用简写，请确保使用正确的入口！

docusaurus.config.js
export default {
  // ...
  themes: ['@docusaurus/theme-classic', '@docusaurus/theme-live-codeblock'],
};

使用预设

预设是插件和主题的集合。例如，与其让你在配置文件中逐一注册和配置@docusaurus/plugin-content-docs、@docusaurus/plugin-content-blog等，我们有@docusaurus/preset-classic预设，允许你在一个集中的地方配置它们。

`@docusaurus/preset-classic`

经典的预设默认包含在使用create-docusaurus创建的新Docusaurus网站中。它包含以下主题和插件：

经典预设会将每个选项条目传递给相应的插件/主题。

docusaurus.config.js
export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        // Debug defaults to true in dev, false in prod
        debug: undefined,
        // Will be passed to @docusaurus/theme-classic.
        theme: {
          customCss: ['./src/css/custom.css'],
        },
        // Will be passed to @docusaurus/plugin-content-docs (false to disable)
        docs: {},
        // Will be passed to @docusaurus/plugin-content-blog (false to disable)
        blog: {},
        // Will be passed to @docusaurus/plugin-content-pages (false to disable)
        pages: {},
        // Will be passed to @docusaurus/plugin-sitemap (false to disable)
        sitemap: {},
        // Will be passed to @docusaurus/plugin-google-gtag (only enabled when explicitly specified)
        gtag: {},
        // Will be passed to @docusaurus/plugin-google-tag-manager (only enabled when explicitly specified)
        googleTagManager: {},
        // DEPRECATED: Will be passed to @docusaurus/plugin-google-analytics (only enabled when explicitly specified)
        googleAnalytics: {},
      },
    ],
  ],
};

安装预设

预设通常是一个 npm 包，因此你可以像使用 npm 安装其他 npm 包一样安装它们。

npm
Yarn
pnpm

npm install --save @docusaurus/preset-classic

yarn add @docusaurus/preset-classic

pnpm add @docusaurus/preset-classic

然后，将其添加到您网站的docusaurus.config.js的presets选项中：

docusaurus.config.js
export default {
  // ...
  presets: ['@docusaurus/preset-classic'],
};

预设路径可以相对于配置文件：

docusaurus.config.js
export default {
  // ...
  presets: ['./src/presets/docusaurus-local-preset'],
};

创建预设

预设是一个与插件构造函数具有相同形状的函数。它应该返回一个{ plugins: PluginConfig[], themes: PluginConfig[] }的对象，与它们在站点配置中的接受方式相同。例如，您可以指定一个包含以下主题和插件的预设：

src/presets/docusaurus-preset-multi-docs.js
export default function preset(context, opts = {}) {
  return {
    themes: [['docusaurus-theme-awesome', opts.theme]],
    plugins: [
      // Using three docs plugins at the same time!
      // Assigning a unique ID for each without asking the user to do it
      ['@docusaurus/plugin-content-docs', {...opts.docs1, id: 'docs1'}],
      ['@docusaurus/plugin-content-docs', {...opts.docs2, id: 'docs2'}],
      ['@docusaurus/plugin-content-docs', {...opts.docs3, id: 'docs3'}],
    ],
  };
}

然后在你的 Docusaurus 配置中，你可以配置预设：

docusaurus.config.js
export default {
  presets: [
    [
      './src/presets/docusaurus-preset-multi-docs.js',
      {
        theme: {hello: 'world'},
        docs1: {path: '/docs'},
        docs2: {path: '/community'},
        docs3: {path: '/api'},
      },
    ],
  ],
};

这相当于做：

docusaurus.config.js
export default {
  themes: [['docusaurus-theme-awesome', {hello: 'world'}]],
  plugins: [
    ['@docusaurus/plugin-content-docs', {id: 'docs1', path: '/docs'}],
    ['@docusaurus/plugin-content-docs', {id: 'docs2', path: '/community'}],
    ['@docusaurus/plugin-content-docs', {id: 'docs3', path: '/api'}],
  ],
};

当某些插件和主题旨在一起使用时，这尤其有用。你甚至可以将它们的选项链接在一起，例如将一个选项传递给多个插件。

模块简写

Docusaurus 支持插件、主题和预设的简写形式。当它看到一个插件/主题/预设名称时，它会按以下顺序尝试加载其中一个：

[name] (例如 content-docs)
@docusaurus/[moduleType]-[name] (例如 @docusaurus/plugin-content-docs)
docusaurus-[moduleType]-[name] (例如 docusaurus-plugin-content-docs)

其中 moduleType 是 'preset'、'theme'、'plugin' 之一，取决于模块名称在哪个字段中声明。成功找到的第一个模块名称将被加载。

如果名称是作用域化的（以@开头），则名称首先通过第一个斜杠分割为作用域和包名：

@scope
^----^
 scope  (no name!)

@scope/awesome
^----^ ^-----^
 scope   name

@scope/awesome/main
^----^ ^----------^
 scope     name

如果没有名称（如@jquery），则加载[scope]/docusaurus-[moduleType]（即@jquery/docusaurus-plugin）。否则，将尝试以下操作：

[scope]/[name]（例如 @jquery/content-docs）
[scope]/docusaurus-[moduleType]-[name] (例如 @jquery/docusaurus-plugin-content-docs)

以下是一些示例，针对在plugins字段中注册的插件。请注意，与ESLint或Babel不同，它们强制要求插件遵循一致的命名约定，而Docusaurus允许更大的命名自由，因此解析结果并不确定，但遵循上述定义的优先级。

Declaration	May be resolved as
`awesome`	`docusaurus-plugin-awesome`
`sitemap`	`@docusaurus/plugin-sitemap`
`@my-company`	`@my-company/docusaurus-plugin` (the only possible resolution!)
`@my-company/awesome`	`@my-company/docusaurus-plugin-awesome`
`@my-company/awesome/web`	`@my-company/docusaurus-plugin-awesome/web`

安装插件​

配置插件​

多实例插件和插件ID​

使用主题​

使用预设​

@docusaurus/preset-classic​

安装预设​

创建预设​

模块简写​