3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-14 09:37:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(v2): prepare v2.0.0-beta.2 release (#5056)

Browse source 
* prepare beta.2

* v2.0.0-beta.2
This commit is contained in:
Sébastien Lorber 2021-06-24 19:39:37 +02:00 • committed by GitHub
parent 138b4c9975
commit ec2486d2c9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 12167 additions and 147 deletions
Download patch file Download diff file Expand all files Collapse all files

39
website/versioned_docs/version-2.0.0-beta.2/api/plugins/plugin-debug.md Normal file
View file

@ -0,0 +1,39 @@
---
id: plugin-debug
title: '📦 plugin-debug'
slug: '/api/plugins/@docusaurus/plugin-debug'
---
The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug).
It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle.
:::note
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
If you don't have any sensitive information, you can keep it on in production [like we do](http://docusaurus.io/__docusaurus/debug).
:::
## Installation {#installation}
```bash npm2yarn
npm install --save @docusaurus/plugin-debug
```
:::tip
If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. You can also configure it through the [classic preset options](presets.md#docusauruspreset-classic) instead of doing it like below.
By default, it's enabled in dev, and disabled in prod, to avoid exposing potentially sensitive information.
:::
## Configuration {#configuration}
```js title="docusaurus.config.js"
module.exports = {
plugins: ['@docusaurus/plugin-debug'],
};
```