首页
/ Rspress v2.0.0-beta.3 发布:动态 TOC 生成与 MDX 组件增强

Rspress v2.0.0-beta.3 发布:动态 TOC 生成与 MDX 组件增强

2025-06-27 02:40:24作者:农烁颖Land

Rspress 是一个现代化的静态站点生成器,专为技术文档和博客设计。它基于 React 生态构建,提供了丰富的功能和灵活的扩展性,使开发者能够快速构建高性能的文档网站。最新发布的 v2.0.0-beta.3 版本带来了多项重要改进,特别是在动态 TOC 生成和 MDX 组件支持方面有了显著增强。

动态 TOC 生成功能

本次更新的核心亮点是引入了动态 TOC(Table of Contents)生成功能。这一改进彻底改变了传统静态 TOC 的局限性,为文档编写带来了全新的可能性。

技术实现原理

动态 TOC 生成通过解析 MDX 文档内容,实时构建文档结构。与静态 TOC 相比,它能够:

  1. 自动识别文档中的标题层级关系
  2. 动态响应文档内容变化
  3. 支持更复杂的文档结构

实际应用场景

MDX 与 Tabs 组件的完美结合

新版本解决了长期以来 MDX 文档中使用 Tabs 组件时 TOC 无法正确生成的痛点。现在,开发者可以自由地在文档中使用类似如下的结构:

## 安装方法

<Tabs>
<TabItem value="npm">

```bash
npm install package
yarn add package
```

系统能够正确识别并生成对应的 TOC 条目,而不会因为 Tabs 组件的存在导致结构混乱。

标题中的 Badge 支持

另一个重要改进是支持在标题中直接使用 Badge 组件,例如:

## 核心功能 <Badge type="warning">实验性</Badge>

这种写法现在能够被正确解析,Badge 会显示在标题旁边,同时不影响 TOC 的生成。这为文档提供了更丰富的表现形式,开发者可以用不同颜色的 Badge 来标记功能状态、重要程度等信息。

其他重要改进

除了核心的 TOC 功能外,本次更新还包括:

  1. 导航栏大小写处理优化:修复了导航栏在某些情况下对大小写处理不一致的问题,提高了路由匹配的准确性。

  2. 构建优化:通过外部化依赖等方式减少了插件包体积,提升了构建效率。

  3. 安全更新:将 react-helmet-async 迁移至 @dr.pogodin/react-helmet,确保项目的长期维护性。

升级建议

对于正在使用 Rspress 1.x 版本的项目,建议先参考迁移指南进行测试升级。新项目可以直接使用这一版本开始开发,体验最新的文档编写方式。

这一版本的发布标志着 Rspress 在 MDX 支持方面迈出了重要一步,为开发者提供了更强大、更灵活的文档编写体验。动态 TOC 生成功能的引入不仅解决了现有问题,更为未来的功能扩展奠定了基础。

登录后查看全文