将.d.ts转换为HTML文档

Question

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

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

(注意:我没有.ts文件，只有.d.ts文件)

Answer 1

看看这个nuget项目：

https://github.com/TypeStrong/typedoc

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/