README ファイルの追加

ドキュメントに README ファイルを組み込む方法は 2 つあります。

JavaScript ファイルのソースパスに README.md という名前のマークダウンファイルへのパスを含めます。JSDoc はソースパスで見つかった最初の README.md ファイルを使用します。
JSDoc を -R/--readme コマンドラインオプションで実行し、README ファイルへのパスを指定します。このオプションは JSDoc 3.3.0 以降で使用できます。README ファイルは任意の名前と拡張子を持つことができますが、Markdown 形式である必要があります。

-R/--readme コマンドラインオプションはソースパスより優先されます。-R/--readme コマンドラインオプションを使用すると、JSDoc はソースパス内の README.md ファイルを無視します。

JSDoc のデフォルトテンプレートを使用している場合、README ファイルの内容は、生成されたドキュメントの index.html ファイルで HTML としてレンダリングされます。

例

ソースパスに README ファイルを含める

jsdoc path/to/js path/to/readme/README.md

-R/--readme オプションを使用する

jsdoc --readme path/to/readme/README path/to/js