Skip to main content

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

バグを報告する場合、デプロイ設定をより簡単に検査できるように、おそらく本番環境でこのプラグインを有効にするようお願いすることになるでしょう。

機密情報がない場合は、 私達（訳注：Docusaurus公式）同様本番環境で有効化したままでも構いません。

インストール​

npm install --save @docusaurus/plugin-debug
ヒント

プリセット@docusaurus/preset-classicを使用している場合、依存関係としてこのプラグインをインストールする必要はありません。

このプラグインは、 プリセットオプションで設定できます。

設定​

このプラグインには現在オプションがありません。

Example configuration​

このプラグインは、プリセットオプションまたはプラグインオプションを通じて設定できます。

ヒント

Most Docusaurus users configure this plugin through the preset options.

プリセットを使用する場合は、プリセットオプションを介してこのプラグインを設定してください。

docusaurus.config.js
export default {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        debug: true, // プラグインを本番で有効化
      },
    ],
  ],
};