close
Rspress
Guide
Plugin
API
Version
Guide
Plugin
API

Build config

builderConfig

  • Type: RsbuildConfig

Used to customize the configurations of Rsbuild. For detailed configurations, please refer to Rsbuild - Config.

rspress.config.ts
export default defineConfig({
  builderConfig: {
    resolve: {
      alias: {
        '@common': './src/common',
      },
    },
  },
});
  • Example: Use tools.rspack to modify the Rspack configuration, such as registering a webpack or Rspack plugin:
rspress.config.ts
export default defineConfig({
  builderConfig: {
    tools: {
      rspack: async (config) => {
        const { default: ESLintPlugin } = await import('eslint-webpack-plugin');
        config.plugins?.push(new ESLintPlugin());
        return config;
      },
    },
  },
});
WARNING

If you want to modify the output directory, please use outDir.

builderPlugins

  • Type: RsbuildPlugin[]

To register Rsbuild plugins.

You can leverage Rsbuild's extensive plugin ecosystem to enhance and extend your build capabilities.

rspress.config.ts
import { defineConfig } from 'rspress/config';
import { pluginVue } from '@rsbuild/plugin-vue';

export default defineConfig({
  builderPlugins: [pluginVue()],
});
rspress.config.ts
import { defineConfig } from 'rspress/config';
import { pluginGoogleAnalytics } from 'rsbuild-plugin-google-analytics';

export default defineConfig({
  builderPlugins: [
    pluginGoogleAnalytics({
      // replace this with your Google tag ID
      id: 'G-xxxxxxxxxx',
    }),
  ],
});
rspress.config.ts
import { defineConfig } from 'rspress/config';
import { pluginOpenGraph } from 'rsbuild-plugin-open-graph';

export default defineConfig({
  builderPlugins: [
    pluginOpenGraph({
      title: 'My Website',
      type: 'website',
      // ...options
    }),
  ],
});

You can also override the built-in plugin @rsbuild/plugin-react and customize the plugin options.

For example:

rspress.config.ts
import { defineConfig } from 'rspress/config';
import { pluginReact } from '@rsbuild/plugin-react';

export default defineConfig({
  builderPlugins: [
    pluginReact({
      // ...options
    }),
  ],
});

Default config

If you need to view the default Rspack or Rsbuild configs, you can add the DEBUG=rsbuild parameter when running the rspress dev or rspress build command:

DEBUG=rsbuild rspress dev

After execution, the rsbuild.config.js file is created in the doc_build directory, which contains the complete builderConfig.

Please refer to Rsbuild - Debug Mode for more information on how to debug the Rsbuild.

markdown

  • Type: Object

Configure MDX-related compilation abilities.

markdown.remarkPlugins

  • Type: Array
  • Default: []

Configure the remark plugins. for example:

rspress.config.ts
import { defineConfig } from 'rspress/config';

export default defineConfig({
  markdown: {
    remarkPlugins: [
      [
        require('remark-autolink-headings'),
        {
          behavior: 'wrap',
        },
      ],
    ],
  },
});

markdown.rehypePlugins

  • Type: Array

Configure the rehype plugin. for example:

rspress.config.ts
import { defineConfig } from 'rspress/config';

export default defineConfig({
  markdown: {
    rehypePlugins: [
      [
        require('rehype-autolink-headings'),
        {
          behavior: 'wrap',
        },
      ],
    ],
  },
});

markdown.checkDeadLinks

  • Type: boolean
  • Default: false

Whether to check for dead links. for example:

rspress.config.ts
import { defineConfig } from 'rspress/config';

export default defineConfig({
  markdown: {
    checkDeadLinks: true,
  },
});

After enabling this config, Rspress will check the links in the document based on the conventional routing table. If there is an unreachable link, the build will throw an error and exit.

markdown.mdxRs

  • Type: boolean | { include: (filepath: string) => boolean }
  • Default: true

Whether to use the Rust version of the MDX compiler. For example:

rspress.config.ts
import { defineConfig } from 'rspress/config';

export default defineConfig({
  markdown: {
    // Switch to the JS version of the compiler
    mdxRs: false,
  },
});

You can also provide a function to determine which files use the Rust version of MDX compiler. For example:

rspress.config.ts
import { defineConfig } from 'rspress/config';

export default defineConfig({
  markdown: {
    mdxRs: {
      include: (filepath: string) => filepath.includes('foo.mdx'),
    },
  },
});
NOTICE

The bottom layer of mdxRs is based on the @rspress/mdx-rs-binding library developed by Rspress. The performance is 10+ times higher than the JS version of the MDX compiler, but the JS version of the plugin is not yet supported.

markdown.showLineNumbers

  • Type: boolean

Whether to display the line number of the code block. Defaults to false.

markdown.defaultWrapCode

  • Type: boolean

Whether to enable long code line wrapping display by default. Defaults to false.

markdown.globalComponents

  • Type: string[]

Register component to the global scope, which will make it automatically available in every MDX file, without any import statements.For example:

rspress.config.ts
import { defineConfig } from 'rspress/config';
import path from 'path';

export default defineConfig({
  markdown: {
    globalComponents: [path.join(__dirname, 'src/src/components/Alert.tsx')],
  },
});

Then you can use the Alert component in any MDX file:

test.mdx
<Alert type="info">This is a info alert</Alert>
Danger

Please set markdown.mdxRs to false when configuring globalComponents, otherwise the global components will not take effect.