An API documentation generator for JavaScript.
Last updated a year ago by gerhobbelt .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @gerhobbelt/jsdoc 
SYNC missed versions from official npm registry.

JSDoc (75lb derivative)

Build Status

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read CONTRIBUTING.md.


This is a fork of the jsdoc project. It has a couple of things added, namely support for parsing html files. It's used by jsdoc-parse.

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.5.2). We recommend using the tilde operator instead (for example, ~3.5.2), which limits updates to the most recent patch-level version. See this Stack Overflow answer for more information about the caret and tilde operators.

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:


Export JSON

You can easily export JSON result by using haruki template:

jsdoc -r dir  -t templates/haruki -d console 

See detail in templates/haruki

Build tools

Other tools

For more information


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.

Current Tags

  • 4.0.0-2                                ...           latest (a year ago)

2 Versions

  • 4.0.0-2                                ...           a year ago
  • 4.0.0-1                                ...           a year ago
Maintainers (1)
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 2
Last Month 0
Dev Dependencies (8)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |