首页
/ Rspress v2.0.0-beta.8 发布:动态代码高亮组件与Shiki增强

Rspress v2.0.0-beta.8 发布:动态代码高亮组件与Shiki增强

2025-06-27 01:52:24作者:俞予舒Fleming

Rspress 是一个现代化的静态站点生成器,专注于为技术文档提供优秀的开发体验。它基于React和Rspack构建,具有出色的构建性能和灵活的扩展能力。

动态代码高亮组件 CodeBlockRuntime

本次发布的 v2.0.0-beta.8 版本引入了一个重要的新特性——CodeBlockRuntime组件。这个组件解决了传统静态代码高亮在编译时处理的局限性,为开发者提供了运行时动态高亮代码的能力。

核心特性

  1. 运行时高亮:不同于传统的编译时高亮,CodeBlockRuntime在浏览器运行时处理代码高亮,特别适合需要动态展示代码的场景。

  2. Shiki集成:内置支持Shiki高亮引擎,可以通过shikiOptions属性进行深度定制。

  3. 注解支持:兼容Shiki的代码注释标记语法,如[!code highlight]等。

  4. 渲染回调:提供onRendered回调函数,可以在代码高亮完成后执行自定义逻辑。

使用示例

import { CodeBlockRuntime } from '@theme';
import { transformerNotationHighlight } from '@shikijs/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()],
  }}
/>

Shiki转换器增强

为了配合CodeBlockRuntime组件的使用,本次更新还增强了Shiki转换器的支持:

  1. 新增导出@rspress/plugin-shiki/transformers现在可以直接导出常用的Shiki转换器。

  2. 兼容性转换器:新增transformerCompatibleMetaHighlight转换器,确保代码注释标记在不同环境下的一致性。

技术实现细节

CodeBlockRuntime组件的实现考虑了以下关键点:

  1. DOM结构一致性:确保运行时生成的DOM结构与编译时生成的代码块结构完全一致,避免样式和交互上的差异。

  2. 性能优化:采用懒加载策略,只有在组件进入视口时才执行高亮处理,减少不必要的性能开销。

  3. 错误处理:内置完善的错误处理机制,当高亮过程出现问题时能够优雅降级。

适用场景

这个新特性特别适合以下场景:

  1. 动态代码展示:当需要根据用户交互动态展示不同代码片段时。

  2. 代码编辑器集成:在文档中嵌入可交互的代码编辑器组件。

  3. 高级代码标注:需要复杂代码高亮和注释的场景。

  4. 主题切换:在运行时动态切换代码高亮主题。

总结

Rspress v2.0.0-beta.8通过引入CodeBlockRuntime组件,为技术文档的代码展示提供了更大的灵活性。这一改进不仅保留了静态生成的高性能优势,还增加了运行时动态处理的能力,使得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