Documentation generator for meteor apps

dkerr · June 9, 2015, 3:02pm

What is the best way to generate documentation for my meteor project? don’t seem to find any packages for doing it.

Any suggestions?

Donnie

robfallows · June 9, 2015, 3:25pm

Are you thinking of automatic generation from JSDoc?

dkerr · June 9, 2015, 3:52pm

yes, something like that. Just don’t know what is out there that might be better for Meteor apps.

Thanks

mizzao · July 9, 2015, 6:19pm

Hi guys,

I’m also trying to figure out the best way to generate documentation for my Meteor packages. These seem to be the main references:

This NPM package: https://github.com/fabienb4/meteor-jsdoc
This internal MDG script which doesn’t seem to be available for general use: https://meteor.hackpad.com/Automatically-Generating-API-Docs-using-JSDoc-EpPmd2iuFEH
This thing, which seems to be aimed at projects instead of packages (confusing me): https://github.com/CodeAdventure/meteor-documentary

Has anyone done this already, and in particular, found ways to support things like ES6, Typescript, and/or Coffeescript? Related: https://github.com/fabienb4/meteor-jsdoc/issues/8

Thanks!

mizzao · July 9, 2015, 6:23pm

I see what’s going on - meteor-jsdoc is just using the scripts that MDG has to render JSDoc output. That seems like the most robust way to go for now. Excellent. - Mr. Burns