首页
/ Rspress v1.44.0 版本发布:增强文档预览与API文档生成能力

Rspress v1.44.0 版本发布:增强文档预览与API文档生成能力

2025-06-27 18:08:43作者:翟江哲Frasier

Rspress 是一个现代化的静态站点生成器,专为技术文档网站设计。它基于React构建,提供了丰富的插件系统和开箱即用的文档功能,能够帮助开发者快速搭建美观、高效的文档网站。本次发布的v1.44.0版本主要带来了文档预览功能的增强和API文档生成器的改进。

核心功能更新

文档预览插件新增固定位置模式

在技术文档中,代码预览是一个非常重要的功能。Rspress的plugin-preview插件在此次更新中新增了iframePosition配置项的fixed-with-per-comp选项。这个选项允许开发者为每个预览组件单独设置固定位置,而不是全局统一设置。

这种细粒度的控制特别适合以下场景:

  1. 文档中同时包含需要固定位置和不需要固定位置的预览组件
  2. 不同章节的预览组件需要不同的布局方式
  3. 复杂文档中需要更灵活的预览区域定位

开发者现在可以在配置中这样使用:

{
  iframePosition: 'fixed-with-per-comp'
}

API文档生成器支持锚点定位

plugin-api-doc-gen插件在此版本中修复了锚点缺失的问题。现在生成的API文档会自动为每个API条目添加锚点,方便开发者直接链接到特定的API说明。

这个改进带来了以下好处:

  1. 文档内部可以直接跳转到特定API说明
  2. 可以在外部链接中直接引用具体API
  3. 提升了大型API文档的导航体验

开发体验优化

禁用Monaco编辑器的TS检查以支持TSX

plugin-playground插件现在默认禁用了Monaco编辑器对TypeScript的类型检查,这解决了之前无法正常使用TSX语法的问题。对于技术文档中的代码示例,特别是React组件示例,这一改进意味着:

  1. 开发者可以直接在Playground中编写和展示TSX代码
  2. 减少了不必要的类型错误干扰
  3. 提升了示例代码的编写体验

Rsbuild版本升级至1.3.18

底层构建工具Rsbuild已更新至1.3.18版本,并设置了正确的调用者名称。这一更新带来了:

  1. 构建性能的潜在优化
  2. 更好的构建错误提示
  3. 更稳定的构建过程

升级建议

对于现有项目,建议通过以下步骤升级:

  1. 更新package.json中的rspress版本
  2. 检查是否有自定义预览插件配置,根据需要调整iframePosition
  3. 验证API文档中的锚点功能是否符合预期
  4. 测试Playground中的TSX支持

这个版本特别适合以下类型的项目:

  • 需要展示大量代码示例的技术文档
  • 包含复杂API参考的库文档
  • 使用TypeScript特别是TSX的项目文档

Rspress持续关注开发者体验和文档可用性,这个版本的改进进一步强化了其作为技术文档解决方案的能力。

登录后查看全文
热门项目推荐