目录

plugin-debug

优质
小牛编辑
117浏览
2023-12-01

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

这对于插件开发者最有用,它能帮开发者轻松检查 .docusaurus 文件夹中的内容(例如创建的路由),而且还能够检查从不写到硬盘上的数据,例如插件通过 contentLoaded 生命周期函数所加载的数据。

note

如果你想我们报告了一个 bug,我们可能会要求你在生成环境中开启此插件,以便我们可以轻松地检查你的部署配置情况来定位问题所在。

如果此插件不会暴露你的敏感信息,则可以在生产环境中开启此功能,就像我们的官网一样

安装

  • npm
  • Yarn
npm install --save @docusaurus/plugin-debug
yarn add @docusaurus/plugin-debug
tip

如果你已经安装了 @docusaurus/preset-classic,则不需要再安装此插件。你也可以在 @docusaurus/preset-classic 中对此插件进行配置,而不必像下面这样。

默认情况下,此功能在开发环境中是开启的,而在生产环境中被禁用,以避免暴露潜在的敏感信息。

配置

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