A documentation generator for TypeScript projects.

TypeDoc 能够将 TypeScript 源码中的注释转换为 HTML 格式的文档或格式化的 JSON 数据。TypeDoc 是可扩展的,并且支持丰富的配置。TypeDoc 还可以作为命令行工具(CLI)或 Node 模块使用。

快速上手

TypeDoc 自身的 API 文档就是用 TypeDoc 生成的,请从导航条上的 API 菜单进入并查看。

如果你已经 安装了 npm,请使用以下命令运行 TypeDoc。

# 安装 TypeDoc
npm install typedoc

# 为你的项目运行 typedoc
npx typedoc src/index.ts

有关跟多高级用法和配置指南,请参阅 安装指南 章节。