Skip to content
An API documentation generator for JavaScript.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add issue and pull-request templates Jul 13, 2017
lib/jsdoc s/Mozilla Parser API/ESTree/ May 12, 2019
plugins Replace old, vendored Jasmine with current npm package. May 12, 2019
templates Remove obsolete README. May 12, 2019
test Remove deprecated `jsdoc/util/error` module. May 12, 2019
.editorconfig add editorconfig Jan 14, 2015
.eslintignore Remove Rhino support Oct 30, 2015
.eslintrc.json switch to new-ish ECMAScript syntax Jan 16, 2019
.gitignore Update .gitignore. May 5, 2019
.npmignore update .npmignore Jul 14, 2017
.travis.yml Parse type applications correctly in Node.js 12. (#1643) May 5, 2019
CHANGES.md Add 3.6.2 changelog. May 12, 2019
CODE_OF_CONDUCT.md add code of conduct Jul 6, 2017
CONTRIBUTING.md Update dependencies, plus the URLs for the GitHub repos and docs. May 4, 2019
LICENSE Replace old, vendored Jasmine with current npm package. May 12, 2019
README.md Update license info in README. May 12, 2019
cli.js Replace old, vendored Jasmine with current npm package. May 12, 2019
conf.json.EXAMPLE look for JSX files by default (#1001) Aug 20, 2015
gulpfile.js Replace most usage of `util` module with template strings. May 12, 2019
jsdoc.js Replace old, vendored Jasmine with current npm package. May 12, 2019
package-lock.json Replace old, vendored Jasmine with current npm package. May 12, 2019
package.json Replace old, vendored Jasmine with current npm package. May 12, 2019

README.md

JSDoc

Build Status

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.5.2). We recommend using the tilde operator instead (for example, ~3.5.2), which limits updates to the most recent patch-level version. See this Stack Overflow answer for more information about the caret and tilde operators.

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 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

Build tools

Other tools

For more information

License

JSDoc is copyright (c) 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.

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

You can’t perform that action at this time.