首页
/ TypeDoc 0.26 版本新特性解析:文档扩展与国际化支持

TypeDoc 0.26 版本新特性解析:文档扩展与国际化支持

2025-05-29 19:03:52作者:伍希望

TypeDoc 作为 TypeScript 项目的文档生成工具,在其最新的 0.26 版本中带来了两项重大功能更新:外部 Markdown 页面支持和国际化本地化能力。这些改进显著提升了文档编写的灵活性和可用性,让开发者能够创建更加丰富和完善的项目文档。

外部 Markdown 页面支持

长期以来,开发者一直期待 TypeDoc 能够支持除项目 README 之外的其他 Markdown 文档。0.26 版本终于实现了这一功能,解决了项目文档扩展性的关键需求。

项目级文档

通过新增的 --projectDocuments 选项,开发者可以添加项目级别的文档。这些文档将作为根反射对象的子项显示,非常适合添加项目使用指南、教程等顶层文档内容。

反射级文档

开发者现在可以在声明中使用 @document 标签来关联特定的 Markdown 文档。这些文档会作为对应声明的子项显示,适用于提供与特定 API 相关的详细说明文档。

文档元数据

Markdown 文档支持 YAML 格式的前言元数据,可以设置以下属性:

  • title:设置文档显示名称
  • groupcategory:功能类似于常规反射上的 @group@category 标签

文档结构可以通过在标题中使用斜杠(/)来创建层级关系,例如"Guides/Getting Started"会自动创建嵌套的文档结构。

国际化支持

TypeDoc 0.26 首次引入了完整的国际化架构,支持将界面文本和日志消息翻译成不同语言。这一改进为全球开发者提供了更好的本地化体验,使非英语用户能够更方便地使用工具和阅读生成的文档。

其他重要改进

  1. 性能优化:通过新增的 highlightLanguages 选项限制加载的语法高亮语言,减少了约150ms的渲染时间。

  2. 文档组织:支持通过 --sortEntryPoints 选项控制文档排序,确保重要文档能够按预期顺序显示。

  3. 代码质量:移除了已弃用的 --media--includes--stripYamlFrontmatter 选项,简化了配置。

  4. 渲染优化:只有当"Type Declaration"部分能提供额外信息时才会渲染,避免了重复内容的显示。

  5. 错误处理:在运行结束后会显示警告/错误的汇总信息,方便开发者快速定位问题。

升级注意事项

  1. 移除了对 Node 16 的支持,请确保使用更新的 Node 版本。

  2. 将 Markdown 解析引擎从 marked 迁移到了 markdown-it,这可能会影响某些特殊 Markdown 语法的渲染结果。

  3. 更新了 Shiki 语法高亮引擎到 1.x 版本,虽然增加了支持的语言和主题,但也带来了轻微的性能影响。

TypeDoc 0.26 的这些改进显著提升了文档编写的灵活性和用户体验,使开发者能够创建更加结构化和国际化的项目文档。对于需要丰富文档内容的 TypeScript 项目来说,这个版本提供了强大的新工具和可能性。

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

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
595
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K