Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
slorber committed Oct 17, 2024
1 parent 8a1a311 commit 3f13884
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions website/docs/api/plugins/plugin-rsdoctor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
sidebar_position: 7
slug: /api/plugins/@docusaurus/plugin-google-gtag
---

# 📦 plugin-rsdoctor

import APITable from '@site/src/components/APITable';

A [Rsdoctor](https://rsdoctor.dev/) plugin can help you troubleshoot the bundling of your Docusaurus app. It can help you figure out which plugin or loader is slowing down the bundler, so you can focus your efforts on optimizing what matters. It supports both Webpack and Rspack bundlers.

## Installation {#installation}

```bash npm2yarn
npm install --save @docusaurus/plugin-rsdoctor
```

## Configuration {#configuration}

Accepted fields:

```mdx-code-block
<APITable>
```

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `rsdoctorOptions` | `object` | `{}` | The [Rsdoctor options](https://rsdoctor.dev/config/options/options) |

```mdx-code-block
</APITable>
```

### Example configuration {#ex-config}

You can configure this plugin through plugin options.

```js title="docusaurus.config.js"
export default {
plugins: [
[
'rsdoctor',
{
rsdoctorOptions: {
mode: 'lite',
},
},
],
],
};
```

0 comments on commit 3f13884

Please sign in to comment.