Gathering detailed insights and metrics for jsdoc
Gathering detailed insights and metrics for jsdoc
An API documentation generator for JavaScript.
Installations
npm install jsdocDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>=12.0.0
Node Version
12.0.0
NPM Version
6.9.0
Score
93
Supply Chain
97
Quality
76.6
Maintenance
100
Vulnerability
98.9
License
Releases
12
Languages
2
JavaScript
CSS
JavaScript (99.4%)
CSS (0.6%)
Developer
Download Statistics
Total Downloads
454,338,758
Last Day
109,951
Last Week
2,028,732
Last Month
8,435,767
Last Year
106,733,494
GitHub Statistics
Apache-2.0 License
15,295 Stars
3,009 Commits
1,473 Forks
273 Watchers
10 Branches
80 Contributors
Updated on Aug 31, 2025
Maintainers
1
Package Meta Information
Latest Version
4.0.4
Package Id
jsdoc@4.0.4
Unpacked Size
1.46 MB
Size
526.07 kB
File Count
125
NPM Version
6.9.0
Node Version
12.0.0
Published on
Oct 19, 2024
Total Downloads
Cumulative downloads
Total Downloads
454,338,758
Last Day
-2.7%
109,951
Compared to previous day
Last Week
-1.4%
2,028,732
Compared to previous week
Last Month
-16.5%
8,435,767
Compared to previous month
Last Year
-22.4%
106,733,494
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
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's
package.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 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
- jaguarjs-jsdoc
- DocStrap (example)
- jsdoc3Template (example)
- minami
- docdash (example)
- tui-jsdoc-template (example)
- better-docs (example)
Build tools
Other tools
For more information
- 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
jsdocto Stack Overflow.
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
file LICENSE.md in this distribution for more details.
No vulnerabilities found.