@docusaurus/plugin-debug

What is @docusaurus/plugin-debug?

@docusaurus/plugin-debug is a plugin for Docusaurus that helps developers debug their Docusaurus site by providing various debugging tools and utilities.

What are @docusaurus/plugin-debug's main functionalities?

Debugging Information

This feature allows you to add the @docusaurus/plugin-debug to your Docusaurus site configuration. Once added, it provides debugging information that can help you troubleshoot issues with your site.

module.exports = {
  plugins: ['@docusaurus/plugin-debug'],
};

Debugging Routes

This feature enables debugging routes, which helps you understand how your site's routes are being processed and rendered. This can be particularly useful for identifying routing issues.

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-debug',
      {
        debugRoutes: true,
      },
    ],
  ],
};

Debugging Metadata

This feature enables debugging metadata, which provides insights into the metadata being used by your Docusaurus site. This can help you ensure that your metadata is correctly configured.

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-debug',
      {
        debugMetadata: true,
      },
    ],
  ],
};

Other packages similar to @docusaurus/plugin-debug

webpack-bundle-analyzer

webpack-bundle-analyzer is a tool that helps you visualize the size of webpack output files with an interactive zoomable treemap. It is similar to @docusaurus/plugin-debug in that it provides insights into your project's build, but it is focused on webpack bundles rather than Docusaurus-specific debugging.

eslint

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. While it is not specific to Docusaurus, it provides debugging and linting capabilities that can help you maintain code quality and catch potential issues early in the development process.

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It provides a comprehensive suite of testing utilities that can help you debug and ensure the correctness of your code. While it is not specific to Docusaurus, it can be used to test and debug the JavaScript code within your Docusaurus site.

README

@docusaurus/plugin-debug

Debug plugin for Docusaurus.

Usage

See plugin-debug documentation.

Changelog

3.0.1 (2023-11-30)

:bug: Bug Fix

• docusaurus-utils
  • #9570 fix: add v2 retrocompatible support for quoted admonitions (@slorber)
  • #9535 fix: v3 admonitions should support v2 title syntax for nested admonitions (@slorber)
• create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
  • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
• docusaurus-theme-common
  • #9531 fix(theme): docs html sidebar items should always be visible (@slorber)
• docusaurus-theme-classic
  • #9530 fix(theme): fix firefox CSS :has() support bug (@slorber)
• create-docusaurus
  • #9487 fix(create-docusaurus): fix readme docusaurus 2 ref (@slorber)

:robot: Dependencies

• docusaurus-plugin-debug
  • #9566 chore(debug-plugin): migrate to a new maintained JSON Viewer (@mcrstudio)
• create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
  • #9572 chore: upgrade prism-react-renderer to 2.3.0 to avoid older clsx (@harryzcy)
  • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
• create-docusaurus, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
  • #9464 chore: Upgrade clsx to 2.0.0 (@harryzcy)
• docusaurus
  • #9547 chore(core): replace wait-on dependency with custom lighter code (@NickGerleman)
• docusaurus-plugin-pwa, docusaurus
  • #9529 chore: ugrade babel dependencies to v7.23.3 (@reece-white)

Committers: 6

• Chongyi Zheng (@harryzcy)
• MCR Studio (@mcrstudio)
• Nick Gerleman (@NickGerleman)
• Shreesh Nautiyal (@Shreesh09)
• Sébastien Lorber (@slorber)
• @reece-white