Package Exports
- documentation
- documentation/bin/documentation.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (documentation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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.