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

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

2025-06-27 05:55:40作者:何举烈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 支持,进一步提升了文档站点的代码高亮质量和开发体验。这些改进体现了项目对开发者体验的持续关注,同时也为未来的功能扩展奠定了更坚实的基础。对于现有用户,建议仔细阅读迁移指南,特别是代码高亮相关的配置变更,以确保顺利升级。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
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
595
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K