Repository files navigation

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please readCONTRIBUTING.md.

JSDoc supports stable versions of Node.js 8.15.0 and later. You can installJSDoc globally or in your project'snode_modules folder.

To install the latest version on npm globally (might requiresudo;learn how to fix this):

npm install -g jsdoc

To install the latest version on npm locally and save it in your package'spackage.json file:

npm install --save-dev jsdoc

Note: By default, npm adds your package using the caret operator in front ofthe version number (for example,^3.6.3). We recommend using the tildeoperator instead (for example,~3.6.3), which limits updates to the mostrecent patch-level version. Seethis Stack Overflow answer formore 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 fileyourJavaScriptFile.js:

./node_modules/.bin/jsdoc yourJavaScriptFile.js

If you installed JSDoc globally, run thejsdoc command:

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory namedout. Youcan use the--destination (-d) option to specify another directory.

Runjsdoc --help for a complete list of command-line options.

The JSDoc community has created templates and other tools to help you generateand customize your documentation. Here are a few of them:

• jaguarjs-jsdoc
• DocStrap(example)
• jsdoc3Template(example)
• minami
• docdash(example)
• tui-jsdoc-template(example)
• better-docs(example)

• JSDoc Grunt plugin
• JSDoc Gulp plugin
• JSDoc GitHub Action

• jsdoc-to-markdown
• Integrating GitBook withJSDoc

• Documentation is available atjsdoc.app.
• Contribute to the docs atjsdoc/jsdoc.github.io.
• Join JSDoc's Slack channel.
• Ask for help on theJSDoc Users mailing list.
• Post questions taggedjsdoc toStack Overflow.

JSDoc is copyright (c) 2011-present Michael Mathewsmicmath@gmail.com andthecontributors to JSDoc.

JSDoc is free software, licensed under the Apache License, Version 2.0. See theLICENSE file for more details.