首页
/ 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在代码展示方面达到了新的高度。对于需要丰富代码展示功能的文档项目来说,这无疑是一个值得关注的重要更新。

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

热门内容推荐

最新内容推荐

项目优选

收起
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