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 项目来说,这个版本提供了强大的新工具和可能性。
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