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

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

2025-05-28 09:22:53作者:柏廷章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团队对用户体验的持续改进,确保了工具的稳定性和兼容性。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8