引入README文件

将 README 文件合并到文档中有两种方法:

1. 在JavaScript文件的源路径中, 包含名为 README.md 的Markdown文件的路径. JSDoc将使用它在源路径中找到的第一个 README.md 文件.

2. 使用 -R/--readme 命令行选项运行JSDoc, 指定 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

Using the -R/–readme option

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