Installations

npm install jsdoc

Score

61.9

Supply Chain

97

Quality

80.1

Maintenance

100

Vulnerability

98.2

License

Pull Requests

Open

45

Total

488

Closed

206

Merged

237

Issues

Open

396

Total

1,618

Closed

1,222

Releases

12

JSDoc 4.0.4

4.0.4

Published on 19 Oct 2024

JSDoc 3.5.5

3.5.5

Published on 14 Sept 2017

JSDoc 3.5.4

3.5.4

Published on 04 Aug 2017

JSDoc 3.5.3

3.5.3

Published on 14 Jul 2017

JSDoc 3.5.2

3.5.2

Published on 12 Jul 2017

JSDoc 3.5.1

3.5.1

Published on 10 Jul 2017

View all 12 releases

Developer

jsdoc

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>=12.0.0

Typescript Support

No

Node Version

12.0.0

NPM Version

6.9.0 Statistics

15,065 Stars

2,870 Commits

1,447 Forks

276 Watching

10 Branches

80 Contributors

Updated on 28 Nov 2024

Languages

JavaScript (99.4%)

CSS (0.6%)

Total Downloads

Cumulative downloads

Total Downloads

374,134,418

Last day

-12.5%

412,048

Compared to previous day

Last week

3.2%

2,539,827

Compared to previous week

Last month

20.5%

10,010,867

Compared to previous month

Last year

4.8%

127,381,969

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

15

klaw marked mkdirp bluebird catharsis requizzle underscore markdown-it @jsdoc/salty js2xmlparser @babel/parser @types/markdown-it markdown-it-anchor strip-json-comments escape-string-regexp

Dev Dependencies

5

ajv nyc gulp gulp-eslint gulp-json-editor

Versions

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

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 jsdoc to Stack Overflow.

License

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

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.4

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More