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持续关注开发者体验和文档可用性,这个版本的改进进一步强化了其作为技术文档解决方案的能力。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
525
3.72 K
Ascend Extension for PyTorch
Python
329
391
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
877
578
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
335
162
暂无简介
Dart
764
189
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.33 K
746
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
67
20
React Native鸿蒙化仓库
JavaScript
302
350