📦 plugin-debug

mdx-code-block

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The debug plugin will display useful debug information at http://localhost:3000/__docusaurus/debug.

It is mostly useful for plugin authors, that will be able to inspect more easily the content of the .docusaurus folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the contentLoaded lifecycle.

If you use the plugin via the classic preset, the preset will enable the plugin in development and disable it in production by default (debug: undefined) to avoid exposing potentially sensitive information. You can use debug: true to always enable it or debug: false to always disable it.

If you use a standalone plugin, you may need to achieve the same effect by checking the environment:

docusaurus.config.js

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

Installation

npm2yarn

npm install --save @docusaurus/plugin-debug

Configuration

This plugin currently has no options.

Example configuration

You can configure this plugin through preset options or plugin options.

mdx-code-block

<Tabs groupId="api-config-ex">
<TabItem value="preset" label="Preset options">

If you use a preset, configure this plugin through the preset options:

docusaurus.config.js

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

mdx-code-block

</TabItem>
<TabItem value="plugin" label="Plugin Options">

If you are using a standalone plugin, provide options directly to the plugin:

docusaurus.config.js

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

mdx-code-block

</TabItem>
</Tabs>