Including a README File
There are two ways to incorporate a
README file into your documentation:
README.md. JSDoc will use the first
README.mdfile that it finds in your source paths.
- Run JSDoc with the
-R/--readmecommand-line option, specifying the path to your
READMEfile. This option is available in JSDoc 3.3.0 and later. The
READMEfile may have any name and extension, but it must be in Markdown format.
-R/--readme command-line option takes precedence over your source paths. If you use the
-R/--readme command-line option, JSDoc will ignore any
README.md files in your source paths.
If you are using JSDoc's default template, the
README file's contents will be rendered in HTML
in the generated documentation's