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

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

2025-06-27 14:53:24作者:苗圣禹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 团队通过这些改进,进一步提升了框架的稳定性和易用性,为开发者提供了更强大的文档站点构建工具。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
509