Skip to content

简介


Shiki(式,一个日文词汇,意为 “样式” 是一款美观而强大的语法高亮器,它基于 TextMate 语法及主题,与 VS Code 的语法高亮引擎相同。它能为几乎所有主流编程语言提供非常准确且快速的语法高亮显示。

没有需要维护的自定义正则表达式,没有需要维护的自定义 CSS,也没有需要维护的自定义 HTML;你在 VS Code 中使用的主题一样可以用在 Shiki 上。

哦对了,如你所愿,本文档中的所有代码块都是由 Shiki 高亮的。

功能

演练场

这里有一个小演练场供你尝试如何使用 Shiki 高亮显示你的代码。本文档的其他代码块都是在构建时渲染并静态托管的,而此演练场是在浏览器侧客户端上渲染的,其相关主题和语言按需加载。

Playground

在你的项目中 安装 Shiki

捆绑包大小

你可以在 pkg-size.dev/shiki 上查看详细的捆绑包大小。

截止 v0.9.11,2023 年 12 月 21 日的数据如下:

捆绑包大小(minified)大小(gzip)备注
shiki6.4 MB1.2 MB所有主题和语言的异步块(chunks)
shiki/bundle/full6.4 MB1.2 MBshiki 包相同
shiki/bundle/web3.8 MB695 KB所有主题和常用 Web 语言的异步块
shiki/core100 KB31 KB不带任何主题和语言的核心引擎,需要你自己构建它们
shiki/wasm623 KB231 KB以 BASE64 字符串形式内联的 WASM 二进制文件

以 MIT 许可证发布