JSDoc - 是否可以制作一个集成的 html 文档?
JSDoc - Is it possible to make one-integrated-html document?
我用 JSDoc 制作了 Javascript API 文档。
制作完成后,生成的./docs目录就是我制作好的JSDoc文档所在的地方。
但我认为,图标、脚本、样式、每个 .js 文件的 html 个文件......等等,种类繁多。
有没有什么漂亮简单的方法可以将这些文件变成一个集成的 html 文件,比如 Redoc 这是最好的 API 文档工具(对我来说 :-D )?
您可以使用
创建 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
我用 JSDoc 制作了 Javascript API 文档。 制作完成后,生成的./docs目录就是我制作好的JSDoc文档所在的地方。
但我认为,图标、脚本、样式、每个 .js 文件的 html 个文件......等等,种类繁多。
有没有什么漂亮简单的方法可以将这些文件变成一个集成的 html 文件,比如 Redoc 这是最好的 API 文档工具(对我来说 :-D )?
您可以使用
创建 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