跳到主要内容

📦 plugin-debug

调试插件会在 http://localhost: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.config.js
export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        debug: true, // 生产环境下启用插件
      },
    ],
  ],
};