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持续关注开发者体验和文档可用性,这个版本的改进进一步强化了其作为技术文档解决方案的能力。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112
项目优选
收起
暂无描述
Dockerfile
733
4.75 K
deepin linux kernel
C
31
16
Ascend Extension for PyTorch
Python
652
797
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.25 K
153
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.1 K
611
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.01 K
1.01 K
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
147
237
昇腾LLM分布式训练框架
Python
168
200
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
434
395
暂无简介
Dart
986
253