Want to contribute to JSDoc? Please read
JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's
To install the latest version on npm globally (may require
sudo; learn how to fix
npm install -g jsdoc
To install the latest version on npm locally and save it in your package's
npm install --save-dev jsdoc
Note: By default, npm adds your package using the caret operator in front of the version number
^3.5.2). We recommend using the tilde operator instead (for example,
which limits updates to the most recent patch-level version. See this Stack Overflow
answer for more information about the caret and tilde
To install the latest development version locally, without updating your project's
npm install git+https://github.com/jsdoc3/jsdoc.git
If you installed JSDoc locally, the JSDoc command-line tool is available in
To generate documentation for the file
Or if you installed JSDoc globally, simply run the
By default, the generated documentation is saved in a directory named
out. You can use the
-d) option to specify another directory.
jsdoc --help for a complete list of command-line options.
The JSDoc community has created numerous templates and other tools to help you generate and customize your documentation. Here are just a few:
jsdocto Stack Overflow.
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file
in this distribution for more details.