Skip to main content

debug-hook

TL;DR

Allows to integrate the debug page into the documentation.
Uses the @docusaurus/plugin-debug.

Integration:

1. Add dependency

yarn add -WD "@docusaurus-tde/debug-hook"

2. Connect the hook

docusaurus-tde.config.js

module.exports = {
hooks: [
/*
If enabled during the build stage in the CI - in the search results,
you will see the content from the debug page.
*/
['@docusaurus-tde/debug-hook', { enabled: !process.env.CI, logs: !!process.env.CI }],
]
}

Hook configuration:

type debugHookProps = {
enabled?: boolean; // default: true
logs?: boolean; // default: false
}