📦 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),
};

注意

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

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

安装

npm

npm install --save @docusaurus/plugin-debug

Yarn

yarn add @docusaurus/plugin-debug

pnpm

pnpm add @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
      },
    ],
  ],
};

插件选项

如果您使用的是独立插件，请直接向插件提供选项。

docusaurus.config.js

export default {
  plugins: ['@docusaurus/plugin-debug'],
};