.d.tsをHTMLドキュメントに変換する

Question

APIのすべての機能に関するドキュメントを含むtypescript宣言ファイル（.d.ts）があります。ドキュメントをウェブサイト（.html）に表示したい。

これを行う方法はありますか？

（注：私は.TSファイルを持っていない、だけ.d.tsファイル）（見栄えの.htmlに.d.ts変換）

Answer 1

このnugetプロジェクトを見てみましょう：

https://github.com/TypeStrong/typedoc

TypeDocは、Node.jsの上で動作し、NPMパッケージとして提供されています。 TypeDocは、通常どおりプロジェクトのディレクトリにインストールすることができます。TypeDocは、TypeDocをグローバルモジュールとしてインストールするとどこからでも呼び出せるバイナリが付いています。実行可能ファイルの名前はtypedocです。

$のNPMはtypedoc --global $ typedoc 使い方をインストール

シェル

TypeDocはtypescriptですコンパイラが受け入れるコマンドライン引数のほとんどを受け入れます。 1つの大きな違いは、個々のファイルの代わりにディレクトリ全体をドキュメントジェネレータに渡すことができる点です。したがって、プロジェクト全体のドキュメントを作成するには、次のように入力します。

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