将 .d.ts 转换为 HTML 文档

Question

我有一个打字稿声明文件 (.d.ts)，其中包含有关 API 每个函数的文档。我想在网站 (.html) 中显示文档。

有没有办法做到这一点？（将 .d.ts 转换为好看的 .html）

（注意：我没有 .ts 文件，只有 .d.ts 文件）

Answer 1

看看这个 nuget 项目：

TypeDoc 在 Node.js 上运行，并作为 NPM 包提供。您可以像平常一样在项目目录中安装 TypeDoc：

$ npm install typedoc --save-dev

与 TypeScript 编译器一样，TypeDoc 附带一个二进制文件，如果您将 TypeDoc 安装为全局模块，则可以从任何地方调用该二进制文件。可执行文件的名称是 typedoc。

$ npm install typedoc --global
$ typedoc

用法

TypeDoc 接受 TypeScript 编译器接受的大多数命令行参数。一个主要区别是，人们可以将整个目录而不是单个文件传递给文档生成器。因此，为了为整个项目创建文档，您只需键入：

$ typedoc --out path/to/documentation/ path/to/typescript/project/

我找不到使用 typedoc 从 d.ts 文件创建文档的方法，没有匹配的 .ts 文件，使用： ``` npx typedoc lib/entity-bundle.d.ts ``` 会导致错误... ``` 警告：无法找到入口点：/Users/gabry/projects/arena-backend/lib/entity-bundle.d.ts 错误：无法找到任何入口点。确保 TypeDoc 可以找到你的 tsconfig ``` (2认同)