jsdocをベースにした自動APIドキュメントwikiソリューションを探しています

Question

jsdoc構文で文書化されたJSコードの大きな部分があります。これは内部的なwikiに自動で含めたいものです。

私はコードベースからjsdocでページを自動生成できるwikiソリューションを探しています。

Answer 1

JSDocの組み込み機能を使用して、ソースから生成し、独自のテンプレートを適用することができます。 WIKIから、生成したHTMLページにリンクするだけです。これを自動化するには、cronを使用してJSDocのページジェネレータを毎回実行し、そのテンプレート機能を使用してWikiとまったく同じに見えるようにします。これが私たちの行うことです。 valid-jsdoc：アプリケーションコードがeslintを使用して、有効かつ完全なJSDocのを持っている場合

Answer 2

1. まず私はチェックにお勧めします。生成することができ、有効なJSDocのから

2. ：

   • テンプレート（lodashのようなオプションで値下げ
   • より複雑なDocdashを生成jsdoc
   • シンプルなツールdocdownから、デフォルトのテンプレートジェネレータを使用してください。 comのような）、エクスポートの設定など、それは完全なhtmlを生成します。