@use JSDoc

包含 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
使用 -R/--readme 选项
jsdoc --readme path/to/readme/README path/to/js