JSDoc - 是否可以制作一个集成的 html 文档？

Question

我用 JSDoc 制作了 Javascript API 文档。 制作完成后，生成了 ./docs 目录，这是我精心制作的 JSDoc 文档所在的位置。

但我认为，每个 .js 文件都有太多不同的文件，例如图标、脚本、样式、html 文件......等等

有没有什么漂亮简单的方法可以将这些文件制作成一个集成的 html 文件，例如 Redoc，它是最好的 API 文档工具（对我来说 :-D）？

Answer 1

您可以使用以下方式创建 api 文档

https://www.npmjs.com/package/swagger-jsdoc

它将接收所有包含 jsdoc 注释的 JavaScript 文件，并将它们转换为 swagger api 文档。

唯一需要注意的是，您的 jsdoc 设置需要支持 swagger 规范才能正常工作

这里是 jsdoc 设置示例的入门

https://github.com/Surnet/swagger-jsdoc/blob/master/docs/GETTING-STARTED.md

Answer 2

您必须对 tmpl 和publish.js 文件进行一些更改才能生成单个 html 文件

1. 示例：- 使用 docdash 模板修改这些文件。
2. 在 jsdoc.json 模板中：{'使用项目目录中的自定义模板'}