Gathering detailed insights and metrics for jsdoc
Gathering detailed insights and metrics for jsdoc
Gathering detailed insights and metrics for jsdoc
Gathering detailed insights and metrics for jsdoc
npm install jsdoc
Module System
Unable to determine the module system for this package.
Min. Node Version
Typescript Support
Node Version
NPM Version
15,065 Stars
2,870 Commits
1,447 Forks
276 Watching
10 Branches
80 Contributors
Updated on 28 Nov 2024
JavaScript (99.4%)
CSS (0.6%)
Cumulative downloads
Total Downloads
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
An API documentation generator for JavaScript.
Want to contribute to JSDoc? Please read CONTRIBUTING.md
.
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.
The JSDoc community has created templates and other tools to help you generate and customize your documentation. Here are a few of them:
jsdoc
to
Stack Overflow.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
LICENSE
file for more details.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
0 existing vulnerabilities detected
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no SAST tool detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
security policy file not detected
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Score
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