This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
jsdoc with all
npm packages installed. Try it out:
jsdoc lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
Want to contribute to JSDoc? Please read
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
JSDoc globally or in your project's
To install the latest version on npm globally (might require
learn how to fix this):
npm install -g jsdoc
To install the latest version on npm locally and save it in your package's
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.
To install the latest development version locally, without updating your
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
If you installed JSDoc globally, run the
By default, the generated documentation is saved in a directory named
can use the
-d) option to specify another directory.
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:
jsdocto Stack Overflow.
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
LICENSE.md in this distribution for more details.