📦 plugin-debug

Le plugin de débogage affichera des informations de débogage utiles à l'adresse http://localhost:3000/\_docusaurus/debug.

Il est principalement utile pour les auteurs de plugins, qui seront en mesure d'inspecter plus facilement le contenu du dossier .docusaurus (tel que les routes créées), mais aussi être en mesure d'inspecter les structures de données qui ne sont jamais écrites sur le disque, tel que les données du plugin chargées à travers le cycle de vie contentLoaded.

info

Si vous utilisez le plugin via le preset classique, le preset activera le plugin en développement et le désactivera en production par défaut (debug : undefined) pour éviter d'exposer des informations potentiellement sensibles. Vous pouvez utiliser debug: true pour toujours l'activer ou debug: false pour toujours le désactiver.

Si vous utilisez un plugin autonome, vous devrez peut-être obtenir le même effet en vérifiant l'environnement :

docusaurus.config.js

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

remarque

Si vous signalez un bogue, nous vous demanderons probablement d'activer ce plugin en production, afin que nous puissions inspecter votre configuration de déploiement plus facilement.

Si vous n'avez pas d'informations sensibles, vous pouvez les conserver en production comme nous le faisons.

Installation

npm

npm install --save @docusaurus/plugin-debug

Yarn

yarn add @docusaurus/plugin-debug

pnpm

pnpm add @docusaurus/plugin-debug

astuce

Si vous utilisez le preset @docusaurus/preset-classic, vous n'avez pas besoin d'installer ce plugin en tant que dépendance.

Vous pouvez configurer ce plugin via les options du preset.

Configuration

Ce plugin n'a actuellement aucune option.

Exemple de configuration

Vous pouvez configurer ce plugin via les options du preset ou du plugin.

astuce

La plupart des utilisateurs de Docusaurus configurent ce plugin via les options du preset.

Preset options

Si vous utilisez un preset, configurez ce plugin à travers les options du preset :

docusaurus.config.js

export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        debug: true, // Ceci activera le plugin en production
      },
    ],
  ],
};

Plugin Options

Si vous utilisez un plugin autonome, fournissez des options directement au plugin :

docusaurus.config.js

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