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

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

2025-05-20 03:09:15作者:裴锟轩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的高亮能力。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
27
11
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
470
3.48 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
flutter_flutterflutter_flutter
暂无简介
Dart
718
172
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
212
85
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
696
rainbondrainbond
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
15
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1