docs(plugin-shiki): add tips for using shiki

vuejs · Apr 21, 2021 · f02bb0a · f02bb0a
1 parent 512acd6
commit f02bb0a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/reference/plugin/shiki.md b/docs/reference/plugin/shiki.md
@@ -4,6 +4,12 @@
 
 This plugin will enable syntax highlighting for markdown code fence with [Shiki](https://shiki.matsu.io/).
 
+::: tip
+[Shiki](https://shiki.matsu.io/) is the syntax highlighter being used by VSCode. It has higher fidelity, but it is slower than [Prism.js](https://prismjs.com/).
+
+You could consider disabling this plugin in `dev` mode to get better development experience.
+:::
+
 ## Options
 
 ### theme

diff --git a/docs/zh/reference/plugin/shiki.md b/docs/zh/reference/plugin/shiki.md
@@ -4,6 +4,12 @@
 
 该插件使用 [Shiki](https://shiki.matsu.io/) 来为 Markdown 代码块启用代码高亮。
 
+::: tip
+[Shiki](https://shiki.matsu.io/) 是 VSCode 正在使用的代码高亮器。它具有更高的保真度，但比 [Prism.js](https://prismjs.com/) 要慢一些，特别是在有大量代码块需要处理的时候。
+
+你可以考虑在 `dev` 模式下禁用该插件来获取更好的开发体验。
+:::
+
 ## 配置项
 
 ### theme