首页
/ Rspress v2.0.0-beta.5 发布:全面拥抱 Shiki 代码高亮与 JSON Schema 支持

Rspress v2.0.0-beta.5 发布:全面拥抱 Shiki 代码高亮与 JSON Schema 支持

2025-06-27 18:20:35作者:何举烈Damon

Rspress 是一个现代化的静态站点生成器,专为技术文档和博客设计。它基于 React 和 Rust 构建,提供了出色的性能和开发体验。最新发布的 v2.0.0-beta.5 版本带来了两项重要改进:默认使用 Shiki 进行代码高亮,以及为 _meta.json 文件提供 JSON Schema 支持。

全面转向 Shiki 代码高亮

在这个版本中,Rspress 做出了一个重大架构决策:完全弃用 Prism.js,转而采用 Shiki 作为默认的代码高亮解决方案。这一变化带来了几个显著优势:

  1. 更精确的语法高亮:Shiki 使用 TextMate 语法,能够提供与 VS Code 完全一致的代码高亮效果
  2. 编译时处理:所有代码高亮都在构建阶段完成,减少了客户端运行时负担
  3. 丰富的转换器支持:通过 Shiki 的转换器系统,可以轻松实现行号、差异高亮等高级功能

迁移到 Shiki 后,开发者需要注意语法上的变化。例如,原先通过插件实现的代码行号和高亮功能,现在可以直接通过配置项实现:

import { defineConfig } from 'rspress/config';
import { transformerNotationDiff } from '@shikijs/transformers';

export default defineConfig({
  markdown: {
    showLineNumber: true,
    shiki: {
      transformers: [
        transformerNotationDiff(),
      ],
    }
  }
});

这种配置方式更加直观和模块化,开发者可以根据需要灵活组合各种转换器。

_meta.json 的 JSON Schema 支持

另一个重要改进是为 _meta.json 文件提供了 JSON Schema 支持。这个文件在 Rspress 中用于定义文档的元数据和组织结构。现在,开发者可以在支持 JSON Schema 的编辑器中获得智能提示和验证功能。

在 VS Code 中,只需简单配置即可启用这一功能:

{
  "json.schemas": [
    {
      "fileMatch": ["**/_meta.json"],
      "url": "./node_modules/rspress/meta-json-schema.json"
    }
  ]
}

这一改进显著提升了开发体验,减少了因配置错误导致的问题,同时也让新用户更容易理解 _meta.json 文件的结构和可用选项。

其他改进

除了上述两项主要改进外,这个版本还包含了一些细节优化:

  1. 动态目录组件现在会智能跳过 <a> 标签元素,避免在目录中显示不必要的链接
  2. 新增了 .rspress-toc-exclude 类名作为逃生舱口,允许开发者精确控制哪些元素不应出现在目录中
  3. 文档搜索功能针对暗黑模式进行了优化,提升了视觉体验

总结

Rspress v2.0.0-beta.5 通过全面采用 Shiki 和提供 JSON Schema 支持,进一步提升了文档站点的代码高亮质量和开发体验。这些改进体现了项目对开发者体验的持续关注,同时也为未来的功能扩展奠定了更坚实的基础。对于现有用户,建议仔细阅读迁移指南,特别是代码高亮相关的配置变更,以确保顺利升级。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8