📦 plugin-debug
除錯外掛會在 https://127.0.0.1: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),
};
註解
如果您回報錯誤,我們可能會要求您在實際環境中開啟這個外掛程式,以便我們可以更輕易地檢查您的部署配置。
如果您沒有任何敏感資訊,您可以像我們一樣在實際環境中保持開啟狀態。
安裝
- npm
- Yarn
- pnpm
npm install --save @docusaurus/plugin-debug
yarn add @docusaurus/plugin-debug
pnpm add @docusaurus/plugin-debug
提示
如果您使用預設值 @docusaurus/preset-classic
,您無需將這個外掛程式安裝為相依套件。
您可以透過預設值選項來設定這個外掛程式。
設定
這個外掛程式目前沒有選項。
設定範例
您可以透過預設值選項或外掛程式選項來設定這個外掛程式。
提示
大多數 Docusaurus 使用者透過預設值選項來設定這個外掛程式。
- 預設值選項
- 外掛程式選項
如果您使用預設值,請透過預設值選項來設定這個外掛程式。
docusaurus.config.js
export default {
presets: [
[
'@docusaurus/preset-classic',
{
debug: true, // This will enable the plugin in production
},
],
],
};
如果您正在使用獨立外掛程式,請直接提供選項給外掛程式。
docusaurus.config.js
export default {
plugins: ['@docusaurus/plugin-debug'],
};