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对开发者实际需求做出的又一重要改进。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust098- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
热门内容推荐
项目优选
收起
deepin linux kernel
C
28
16
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
566
98
暂无描述
Dockerfile
707
4.51 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
413
339
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
Ascend Extension for PyTorch
Python
572
694
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.6 K
940
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.42 K
116
AI 将任意文档转换为精美可编辑的 PPTX 演示文稿 — 无需设计基础 | 包含 15 个案例、229 页内容
Python
79
5
暂无简介
Dart
951
235