介绍

Rspress 是一个基于 Rsbuild 的静态站点生成器,使用 React 进行渲染,内置了一套默认的文档主题。你可以通过 Rspress 快速搭建文档站点,也可以自定义主题来满足个性化的静态站需求,如博客站、产品主页等。此外,你还可以接入官方提供的插件来便捷地搭建组件库文档。

为什么选择 Rspress

Rspress 主要围绕以下几个核心特性进行设计:

  • 构建性能 - 保证足够快的启动速度,带来良好的开发体验。
  • AI-native - 技术文档不仅服务于人类读者,也可以通过 SSG-MD 被 AI 更好地理解和使用。
  • 主题与定制能力 - 提供全新默认主题,并支持 CSS 变量、BEM 类名、重导出和 eject 等多种定制方式。
  • MDX 支持 - 通过 MDX,我们可以方便地复用文档片段,以及在文档中渲染自定义的 React 组件。
  • 文档开发体验 - 围绕导航配置、代码块、死链检查等能力持续优化日常写作文档的体验。
  • 文档站基础能力 - 包括国际化、多版本支持、全文搜索、组件库文档等。
  • 可扩展性 - 内置插件系统,支持通过插件 API 来扩展功能。

这些也代表了静态站点开发的一些核心需求。接下来将会根据这几个方面分别进行介绍。

品牌色

css
:where(:root) {
  --rp-c-brand: #0095ff;
  --rp-c-brand-light: #33adff;
  --rp-c-brand-lighter: #c6e0fd;
  --rp-c-brand-dark: #07f;
  --rp-c-brand-darker: #005fcc;
  --rp-c-brand-tint: #7fa3ff29;
}

尝试使用 Rspress

请前往 快速开始 了解如何使用 Rspress 构建文档站点。