Skip to main content
Version: 3.0.1

📦 插件调试

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

它主要对插件作者有用，他们将能够更容易地检查.docusaurus文件夹的内容（如创建的路由），并且还能够检查从未写入磁盘的数据结构，如通过contentLoaded生命周期加载的插件数据。

info

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

如果你使用独立插件，你可能需要通过检查环境来实现相同的效果：

docusaurus.config.js
export default {
  plugins: [
    process.env.NODE_ENV === 'production' && '@docusaurus/plugin-debug',
  ].filter(Boolean),
};
note

如果您报告了一个错误，我们可能会要求您在生产环境中启用此插件，以便我们更容易检查您的部署配置。

如果您没有任何敏感信息，您可以在生产环境中保持启用状态就像我们一样。

安装​

npm install --save @docusaurus/plugin-debug
tip

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

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

配置​

此插件目前没有选项。

示例配置​

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

tip

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

如果您使用预设，请通过预设选项配置此插件：

docusaurus.config.js
export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        debug: true, // 这将在生产环境中启用插件
      },
    ],
  ],
};