📦 plugin-debug
デバッグプラグインは、http://localhost:3000/__docusaurus/debug
に役立つデバッグ情報を表示します。
これは主にプラグイン作者にとって役立ちます。作成されたルートなど、.docusaurus
フォルダーの内容を簡単に検査できるだけでなく、`contentLoaded` ライフサイクルを通じてロードされたプラグインデータなど、ディスクに書き込まれないデータ構造も検査できます。
Classic プリセット経由でプラグインを使用する場合、プリセットはデフォルトで(`debug: undefined`)、**開発環境ではプラグインを有効にし、本番環境では無効にします**。機密情報の漏洩を防ぐためです。 `debug: true` を使用して常に有効にするか、 `debug: false` を使用して常に無効にすることができます。
スタンドアロンプラグインを使用する場合は、環境を確認して同じ効果を実現する必要がある場合があります。
export default {
plugins: [
process.env.NODE_ENV === 'production' && '@docusaurus/plugin-debug',
].filter(Boolean),
};
バグを報告する場合、デプロイ設定をより簡単に検査できるように、本番環境でこのプラグインを有効にするようにお願いすることがあります。
機密情報がない場合は、私たちのように本番環境で有効にしておくことができます。
インストール
- npm
- Yarn
- pnpm
npm install --save @docusaurus/plugin-debug
yarn add @docusaurus/plugin-debug
pnpm add @docusaurus/plugin-debug
プリセット `@docusaurus/preset-classic` を使用している場合、このプラグインを依存関係としてインストールする必要はありません。
プリセットオプションを使用して、このプラグインを設定できます。
設定
現在、このプラグインにはオプションがありません。
設定例
プリセットオプションまたはプラグインオプションを使用して、このプラグインを設定できます。
ほとんどのDocusaurusユーザーは、プリセットオプションを使用してこのプラグインを設定します。
- プリセットオプション
- プラグインオプション
プリセットを使用する場合は、プリセットオプションを使用してこのプラグインを設定します。
export default {
presets: [
[
'@docusaurus/preset-classic',
{
debug: true, // This will enable the plugin in production
},
],
],
};
スタンドアロンプラグインを使用している場合は、プラグインに直接オプションを提供します。
export default {
plugins: ['@docusaurus/plugin-debug'],
};