📦 plugin-debug

调试插件将在http://localhost:3000/__docusaurus/debug上显示有用的调试信息。

它对插件作者来说非常有用，可以更容易地检查.docusaurus文件夹的内容(如创建路由)，但也可以检查从未写入磁盘的数据结构，如通过contentLoaded生命周期加载的插件数据。

信息

如果你通过经典预设使用插件，预设将在开发中启用插件，并在生产中默认禁用它 (debug: undefined)，以避免暴露潜在的敏感信息。您可以使用debug: true来始终启用它，或debug: false来始终禁用它。

如果你使用一个独立的插件，你可能需要通过检查环境来达到同样的效果:

docusaurus.config.js

module.exports = {
  plugins: [
    process.env.NODE_ENV === "production" && "@docusaurus/plugin-debug",
  ].filter(Boolean),
};

备注

如果你报告了一个 bug，我们可能会要求你在生产环境中打开这个插件，这样我们就可以更容易地检查你的部署配置。

如果你没有任何敏感信息，你可以在生产环境中像我们一样。

安装

npm

npm install --save @docusaurus/plugin-debug

Yarn

yarn add @docusaurus/plugin-debug

pnpm

pnpm add @docusaurus/plugin-debug

提示

如果你使用预设的@docusaurus/preset-classic，你不需要将这个插件作为依赖项安装。

您可以通过预设选项配置此插件。

配置

这个插件目前没有选项。

示例配置

您可以通过预设选项或插件选项来配置这个插件。

提示

大多数 Docusaurus 用户通过预设选项配置这个插件。

Preset options

如果你使用预设，通过预设选项配置这个插件:

docusaurus.config.js

module.exports = {
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        debug: true, // This will enable the plugin in production
      },
    ],
  ],
};

Plugin Options

如果你使用的是独立插件，直接给插件提供选项:

docusaurus.config.js

module.exports = {
  plugins: ["@docusaurus/plugin-debug"],
};