JSDoc
jsdoc.app
- Free plan
- API
- Self-hosted
6.9 Club score Visit jsdoc.app
What the maker publishes
- Code comments
- JSDoc comments begin with `/**` and can use tags to describe code such as constructors and parameters. source
- Command line
- JSDoc accepts source file paths and supports command-line options, with many options also configurable in a configuration file. source
- Configuration
- Configuration files can use JSON or, in supported versions, a CommonJS module exporting a configuration object. source
- Customization
- Users can edit the default template or create a new template for generated documentation. source
- Documentation inputs
- JSDoc can include a Markdown README in generated documentation, which the default template renders in the HTML index page. source
- Documented code
- JSDoc is intended to document APIs, including modules, namespaces, classes, methods, and method parameters. source
- Generated output
- The default template generates HTML pages in an `out/` directory unless a different destination is specified. source
- Input file limits
- By default, JSDoc processes `.js`, `.jsdoc`, and `.jsx` files and ignores files or directories whose names start with an underscore. source
- Installation
- The project README says JSDoc supports stable Node.js versions 8.15.0 and later and can be installed globally or in a project’s `node_modules` folder. source
- Integrations
- The project README lists community templates, Grunt and Gulp plugins, a GitHub Action, and a GitBook integration. source
- License
- The JSDoc generator is free software licensed under Apache License 2.0. source
- Markdown
- The Markdown plugin converts Markdown-formatted text to HTML when enabled in configuration. source
- Markdown
- JSDoc provides a Markdown plugin that can be enabled through its configuration. source
- Output location
- By default, the generated documentation is saved in a directory named out, and the destination can be changed with a command-line option. source
- Plugins
- Plugins can extend JSDoc, and the configuration documentation describes built-in Markdown and summarize plugins. source
- Purpose
- JSDoc is an API documentation generator for JavaScript that scans source code comments and generates an HTML documentation website. source
- Runtime requirement
- The project README says JSDoc supports stable versions of Node.js 8.15.0 and later. source
- Support
- The project README directs users to the JSDoc Users mailing list and Stack Overflow questions tagged `jsdoc` for help. source
- Tags
- JSDoc tags add structured information to documentation comments, such as constructor and parameter details. source
- Templates
- JSDoc uses a built-in default template and allows users to edit it or create a new template. source
- Tutorials
- JSDoc allows tutorials to be included alongside API documentation. source
Checked against the maker's pages on 9 Oct 2026.