jsdoc 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|---|---|---|---|---|
| @babel/parser | 7.24.4 | 1.8 MB | MIT | prod | |
| @jsdoc/salty | 0.2.8 | 26.1 kB | Apache-2.0 | prod | |
| @types/markdown-it | 12.2.3 | 11.31 kB | MIT | prod peer | |
| bluebird | 3.7.2 | 136.03 kB | MIT | prod | |
| catharsis | 0.9.0 | 64.13 kB | MIT | prod | |
| escape-string-regexp | 2.0.0 | 1.66 kB | MIT | prod | |
| js2xmlparser | 4.0.2 | 14.13 kB | Apache-2.0 | prod | |
| klaw | 3.0.0 | 4.99 kB | MIT | prod | |
| markdown-it-anchor | 8.6.7 | 25.93 kB | Unlicense | prod | |
| markdown-it | 12.3.2 | 146.6 kB | MIT | prod peer | |
| marked | 4.3.0 | 103.63 kB | MIT | prod | |
| mkdirp | 1.0.4 | 6.51 kB | MIT | prod | |
| requizzle | 0.2.4 | 6.59 kB | MIT | prod | |
| strip-json-comments | 3.1.1 | 2.78 kB | MIT | prod | |
| underscore | 1.13.6 | 211.5 kB | MIT | prod |
JSDoc is a popular API documentation generator for JavaScript. It creates comprehensive and easy-to-read documentation for JavaScript codebases, effectively making it simpler for developers to understand the structure, functionalities, and usage of JavaScript components.
To start off using JSDoc, first, you need to install the package. You can install it globally using the following command:
npm install -g jsdoc
Or install it locally in your project:
npm install --save-dev jsdoc
After the successful installation of JSDoc, you can generate documentation from your JavaScript files. If JSDoc was installed locally, use the following command:
./node_modules/.bin/jsdoc yourJavaScriptFile.js
For global installations, this is the command:
jsdoc yourJavaScriptFile.js
By default, the generated documentation will be stored in a directory named out. You can choose a different directory by using the --destination option.
The documentation for JSDoc is available at jsdoc.app. It provides comprehensive information and guidance on how to use JSDoc efficiently, including how to generate and customize your documentation, a list of command-line options, templates and tools created by the community, and much more. Experienced or new users can also contribute to the docs repository at jsdoc/jsdoc.github.io.
