JSDoc

Spec sheet

Purpose

JSDoc is an API documentation generator for JavaScript that scans source code comments and generates an HTML documentation website.Read 9 Oct 2026 · jsdoc.app

Integrations

The project README lists community templates, Grunt and Gulp plugins, a GitHub Action, and a GitBook integration.Read 9 Oct 2026 · github.com

Support

The project README directs users to the JSDoc Users mailing list and Stack Overflow questions tagged `jsdoc` for help.Read 9 Oct 2026 · github.com

License

The JSDoc generator is free software licensed under Apache License 2.0.Read 9 Oct 2026 · github.com

Code comments

JSDoc comments begin with `/**` and can use tags to describe code such as constructors and parameters.Read 9 Oct 2026 · jsdoc.app

Command line

JSDoc accepts source file paths and supports command-line options, with many options also configurable in a configuration file.Read 9 Oct 2026 · jsdoc.app

Configuration

Configuration files can use JSON or, in supported versions, a CommonJS module exporting a configuration object.Read 9 Oct 2026 · jsdoc.app

Customization

Users can edit the default template or create a new template for generated documentation.Read 9 Oct 2026 · jsdoc.app

Documentation inputs

JSDoc can include a Markdown README in generated documentation, which the default template renders in the HTML index page.Read 9 Oct 2026 · jsdoc.app

Documented code

JSDoc is intended to document APIs, including modules, namespaces, classes, methods, and method parameters.Read 9 Oct 2026 · jsdoc.app

Generated output

The default template generates HTML pages in an `out/` directory unless a different destination is specified.Read 9 Oct 2026 · jsdoc.app

Input file limits

By default, JSDoc processes `.js`, `.jsdoc`, and `.jsx` files and ignores files or directories whose names start with an underscore.Read 9 Oct 2026 · jsdoc.app

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.Read 9 Oct 2026 · github.com

Markdown

JSDoc provides a Markdown plugin that can be enabled through its configuration.Read 9 Oct 2026 · jsdoc.app

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.Read 9 Oct 2026 · github.com

Plugins

Plugins can extend JSDoc, and the configuration documentation describes built-in Markdown and summarize plugins.Read 9 Oct 2026 · jsdoc.app

Runtime requirement

The project README says JSDoc supports stable versions of Node.js 8.15.0 and later.Read 9 Oct 2026 · github.com

Tags

JSDoc tags add structured information to documentation comments, such as constructor and parameter details.Read 9 Oct 2026 · jsdoc.app

Templates

JSDoc uses a built-in default template and allows users to edit it or create a new template.Read 9 Oct 2026 · jsdoc.app

Tutorials

JSDoc allows tutorials to be included alongside API documentation.Read 9 Oct 2026 · jsdoc.app

Where Specifiction places it

• Documentation Generators#27 of 377.2
• API Documentation Tools#21 of 277.3
• Api Docs#16 of 197.2