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

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

2025-05-28 04:28:05作者:申梦珏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对开发者实际需求做出的又一重要改进。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
203
2.18 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
62
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
84
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133