Search code examples
javascriptdocumentationjsdoc

JSDoc - Is it possible to make one-integrated-html document?

I made my Javascript API document with JSDoc. After made them, the directory ./docs generated where my well-made JSDoc document is in.

But I think, there are too diverse and various files like icons, scripts, styles, html files for each .js file..... etc.

Is there any beautiful-simple way to make these files into one-integrated-html files like Redoc which is the best API documentation tool (for me :-D)?

Solution

  • You can create api docs by using

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

    It will take in all your JavaScript files that have the jsdoc comments in them and convert them to a swagger api docs.

    The only caveat is that your jsdoc setup needs to support the swagger spec to work properly

    Here is the getting started for examples on the jsdoc setup

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