documentation

This would be a big one, we would need the whole town to pitch in.

The mission is to create a documentation generation system that's beautiful by default, flexible across formats and styles, and powerful enough to support JSDoc's advanced syntax.

We also have plenty of issues that we'd love help with.

Completed Goals

ES5 and ES6 support of JavaScript, with support for other transpilers a possibility

Using espree, we have support for a wide range of ES6 features.

Support for following dependency trees

Using module-deps, documentation can crawl require() graphs - pointing it to your app's main file will find all referenced files and include all of their documentation.

Future Goals

• Robust and complete JSDoc support, including typedefs.
• Strong support for HTML and Markdown output
• Simple integration with build systems like Makefiles, Gulp, and Grunt
• Documentation coverage, statistics, and validation

Contributing

documentation is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.