# jsdoc > An API documentation generator for JavaScript. Latest version **4.0.5** (published 2025-10-08) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install jsdoc pnpm add jsdoc yarn add jsdoc bun add jsdoc ``` Provides the command `jsdoc`. ## Health **Score 55/100 (C)** — status: stable. Positive: no vulnerabilities; high maintenance score; popular repo. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 4.0.5 | | Published | 2025-10-08 | | First published | 2011-09-19 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=12.0.0 | | Dependencies | 15 | | Unpacked size | 1.4 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 15463 | | Author | Michael Mathews | | Maintainers | hegemonic | | Keywords | documentation, javascript | ## Links - npm: https://www.npmjs.com/package/jsdoc - Repository: https://github.com/jsdoc/jsdoc - Homepage: https://github.com/jsdoc/jsdoc#readme - Issues: https://github.com/jsdoc/jsdoc/issues - npm.io page: https://npm.io/package/jsdoc ## Dependencies (15) - [klaw](https://npm.io/package/klaw.md) ^3.0.0 - [marked](https://npm.io/package/marked.md) ^4.0.10 - [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4 - [bluebird](https://npm.io/package/bluebird.md) ^3.7.2 - [catharsis](https://npm.io/package/catharsis.md) ^0.9.0 - [requizzle](https://npm.io/package/requizzle.md) ^0.2.3 - [underscore](https://npm.io/package/underscore.md) ~1.13.2 - [markdown-it](https://npm.io/package/markdown-it.md) ^14.1.0 - [@jsdoc/salty](https://npm.io/package/@jsdoc/salty.md) ^0.2.1 - [js2xmlparser](https://npm.io/package/js2xmlparser.md) ^4.0.2 - [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.20.15 - [@types/markdown-it](https://npm.io/package/@types/markdown-it.md) ^14.1.1 - [markdown-it-anchor](https://npm.io/package/markdown-it-anchor.md) ^8.6.7 - [strip-json-comments](https://npm.io/package/strip-json-comments.md) ^3.1.0 - [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^2.0.0 ## Alternatives - [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads - [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads - [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads - [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads - [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads ## Recent versions - 4.0.5 (latest) — 2025-10-08 - 4.0.4 — 2024-10-19 - 4.0.3 — 2024-05-02 - 4.0.2 — 2023-02-19 - 4.0.1 — 2023-02-16 - 4.0.0 — 2022-11-03 - 3.6.11 — 2022-07-20 - 3.6.10 — 2022-01-25 - 3.6.9 — 2022-01-23 - 3.6.8 — 2022-01-22 - 3.6.7 — 2021-05-15 - 3.6.6 — 2020-09-20 - 3.6.5 — 2020-07-22 - 3.6.4 — 2020-04-06 - 3.6.3 — 2019-07-14 - … 37 more at https://npm.io/package/jsdoc/versions ## README # JSDoc [![Build Status](https://travis-ci.org/jsdoc/jsdoc.svg?branch=master)](http://travis-ci.org/jsdoc/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](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)): 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](https://github.com/davidshimjs/jaguarjs-jsdoc) + [DocStrap](https://github.com/docstrap/docstrap) ([example](https://docstrap.github.io/docstrap)) + [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template) ([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots)) + [minami](https://github.com/Nijikokun/minami) + [docdash](https://github.com/clenemt/docdash) ([example](http://clenemt.github.io/docdash/)) + [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template) ([example](https://nhnent.github.io/tui.jsdoc-template/latest/)) + [better-docs](https://github.com/SoftwareBrothers/better-docs) ([example](https://softwarebrothers.github.io/admin-bro-dev/index.html)) ### Build tools + [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc) + [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3) ### Other tools + [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) + [Integrating GitBook with JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3) ## For more information + Documentation is available at [jsdoc.app](https://jsdoc.app/). + Contribute to the docs at [jsdoc/jsdoc.github.io](https://github.com/jsdoc/jsdoc.github.io). + [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/). + Ask for help on the [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users). + Post questions tagged `jsdoc` to [Stack Overflow](http://stackoverflow.com/questions/tagged/jsdoc). ## License JSDoc is copyright (c) 2011-present Michael Mathews and the [contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors). JSDoc is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE.md` in this distribution for more details. --- _Source: https://npm.io/package/jsdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._