JSDoc

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. Seethis 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 atjsdoc/jsdoc.github.io.
• Join JSDoc's Slack channel.
• Ask for help on theJSDoc Users mailing list.
• Post questions tagged

  jsdoc

  toStack Overflow.

License

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

LICENSE

file for more details.