8

I'd like to create an auto generating JSDoc documentation file for a framework I'm building but can't seem to find a way to output the documentation. Is it possible to output the doc to JSON or HTML? Or will I have to build my own JSDoc parser with RegExp?

I've looked all over the web and can't find anything on the subject.

Thank you.

Justin Taddei
  • 2,142
  • 1
  • 16
  • 30
  • 1
    Uhm: *"Once your code is commented, you can use the JSDoc 3 Tool to generate an HTML website from the source. By default, JSDoc will use the "default" template to turn the documentation data into HTML. You can edit this template to suit your own needs, or create an entirely new template if that is what you prefer. `./jsdoc book.js` This command will create a folder named "out" in the current working directory. Within that you will find the generated HTML pages."* http://usejsdoc.org/about-getting-started.html ... seems like you looked all over the web but not the official documentation? – Felix Kling Feb 03 '16 at 16:51
  • Always have a look at the official documentation first. – Felix Kling Feb 03 '16 at 16:57
  • @FelixKling Thank you! I've been looking for the past 3 days... Never found that page. – Justin Taddei Feb 03 '16 at 16:59
  • 4
    The JSDoc documentation is terrible IMO. Kinda funny. – Wayne Bloss Apr 07 '16 at 18:56
  • Try Docma - http://onury.github.io/docma – Onur Yıldırım Jun 11 '16 at 22:00
  • 1
    Strange that there's no information on that jsdoc site, on where to download the actual tool/binary – PandaWood Aug 09 '17 at 00:08
  • since JsDoc3 requires nodeJS, it would be nice if anybody knows an alternative – thestruggleisreal Nov 22 '18 at 14:45
  • I stumbled upon the original question when seeking an example of what the generated HTML looked like after I read [the official JSDoc documentation](https://jsdoc.app/about-getting-started.html#generating-a-website). To anyone who is here for the same reason of looking for an example, Bob's your uncle: [Automate JavaScript API Documentation with JSDoc](https://alligator.io/js/jsdoc/) has examples. – Alain Jan 14 '22 at 03:07

1 Answers1

6

A big thanks to Felix Kling for pointing me the official documentation: usejsdoc.com

The documentation has been moved to https://jsdoc.app/

Infiltrator
  • 1,611
  • 1
  • 16
  • 25
Justin Taddei
  • 2,142
  • 1
  • 16
  • 30
  • 4
    According to [this issue in the jsdoc Github repo](https://github.com/jsdoc/jsdoc/issues/1642), the official documentation has now been moved to https://jsdoc.app/ – peteredhead May 07 '19 at 15:35