RsbuildConfig用于自定义 Rsbuild 的配置项,完整配置项请查看 Rsbuild - 配置。
如果你想要修改产物输出目录,请使用 outDir。
RsbuildPlugin[]用于注册 Rsbuild 插件。
你可以利用 Rsbuild 丰富的插件生态来增强和扩展构建能力。
你也可以覆盖内置的 @rsbuild/plugin-react 并自定义插件的选项。
比如:
如果你需要查看默认的 Rspack 或 Rsbuild 配置,可以在执行 rspress dev 或 rspress build 命令时,添加 DEBUG=rsbuild 参数:
在执行后,doc_build 目录下会生成 rsbuild.config.js 文件,里面包含了完整的 builderConfig。
请查看 Rsbuild - 调试模式 来了解更多调试 Rsbuild 的方法。
配置 MDX 相关的编译能力。
Array[]用于增加一些自定义 remark 插件。比如:
Array用于增加一些自定义的 rehype 插件。比如:
类型: import('@shikijs/rehype').RehypeShikiOptions
默认值:
配置 Shiki 相关配置。具体可见 RehypeShikiOptions。
{ checkDeadLinks: true, autoPrefix: true }配置链接相关的配置。
boolean | { excludes: string[] | ((url: string) => boolean) }true开启这个配置后,会基于约定式路由对文档中的链接进行检查,若出现无法访问的链接,构建会抛出错误并退出。
如果存在误判链接的情况,可以通过 excludes 配置忽略该错误:
booleantrue开启这个配置后,会基于约定式路由对文档中的链接自动增加关于 国际化 和 多版本 前缀。
比如,用户在 docs/zh/guide/index.md 中写了一个链接 [](/guide/getting-started),Rspress 会自动将其转换为 [](/zh/guide/getting-started)。
boolean是否显示代码块的行号。默认为 false。
boolean是否默认启用长代码换行展示。默认为 false。
string[]注册全局组件,无需 import 语句,就可以在每个 MDX 文件中使用。比如:
这样你就可以在 MDX 文件中使用 Alert 组件了: