npmpackage.info

Gathering detailed insights and metrics for jsdoc

Other packages similar to jsdoc

eslint-plugin-jsdoc

52.0.2

JSDoc linting rules for ESLint.

jsdoc-type-pratt-parser

4.1.0

[![Npm Package](https://badgen.net/npm/v/jsdoc-type-pratt-parser)](https://www.npmjs.com/package/jsdoc-type-pratt-parser) [![Test Status](https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/actions/workflows/test.yml/badge.svg?branch=main)]

@es-joy/jsdoccomment

0.52.0

Maintained replacement for ESLint's deprecated SourceCode#getJSDocComment along with other jsdoc utilities

@jsdoc/salty

0.2.9

A drop-in replacement for (some of) TaffyDB.

Gathering detailed insights and metrics for jsdoc

jsdoc - 4.0.4 | npmpackage.info

jsdoc

An API documentation generator for JavaScript.

4.0.4

15,281

Apache-2.0

JavaScript

1.46 MB

442,037,788

Installations

npm install jsdoc

Developer 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

Supply Chain

Quality

76.8

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

46

Total

492

Closed

209

Merged

237

Issues

Open

402

Total

1,627

Closed

1,225

Releases

JSDoc 4.0.4

4.0.4

Updated on Oct 19, 2024

JSDoc 3.5.5

3.5.5

Updated on Sep 14, 2017

JSDoc 3.5.4

3.5.4

Updated on Aug 04, 2017

JSDoc 3.5.3

3.5.3

Updated on Jul 14, 2017

JSDoc 3.5.2

3.5.2

Updated on Jul 12, 2017

JSDoc 3.5.1

3.5.1

Updated on Jul 10, 2017

View All 12 releases

Languages

JavaScript

CSS

JavaScript (99.4%)

CSS (0.6%)

Developer

jsdoc

Download Statistics

Total Downloads

442,037,788

Last Day

140,076

Last Week

2,428,292

Last Month

10,984,380

Last Year

107,002,425

GitHub Statistics

Apache-2.0 License

15,281 Stars

3,001 Commits

1,470 Forks

273 Watchers

10 Branches

80 Contributors

Updated on Aug 02, 2025

Maintainers

View All 80 Contributors

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

442,037,788

Last Day

-38.5%

140,076

Compared to previous day

Last Week

-1.4%

2,428,292

Compared to previous week

Last Month

7.8%

10,984,380

Compared to previous month

Last Year

-24.3%

107,002,425

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

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

Dev Dependencies

ajv gulp gulp-eslint gulp-json-editor nyc

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

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 file LICENSE.md in this distribution for more details.

No vulnerabilities found.