An API documentation generator for JavaScript.
npm install 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 12.0.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'spackage.json file:
npm install --save-dev jsdoc
To install the latest development version locally, without updating your
project's package.json file:
npm install git+https://github.com/jsdoc/jsdoc.git
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 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.
The JSDoc community has created templates and other tools to help you generate
and 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-to-markdown
+ Integrating GitBook with
JSDoc
+ Documentation is available at jsdoc.app.
+ Contribute to the docs at
jsdoc/jsdoc.github.io.
+ Join JSDoc's Slack channel.
+ Ask for help on the
JSDoc Users mailing list.
+ Post questions tagged jsdoc to
Stack Overflow.
JSDoc is copyright (c) 2011-present Michael Mathews
contributors to JSDoc.
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
file LICENSE.md in this distribution for more details.