2016-10-14 14 views
0

私はjsdocdocdashで始まり、すべてがこれまでのところokだと思われます。しかし、私のモジュールなどがゆっくりと文書化されているにもかかわらず、生成されるindex.htmlファイルに項目を追加する方法がわかりません。ルートHTMLファイルに項目を生成するためにファイルにはどのようなマークアップが必要ですか?JSDocを埋め込むindex.htmlページ

詳細については、左側のナビゲーションペインの上部に「ホーム」リンクがあります。これは私がこの質問をしているときに私が言及しているものです。リンクは基本的に空白のページになりますが、その下にある他のすべてのリンクにコメントの正しい文書があります。

答えて

0

documentationは、これを行う方法がやや誤解を招くことがあります。 README.mdファイルがソースディレクトリ内にある限り、最初に見つかったファイルをindex.htmlファイルとして使用します。これは完全に真実ではありません。また、使用するREADME.mdファイルへのパスを指定する必要があります。

jsdoc -c jsdoc.json --readme ./README.md 
関連する問題