documentation

documentation

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

• Use esprima or acorn to parse JavaScript
• Use doctrine for JSDoc comments and submit patches making it complete
• Prioritize JSON, Markdown, and HTML by default and make other outputs clear and simple to write
• Support browserify mode: documentation as a browserify transform that crawls dependency trees
• Be exhaustively documented internally
• Support coverage mode: report % of exported functions covered and integrate with a badge service to show this on GitHub repos
• Support configurable transforms, compatible with either browserify or browserpack style, to allow for usage of other languages

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.

Changelog

11.0.1 (2019-06-12)

Bug Fixes

• toc with children getting displayed as "note" (#1253) (14298bb)

<a name="11.0.0"></a>