TypeDoc

TypeScript项目的文档生成器。

文档

有关更详细的文档、更新日志以及使用TypeDoc渲染的TypeDoc文档，请访问 https://typedoc.org。

安装

TypeDoc运行在Node.js上，可作为NPM包使用。

npm install typedoc --save-dev

使用方法

要生成文档，TypeDoc需要知道你的项目入口点和TypeScript编译器选项。它会自动尝试查找你的tsconfig.json文件，所以你只需指定库的入口点即可：

typedoc src/index.ts

如果你有多个入口点，请分别指定每个入口点。

typedoc package1/index.ts package2/index.ts

如果你指定一个目录，TypeDoc将使用entryPointStrategy选项来决定如何解析它。默认情况下，TypeDoc将在该目录下搜索名为index的文件。

单体仓库 / 工作区

如果你的代码库由一个或多个npm包组成，你可以为每个包单独构建文档，然后通过设置entryPointStrategy为packages将结果合并到一个站点中。在这种模式下，TypeDoc需要在每个目录中提供配置来指定入口点。有关示例设置，请参见 https://github.com/Gerrit0/typedoc-packages-example

参数

有关命令行参数的完整列表，请运行typedoc --help或访问我们的网站。

• --out <文档输出路径/>
  指定文档应该写入的位置。默认为./docs
• --json <输出路径/output.json>
  指定描述项目的json文件的位置和文件名。指定此选项时，除非同时指定了--out，否则不会生成文档。
• --options
  指定应该加载的json选项文件。如果未指定，TypeDoc将在当前目录中查找'typedoc.json'。
• --tsconfig <tsconfig.json路径>
  指定应该加载的typescript配置文件。如果未指定，TypeDoc将在当前目录中查找'tsconfig.json'。
• --exclude <模式>
  当提供路径作为源时，使用给定的模式排除文件。支持标准的minimatch模式。

主题

• --theme <default|插件定义的主题>
  指定应该使用的主题。
• --name <文档标题>
  设置将在模板头部使用的项目名称。
• --readme <readme路径|none>
  应该在索引页面显示的readme文件的路径。传递none可禁用索引页面，并从全局页面开始文档。

其他

• --version
  显示TypeDoc的版本号。
• --help
  显示所有TypeDoc选项。

贡献

本项目由开发者社区维护。欢迎并感谢贡献。 你可以在GitHub上找到TypeDoc；随时打开问题或创建拉取请求： https://github.com/TypeStrong/typedoc

更多信息，请阅读贡献指南。