首页
/ TypeDoc项目中对非支持高亮语言的处理优化

TypeDoc项目中对非支持高亮语言的处理优化

2025-05-28 16:08:42作者:申梦珏Efrain

在文档编写过程中,开发者经常需要在代码块中使用多种编程语言进行示例展示。TypeDoc作为TypeScript项目的文档生成工具,其内置的语法高亮功能主要依赖于Shiki高亮引擎。然而在实际应用中,用户可能会遇到以下典型场景:

  1. 需要展示Shiki尚未支持的新兴编程语言
  2. 文档最终会通过其他工具链(如mkdocs)渲染,这些工具支持的语言集合与Shiki不同
  3. 需要保持原始语言标识符以便后续处理流程使用

最新版本的TypeDoc通过引入ignoredHighlightLanguages配置项解决了这个问题。该选项与现有的highlightLanguages配置相配合,形成了完整的语言处理策略:

  • highlightLanguages:明确指定需要Shiki进行高亮处理的编程语言
  • ignoredHighlightLanguages:声明需要保留原样输出的语言标识符

这种设计带来了三个显著优势:

  1. 兼容性提升:允许文档作者使用任意语言标识符,不再受限于Shiki的支持范围
  2. 流程灵活性:支持将高亮处理推迟到后续构建环节,适应不同的文档工具链
  3. 渐进增强:不支持的语法块会保持原样输出而不会报错中断

对于插件开发者而言,这个改进特别有价值。以typedoc-plugin-markdown为例,现在可以完整保留用户指定的语言标识符,确保生成的Markdown文件能被下游工具正确解析。这种处理方式也体现了TypeDoc作为文档生成工具的核心设计理念:在保证基础功能的同时,为扩展和定制保留充足的空间。

实际配置示例:

{
  "ignoredHighlightLanguages": ["terraform", "hcl"],
  "highlightLanguages": ["typescript", "javascript"]
}

这种配置方式既明确了高亮处理边界,又确保了特殊用例的文档可移植性,是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
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K