首页
/ TypeDoc 0.27版本中Shiki语法高亮语言配置变更解析

TypeDoc 0.27版本中Shiki语法高亮语言配置变更解析

2025-05-28 20:21:10作者:柏廷章Berta

在TypeDoc 0.27版本中,用户在使用语法高亮功能时可能会遇到一个配置问题。本文将详细解析这个变更的背景、影响以及解决方案。

问题背景

TypeDoc是一个用于TypeScript项目的文档生成工具,它使用Shiki作为语法高亮引擎。在0.27版本中,TypeDoc内部集成了mini-shiki作为Shiki的替代实现,旨在提供完全兼容的功能。

配置变更细节

在之前的版本中,TypeDoc默认支持的语法高亮语言包括"bash"和"console"。然而,在0.27版本中,当用户显式配置highlightLanguages选项并包含这两个语言时,会出现配置验证错误。

技术原因分析

经过深入调查发现,这个问题源于TypeDoc的选项验证逻辑。验证器原本设计为只允许非别名语言,这导致"bash"和"console"虽然实际上可以被mini-shiki正确处理,但在配置验证阶段会被拒绝。

解决方案

开发者已经修复了这个问题,现在允许使用所有有效的语言标识符,包括别名。对于用户来说,这意味着:

  1. 可以继续在配置中使用"bash"和"console"
  2. 不需要特别处理这两个语言的配置
  3. 所有其他语言的语法高亮功能保持不变

最佳实践建议

对于TypeDoc用户,我们建议:

  1. 更新到最新版本以获得最稳定的体验
  2. 如果遇到类似问题,可以检查配置验证逻辑
  3. 了解TypeDoc的默认配置行为,避免不必要的显式配置

这个变更体现了TypeDoc团队对用户体验的持续改进,确保了工具的稳定性和兼容性。

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

热门内容推荐

项目优选

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