From 3f1388408b70c43197b7b6c6b864edd698d6ae47 Mon Sep 17 00:00:00 2001 From: sebastien Date: Thu, 17 Oct 2024 17:01:45 +0200 Subject: [PATCH] add docs --- website/docs/api/plugins/plugin-rsdoctor.mdx | 51 ++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 website/docs/api/plugins/plugin-rsdoctor.mdx diff --git a/website/docs/api/plugins/plugin-rsdoctor.mdx b/website/docs/api/plugins/plugin-rsdoctor.mdx new file mode 100644 index 000000000000..33710d221784 --- /dev/null +++ b/website/docs/api/plugins/plugin-rsdoctor.mdx @@ -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 + +``` + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| `rsdoctorOptions` | `object` | `{}` | The [Rsdoctor options](https://rsdoctor.dev/config/options/options) | + +```mdx-code-block + +``` + +### Example configuration {#ex-config} + +You can configure this plugin through plugin options. + +```js title="docusaurus.config.js" +export default { + plugins: [ + [ + 'rsdoctor', + { + rsdoctorOptions: { + mode: 'lite', + }, + }, + ], + ], +}; +```