Need help with jsdoc?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

12.3K Stars 1.4K Forks Apache License 2.0 2.3K Commits 384 Opened issues


An API documentation generator for JavaScript.

Services available


Need anything else?

Contributors list


Build status

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read

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


To install the latest version on npm globally (might require

; learn how to fix this):
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 (for example,

). 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 operators.

If you installed JSDoc locally, the JSDoc command-line tool is available in

. To generate documentation for the file
./node_modules/.bin/jsdoc yourJavaScriptFile.js

If you installed JSDoc globally, run the

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named

. You can use the
) option to specify another directory.


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:


Build tools

Other tools

For more information


JSDoc is copyright (c) 2011-present Michael Mathews [email protected] and the contributors to JSDoc.

JSDoc is free software, licensed under the Apache License, Version 2.0. See the

file for more details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.