+1
Daily
15,474
stars
1,489
forks
268
watchers
517
prs
1,639
issues
12
releases
README
JSDoc
!Build status
An API documentation generator for JavaScript.
Want to contribute to JSDoc? Please read CONTRIBUTING.md.
Installation and Usage
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
JSDoc globally or in your project's node_modules folder.
To install the latest version on npm globally (might require sudo;
learn how to fix this):
npm install -g jsdoc
To install the latest version on npm locally and save it in your package's
package.json file:
npm install --save-dev jsdoc
Note: By default, npm adds your package using the caret operator in front of
the version number (for example, ^3.6.3). We recommend using the tilde
operator instead (for example, ~3.6.3), which limits updates to the most
recent patch-level version. See
this Stack Overflow answer for
more information about the caret and tilde operators.
If you installed JSDoc locally, the JSDoc command-line tool is available in
./node_modules/.bin. To generate documentation for the file
yourJavaScriptFile.js:
./node_modules/.bin/jsdoc yourJavaScriptFile.js
If you installed JSDoc globally, run the jsdoc command:
jsdoc yourJavaScriptFile.js
By default, the generated documentation is saved in a directory named out. You
can use the --destination (-d) option to specify another directory.
Run jsdoc --help for a complete list of command-line options.
Templates and tools
The JSDoc community has created templates and other tools to help you generate
and customize your documentation. Here are a few of them:
Templates
- jaguarjs-jsdoc
- DocStrap
(example)
- jsdoc3Template
(example)
- minami
- docdash
(example)
- tui-jsdoc-template
(example)
- better-docs
(example)
Build tools
- JSDoc Grunt plugin
- JSDoc Gulp plugin
- JSDoc GitHub Action
Other tools
- jsdoc-to-markdown
- Integrating GitBook with
JSDoc
For more information
- Documentation is available at jsdoc.app.
- Contribute to the docs at
jsdoc/jsdoc.github.io.
- Ask for help on the
JSDoc Users mailing list.
- Post questions tagged jsdoc to
Stack Overflow.
License
JSDoc is copyright (c) 2011-present Michael Mathews and
the contributors to JSDoc.
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
LICENSE file for more details.Top issues
#509Feature: Documenting Promises97 comments · 2013-10-28#1286Support for curried functions52 comments · 2016-10-21#1349Document class types/constructor types42 comments · 2017-04-19#1199How to extend a typedef parameter in JSDOC?39 comments · 2016-04-20#1132"Export default class" doesn't work as expected29 comments · 2015-12-22#1468How to document @property having spaces in name21 comments · 2017-10-28#1136Documenting large apps, group modules into @categories19 comments · 2016-01-02#241Add option to report undocumented objects18 comments · 2012-10-26
Latest release
JSDoc 4.0.4 4.0.4 2024-10-19Fixes a compatibility issue with Node.js 23.