TypeDoc 0.26 版本新特性解析:文档扩展与国际化支持
TypeDoc 作为 TypeScript 项目的文档生成工具,在其最新的 0.26 版本中带来了两项重大功能更新:外部 Markdown 页面支持和国际化本地化能力。这些改进显著提升了文档编写的灵活性和可用性,让开发者能够创建更加丰富和完善的项目文档。
外部 Markdown 页面支持
长期以来,开发者一直期待 TypeDoc 能够支持除项目 README 之外的其他 Markdown 文档。0.26 版本终于实现了这一功能,解决了项目文档扩展性的关键需求。
项目级文档
通过新增的 --projectDocuments
选项,开发者可以添加项目级别的文档。这些文档将作为根反射对象的子项显示,非常适合添加项目使用指南、教程等顶层文档内容。
反射级文档
开发者现在可以在声明中使用 @document
标签来关联特定的 Markdown 文档。这些文档会作为对应声明的子项显示,适用于提供与特定 API 相关的详细说明文档。
文档元数据
Markdown 文档支持 YAML 格式的前言元数据,可以设置以下属性:
title
:设置文档显示名称group
和category
:功能类似于常规反射上的@group
和@category
标签
文档结构可以通过在标题中使用斜杠(/)来创建层级关系,例如"Guides/Getting Started"会自动创建嵌套的文档结构。
国际化支持
TypeDoc 0.26 首次引入了完整的国际化架构,支持将界面文本和日志消息翻译成不同语言。这一改进为全球开发者提供了更好的本地化体验,使非英语用户能够更方便地使用工具和阅读生成的文档。
其他重要改进
-
性能优化:通过新增的
highlightLanguages
选项限制加载的语法高亮语言,减少了约150ms的渲染时间。 -
文档组织:支持通过
--sortEntryPoints
选项控制文档排序,确保重要文档能够按预期顺序显示。 -
代码质量:移除了已弃用的
--media
、--includes
和--stripYamlFrontmatter
选项,简化了配置。 -
渲染优化:只有当"Type Declaration"部分能提供额外信息时才会渲染,避免了重复内容的显示。
-
错误处理:在运行结束后会显示警告/错误的汇总信息,方便开发者快速定位问题。
升级注意事项
-
移除了对 Node 16 的支持,请确保使用更新的 Node 版本。
-
将 Markdown 解析引擎从 marked 迁移到了 markdown-it,这可能会影响某些特殊 Markdown 语法的渲染结果。
-
更新了 Shiki 语法高亮引擎到 1.x 版本,虽然增加了支持的语言和主题,但也带来了轻微的性能影响。
TypeDoc 0.26 的这些改进显著提升了文档编写的灵活性和用户体验,使开发者能够创建更加结构化和国际化的项目文档。对于需要丰富文档内容的 TypeScript 项目来说,这个版本提供了强大的新工具和可能性。
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选









