jsdoc
    Overview
    Alternatives
    Playground
    Insights & Analysis
    Issues
    Versions
    Documentation
    Find an Expert
    Dependencies
    Career Opportunities
    Code

jsdoc

An API documentation generator for JavaScript.

3.6.3  •  Published 1 month ago  •  by Michael Mathews  •  Apache License 2.0

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.

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 3 is copyright © 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

Dependencies

@babel/parser  ·  bluebird  ·  catharsis  ·  escape-string-regexp  ·  js2xmlparser  ·  klaw  ·  markdown-it  ·  markdown-it-anchor  ·  marked  ·  mkdirp  ·  requizzle  ·  strip-json-comments  ·  taffydb  ·  underscore  ·  ajv  ·  gulp  ·  gulp-eslint  ·  gulp-json-editor  ·  nyc

Tags

documentation
javascript
Get a weekly digest of your favorite packages
We track new versions of your favorite packages, read the changelogs, and summarize them - so you dont have to
Just $5/month per user

Popularity

Weekly Downloads
276.5K
Stars
9.5K

Issues and PRs

Activity

Last ver 1 month ago
Created 8 years ago
Last commit 1 month ago
2 days between commits

Sustainability

63 contributors

Technology

Node version: 8.16.0
1528.2K unpacked

Legal and Compliance

Apache License 2.0
OSI Approved
0 vulnerabilities

Top Experts

Jeff Williams
Maintainer, 899 commits, 100 merges, 18 PRs
Works at Google
micmath
30 merges
jannon
22 merges, 15 PRs
Jeff Williams
19 commits
Renovate Bot
9 commits
Works at renovatebot
mathematicalcoffee
6 commits, 14 PRs