这是什么?
Shiki 是一个用于代码片段的语法高亮工具,基于 TextMate 语法构建,因此分词准确,输出的显示效果也很清晰。
这是我要添加到项目中的库,还是独立的应用程序?
它是一个 JavaScript/TypeScript 库(以 “shiki” 包的形式发布),你通过导入它来以编程方式高亮代码,而不是一个独立应用程序。
我该如何开始使用它来高亮代码?
这段 README 摘录没有给出安装命令,但作为 “shiki” npm 包,你可以用包管理器添加它,并在 JS/TS 中调用其高亮器 API 来渲染高亮代码。
为什么会有单独的 v0-v4 分支?
Shiki 将较旧的大版本(v0 旧版、v1、v2、v3)保留在各自的分支上,而活跃开发则在 v4.x 主分支进行,这样仍在使用旧 API 的用户也能找到对应的文档和修复。
“基于 TextMate 语法”到底是什么意思?
Shiki 使用与 VS Code 高亮功能所用相同的 TextMate 语法对源代码进行分词,因此颜色和分词边界与你在该编辑器中看到的非常接近,而不是采用较简单的基于正则表达式的高亮方式。
Shiki 可以免费用于商业项目吗?
可以,它采用 MIT 许可证,因此可以在商业项目和开源项目中使用,限制很少。
What are similar projects?
prism, MDsveX, woocommerce, microlighter, lollipop-css, editor.md, tui.editor, pug
Which topics is it in?
syntax-highlighting, npm-package, monorepo, ci, javascript-library, testing, browser, documentation, markdown, frontend, tool, nodejs