Rspress v2.0.0-beta.8 发布:动态代码高亮组件与Shiki增强
Rspress 是一个现代化的静态站点生成器,专注于为技术文档提供优秀的开发体验。它基于React和Rspack构建,具有出色的构建性能和灵活的扩展能力。
动态代码高亮组件 CodeBlockRuntime
本次发布的 v2.0.0-beta.8 版本引入了一个重要的新特性——CodeBlockRuntime组件。这个组件解决了传统静态代码高亮在编译时处理的局限性,为开发者提供了运行时动态高亮代码的能力。
核心特性
-
运行时高亮:不同于传统的编译时高亮,
CodeBlockRuntime在浏览器运行时处理代码高亮,特别适合需要动态展示代码的场景。 -
Shiki集成:内置支持Shiki高亮引擎,可以通过
shikiOptions属性进行深度定制。 -
注解支持:兼容Shiki的代码注释标记语法,如
[!code highlight]等。 -
渲染回调:提供
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转换器的支持:
-
新增导出:
@rspress/plugin-shiki/transformers现在可以直接导出常用的Shiki转换器。 -
兼容性转换器:新增
transformerCompatibleMetaHighlight转换器,确保代码注释标记在不同环境下的一致性。
技术实现细节
CodeBlockRuntime组件的实现考虑了以下关键点:
-
DOM结构一致性:确保运行时生成的DOM结构与编译时生成的代码块结构完全一致,避免样式和交互上的差异。
-
性能优化:采用懒加载策略,只有在组件进入视口时才执行高亮处理,减少不必要的性能开销。
-
错误处理:内置完善的错误处理机制,当高亮过程出现问题时能够优雅降级。
适用场景
这个新特性特别适合以下场景:
-
动态代码展示:当需要根据用户交互动态展示不同代码片段时。
-
代码编辑器集成:在文档中嵌入可交互的代码编辑器组件。
-
高级代码标注:需要复杂代码高亮和注释的场景。
-
主题切换:在运行时动态切换代码高亮主题。
总结
Rspress v2.0.0-beta.8通过引入CodeBlockRuntime组件,为技术文档的代码展示提供了更大的灵活性。这一改进不仅保留了静态生成的高性能优势,还增加了运行时动态处理的能力,使得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 StartedRust0214
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0138
uni-appA cross-platform framework using Vue.jsJavaScript08
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03