跳到主要内容
版本：3.8.1

📦 plugin-debug

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

这主要对插件作者有用，他们可以更轻松地检查.docusaurus文件夹（例如创建的路由）的内容，还可以检查从不写入磁盘的数据结构，例如通过contentLoaded生命周期加载的插件数据。

信息

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

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

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

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

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

安装​

npm install --save @docusaurus/plugin-debug
提示

如果您使用预设 @docusaurus/preset-classic，则无需将此插件作为依赖项安装。

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

配置​

此插件目前没有可配置的选项。

示例配置​

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

提示

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

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

docusaurus.config.js
export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        debug: true, // This will enable the plugin in production
      },
    ],
  ],
};