首页
/ Rspress v2.0.0-beta.14 发布:Shiki 集成优化与异步入口支持

Rspress v2.0.0-beta.14 发布:Shiki 集成优化与异步入口支持

2025-06-27 19:18:10作者:苗圣禹Peter

Rspress 是一个现代化的静态站点生成器,专为技术文档和博客设计。它基于 React 和 MDX,提供了丰富的功能集,包括代码高亮、主题定制和插件系统等。本次发布的 v2.0.0-beta.14 版本带来了几项重要改进,特别是对代码高亮系统的重构和异步入口的支持。

Shiki 集成优化

在本次更新中,Rspress 团队对代码高亮系统进行了重大重构。原先的 @rspress/plugin-shiki 插件包已被移除,取而代之的是内置的 rspress/shiki-transformers 模块。这一变化意味着:

  1. Shiki 现在已成为 Rspress 的核心功能,无需额外安装插件即可使用
  2. 内置了多个实用的代码转换器,如行号显示和兼容性元数据高亮
  3. 开发者可以更灵活地组合使用内置转换器和社区提供的转换器

使用示例如下:

import { CodeBlockRuntime } from '@theme';
import { transformerNotationHighlight } from '@shikijs/transformers';
import { transformerLineNumber } from "rspress/shiki-transformers";

<CodeBlockRuntime
  lang="ts"
  title="highlight.ts"
  code={`console.log('Highlighted'); // [!code highlight]
// [!code highlight:1]
console.log('Highlighted');
console.log('Not highlighted');`}
  shikiOptions={{
    transformers: [transformerNotationHighlight(), transformerLineNumber()],
  }}
/>

这种设计使得代码高亮的定制更加模块化和灵活,开发者可以根据需要选择特定的转换器组合。

异步入口支持

另一个重要改进是新增了对异步入口的支持。这意味着:

  1. 构建过程可以更高效地处理大型文档站点
  2. 开发者可以按需加载资源,优化首屏性能
  3. 为未来可能的动态功能扩展奠定了基础

其他改进

本次更新还包括以下改进:

  1. 修复了 MDX 标题中空格处理的问题,确保文档结构更准确
  2. 移除了不再需要的 highlightLanguages 配置选项,简化了配置
  3. 将部分测试用例迁移到单元测试,提高了测试覆盖率和稳定性

升级建议

对于现有项目,升级时需要注意:

  1. 如果之前使用了 @rspress/plugin-shiki,需要移除相关配置,改用内置的转换器
  2. 检查项目中是否有依赖 highlightLanguages 的配置,需要移除
  3. 考虑利用新的异步入口特性优化项目结构

Rspress 团队通过这些改进,进一步提升了框架的稳定性和易用性,为开发者提供了更强大的文档站点构建工具。

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

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
861
511
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
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K