Включение файла README

Существует два способа включить файл README в вашу документацию:

1. В пути к вашим файлам JavaScript включите путь к файлу Markdown с именем README.md. JSDoc будет использовать первый README.md файл, который найдёт в ваших путях к исходным файлам.
2. Запустите JSDoc с опцией командной строки -R/--readme, указав путь к вашему файлу README. Эта опция доступна в JSDoc 3.3.0 и более поздних версиях. Файл README может иметь любое имя и расширение, но он должен быть в формате Markdown.

Опция командной строки -R/--readme имеет приоритет над вашими путями к исходным файлам. Если вы используете опцию командной строки -R/--readme , JSDoc проигнорирует любые файлы README.md в ваших путях к исходным файлам.

Если вы используете шаблон по умолчанию JSDoc, содержимое файла README будет отображено в HTML в сгенерированном файле документации index.html.

Примеры

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

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