Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Documentation generator for users #152
A potential user today asked if Yeoman plans on supporting a documentation generator such as Docco.
I'm not sure whether or not this is a little too much to try squeezing in for the first version, but I found the below and thought we could at least discuss whether we want to give people a docs generator of some sort.
jsDoc is good, but it requires Java and Rhino...
jsDuck also looks good. It uses Esprima (which is awesome) and has a Ruby dependency.
If we want a Node.js based doc generator, which we should, there are:
I think we should use Dox. It is popular. Created by the awesome TJ Holowaychuk. And it let's users decide how to show their documentation. It also supports jsDoc tags.
What do you think?
closing this but we documented this for users at https://github.com/yeoman/yeoman/wiki/Additional-FAQ