首页 > 解决方案 > JSDoc - 是否可以制作一个集成的 html 文档?

问题描述

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

但我认为,每个 .js 文件的图标、脚本、样式、html 文件......等文件种类繁多,种类繁多。

有没有任何漂亮简单的方法可以将这些文件制作成一个集成的 html 文件,比如Redoc,这是最好的 API 文档工具(对我来说 :-D)?

标签: javascriptdocumentationjsdoc

解决方案


您可以使用创建 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


推荐阅读