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

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

2025-06-27 21:06:56作者:翟江哲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持续关注开发者体验和文档可用性,这个版本的改进进一步强化了其作为技术文档解决方案的能力。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
866
513
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
261
302
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K