📦 plugin-debug

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

É principalmente útil para autores de plug-ins, que serão capazes de inspecionar mais facilmente o conteúdo da pasta .docusaurus (como as rotas de criação), mas também serão capazes de inspecionar estruturas de dados que nunca são gravadas disco, como os dados do plugin carregados por meio do ciclo de vida contentLoaded.

info

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

note

Se você relatar um bug, provavelmente pediremos que este plugin seja ativado na produção, para que possamos inspecionar sua configuração de implantação com mais facilidade.

If you don't have any sensitive information, you can keep it on in production like we do.

Instalação

npm

npm install --save @docusaurus/plugin-debug

Yarn

yarn add @docusaurus/plugin-debug

pnpm

pnpm add @docusaurus/plugin-debug

tip

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

Configuração

This plugin currently has no options.

Configuração de exemplo

Você pode configurar este plugin através das opções de predefinição ou opções do plugin.

tip

A maioria dos usuários do Docusaurus configura este plugin através das configurações de predefinição.

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

Plugin Options

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

docusaurus.config.js

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