TypeDoc项目中对非支持高亮语言的处理优化
2025-05-28 08:35:21作者:申梦珏Efrain
在文档编写过程中,开发者经常需要在代码块中使用多种编程语言进行示例展示。TypeDoc作为TypeScript项目的文档生成工具,其内置的语法高亮功能主要依赖于Shiki高亮引擎。然而在实际应用中,用户可能会遇到以下典型场景:
- 需要展示Shiki尚未支持的新兴编程语言
- 文档最终会通过其他工具链(如mkdocs)渲染,这些工具支持的语言集合与Shiki不同
- 需要保持原始语言标识符以便后续处理流程使用
最新版本的TypeDoc通过引入ignoredHighlightLanguages配置项解决了这个问题。该选项与现有的highlightLanguages配置相配合,形成了完整的语言处理策略:
highlightLanguages:明确指定需要Shiki进行高亮处理的编程语言ignoredHighlightLanguages:声明需要保留原样输出的语言标识符
这种设计带来了三个显著优势:
- 兼容性提升:允许文档作者使用任意语言标识符,不再受限于Shiki的支持范围
- 流程灵活性:支持将高亮处理推迟到后续构建环节,适应不同的文档工具链
- 渐进增强:不支持的语法块会保持原样输出而不会报错中断
对于插件开发者而言,这个改进特别有价值。以typedoc-plugin-markdown为例,现在可以完整保留用户指定的语言标识符,确保生成的Markdown文件能被下游工具正确解析。这种处理方式也体现了TypeDoc作为文档生成工具的核心设计理念:在保证基础功能的同时,为扩展和定制保留充足的空间。
实际配置示例:
{
"ignoredHighlightLanguages": ["terraform", "hcl"],
"highlightLanguages": ["typescript", "javascript"]
}
这种配置方式既明确了高亮处理边界,又确保了特殊用例的文档可移植性,是TypeDoc对开发者实际需求做出的又一重要改进。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射(O/RM)组件,支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
27
14
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
658
4.26 K
Ascend Extension for PyTorch
Python
503
607
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
939
862
Oohos_react_native
React Native鸿蒙化仓库
JavaScript
334
378
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
390
285
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
123
195
openGauss kernel ~ openGauss is an open source relational database management system
C++
180
258
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
892
昇腾LLM分布式训练框架
Python
142
168