Rspress v1.44.0 版本发布:增强文档预览与API文档生成能力
2025-06-27 19:40:32作者:翟江哲Frasier
Rspress 是一个现代化的静态站点生成器,专为技术文档网站设计。它基于React构建,提供了丰富的插件系统和开箱即用的文档功能,能够帮助开发者快速搭建美观、高效的文档网站。本次发布的v1.44.0版本主要带来了文档预览功能的增强和API文档生成器的改进。
核心功能更新
文档预览插件新增固定位置模式
在技术文档中,代码预览是一个非常重要的功能。Rspress的plugin-preview插件在此次更新中新增了iframePosition配置项的fixed-with-per-comp选项。这个选项允许开发者为每个预览组件单独设置固定位置,而不是全局统一设置。
这种细粒度的控制特别适合以下场景:
- 文档中同时包含需要固定位置和不需要固定位置的预览组件
- 不同章节的预览组件需要不同的布局方式
- 复杂文档中需要更灵活的预览区域定位
开发者现在可以在配置中这样使用:
{
iframePosition: 'fixed-with-per-comp'
}
API文档生成器支持锚点定位
plugin-api-doc-gen插件在此版本中修复了锚点缺失的问题。现在生成的API文档会自动为每个API条目添加锚点,方便开发者直接链接到特定的API说明。
这个改进带来了以下好处:
- 文档内部可以直接跳转到特定API说明
- 可以在外部链接中直接引用具体API
- 提升了大型API文档的导航体验
开发体验优化
禁用Monaco编辑器的TS检查以支持TSX
plugin-playground插件现在默认禁用了Monaco编辑器对TypeScript的类型检查,这解决了之前无法正常使用TSX语法的问题。对于技术文档中的代码示例,特别是React组件示例,这一改进意味着:
- 开发者可以直接在Playground中编写和展示TSX代码
- 减少了不必要的类型错误干扰
- 提升了示例代码的编写体验
Rsbuild版本升级至1.3.18
底层构建工具Rsbuild已更新至1.3.18版本,并设置了正确的调用者名称。这一更新带来了:
- 构建性能的潜在优化
- 更好的构建错误提示
- 更稳定的构建过程
升级建议
对于现有项目,建议通过以下步骤升级:
- 更新package.json中的rspress版本
- 检查是否有自定义预览插件配置,根据需要调整iframePosition
- 验证API文档中的锚点功能是否符合预期
- 测试Playground中的TSX支持
这个版本特别适合以下类型的项目:
- 需要展示大量代码示例的技术文档
- 包含复杂API参考的库文档
- 使用TypeScript特别是TSX的项目文档
Rspress持续关注开发者体验和文档可用性,这个版本的改进进一步强化了其作为技术文档解决方案的能力。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00
项目优选
收起
deepin linux kernel
C
27
14
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
Ascend Extension for PyTorch
Python
504
609
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
391
288
暂无简介
Dart
906
218
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
昇腾LLM分布式训练框架
Python
142
168
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
939
863
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108