首页
/ Shiki高亮引擎中自定义主题与语言加载的注意事项

Shiki高亮引擎中自定义主题与语言加载的注意事项

2025-05-20 08:19:04作者:裴锟轩Denise

在使用Shiki代码高亮引擎时,开发者可能会遇到一个常见问题:当切换到自定义主题后,原先可用的语言高亮功能突然失效。这种现象背后反映了Shiki引擎从1.0版本开始的一项重要架构变更。

核心机制解析

在Shiki的早期版本中,引擎默认会加载所有支持的语言包。但在1.0版本后,出于性能优化的考虑,Shiki改为按需加载机制。这意味着:

  1. 显式声明原则:所有需要使用的语言都必须明确声明
  2. 资源隔离:主题加载和语言加载成为两个独立的配置维度
  3. 按需加载:只加载实际需要的语言资源,减少初始包体积

典型问题场景

开发者从文档中复制自定义主题示例时,常忽略语言配置项:

const highlighter = await getHighlighter({
  themes: [myTheme] // 仅配置主题,未声明语言
});

此时尝试高亮JavaScript代码就会触发Language not found错误,因为引擎没有加载任何语言支持。

解决方案

方案一:完整加载(适合开发环境)

import { bundledLanguages, getHighlighter } from 'shiki';

const highlighter = await getHighlighter({
  themes: [myTheme],
  langs: Object.keys(bundledLanguages) // 加载所有语言
});

方案二:按需加载(适合生产环境)

const highlighter = await getHighlighter({
  themes: [myTheme],
  langs: ['javascript', 'typescript'] // 仅加载必要语言
});

方案三:Node环境快捷方式

在Node.js运行时环境下,可以使用自动化加载的简写形式:

const highlighter = await getHighlighter({
  theme: 'nord' // 自动加载对应语言
});

最佳实践建议

  1. 开发阶段可以使用完整加载模式快速验证
  2. 生产环境建议精确声明需要的语言
  3. 自定义主题时务必同步考虑语言依赖
  4. 对于SSR应用,注意服务端和客户端的语言包一致性

理解这一机制后,开发者就能更好地平衡功能完整性和性能优化,充分发挥Shiki的高亮能力。

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

热门内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5