jsdoc

by jsdoc

jsdoc /jsdoc

An API documentation generator for JavaScript.

11.1K Stars 1.2K Forks Last release: about 3 years ago (3.5.5) Apache License 2.0 2.1K Commits 113 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.6.3
). We recommend using the tilde operator instead (for example,
~3.6.3
), 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

./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 [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.

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.