documentation.js
A documentation generator for modern JavaScript that infers types and parameters from JSDoc comments.
What is documentation.js?
Documentation.js is a documentation generator for modern JavaScript that parses JSDoc comments to automatically create API documentation. It supports ES2017+, JSX, Vue, and Flow type annotations, inferring parameters and types to reduce manual documentation effort. The tool outputs documentation in multiple formats like HTML, JSON, and Markdown, integrating with GitHub for source code linking.
JavaScript developers and teams who need to generate and maintain API documentation from JSDoc-annotated source code, especially those working with modern JavaScript features and type annotations.
Developers choose Documentation.js for its strong support of modern JavaScript syntax, automatic type inference that minimizes manual work, and flexible output formats that integrate seamlessly with existing workflows and GitHub.
Overview
:book: documentation for modern JavaScript
Use Cases
Best For
- Generating API documentation from JSDoc comments in JavaScript projects
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
