jsdoc/jsdoc


An API documentation generator for JavaScript.

https://jsdoc.app/

License: Apache-2.0

Language: JavaScript

Keywords: api, docs, documentation, javascript, jsdoc


JSDoc

Build Status

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 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.

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

License

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.

Project Statistics

Sourcerank 21
Repository Size 17.2 MB
Stars 10,095
Forks 1,147
Watchers 281
Open issues 281
Dependencies 918
Contributors 88
Tags 93
Created
Last updated
Last pushed

Top Contributors See all

Jeff Williams Michael Mathews mathematicalcoffee Renovate Bot Jannon Frank Rafał Wrzeszcz Ben Blank Matthew Kastor Tim Schaub Lea Hayes Ernst Haagsman Rotorz Limited Konstantin Pozin MinHyeong Kim Phasmal Peter Droogmans Dominic Chambers Rob Taylor Bob Kerns Nick Schonning

Packages Referencing this Repo

@jsdoc/test-matchers
Jasmine matchers that JSDoc uses in its tests.
Latest release 0.1.3 - Updated - 10.1K stars
@jsdoc/task-runner
Task runner for JSDoc templates.
Latest release 0.1.4 - Updated - 10.1K stars
@jsdoc/core
Core functionality for JSDoc.
Latest release 0.2.1 - Updated - 10.1K stars
jsdoc-import-typedef
An API documentation generator for JavaScript.
Latest release 4.0.0-dev - Published - 10.1K stars
@textile/jsdoc
An API documentation generator for JavaScript.
Latest release 3.5.6 - Updated - 10.1K stars
jsdoc-modified
An API documentation generator for JavaScript.
Latest release 0.0.2 - Published - 10.1K stars
@visallo/jsdoc
An API documentation generator for JavaScript.
Latest release 3.5.5 - Published - 10.1K stars
org.webjars.npm:jsdoc
WebJar for jsdoc
Latest release 3.5.5 - Published - 10.1K stars
funjsdoc
An API documentation generator for JavaScript.
Latest release 4.0.0 - Published - 10.1K stars
@terraswarm/jsdoc
An API documentation generator for JavaScript.
Latest release 3.5.0-dev - Updated - 10.1K stars
jsdoc-TENSOR
An API documentation generator for JavaScript.
Latest release 3.3.0-dev - Published - 10.1K stars
jsdoc3
Official documentation for JSDoc 3.
Latest release 3.5.5 - Published - 10.1K stars
jsdoc-fork
An API documentation generator for JavaScript.
Latest release 4.0.0-beta.1 - Published - 10.1K stars
fr.mastah.maven.plugin:jsdoc3-maven-plugin
Used to generate JSDoc3 documentation of javascript files
Latest release 1.0.13 - Updated - 10.1K stars
jsdoc-patched
An API documentation generator for JavaScript.
Latest release 3.3.0-dev - Published - 10.1K stars
jsdoc
An API documentation generator for JavaScript.
Latest release 3.6.3 - Updated - 10.1K stars
jsdoc3
An API documentation generator for JavaScript.
Latest release @jsdoc/core@0.2.1 - Published - 10.1K stars
jsdoc
An API documentation generator for JavaScript.
Latest release @jsdoc/core@0.2.1 - Published - 10.1K stars
@jsdoc/cli
Command-line tool for JSDoc.
Latest release 0.1.0 - Published - 10.1K stars
@maple-leaf/jsdoc
An API documentation generator for JavaScript.
Latest release 3.6.0-dev5 - Updated - 10.1K stars

Recent Tags See all

@jsdoc/core@0.2.1 December 09, 2019
@jsdoc/core@0.2.0 December 09, 2019
@jsdoc/cli@0.1.0 December 09, 2019
@jsdoc/bus@0.1.0 December 09, 2019
jsdoc@4.0.0-dev.8 December 09, 2019
jsdoc@4.0.0-dev.8 December 09, 2019
@jsdoc/core@0.1.11 December 08, 2019
jsdoc@4.0.0-dev.7 December 08, 2019
@jsdoc/test-matchers@0.1.3 December 07, 2019
@jsdoc/test-matchers@0.1.3 December 07, 2019
@jsdoc/task-runner@0.1.4 December 07, 2019
@jsdoc/eslint-config@1.1.2 December 07, 2019
@jsdoc/core@0.1.10 December 07, 2019
jsdoc@4.0.0-dev.6 December 07, 2019
@jsdoc/test-matchers@0.1.2 October 12, 2019

Interesting Forks See all

jsdoc2md/jsdoc
a jsdoc fork customised for jsdoc2md
JavaScript - Other - Last pushed - 1 stars - 1 forks
KaycoinsInc/jsdoc
An API documentation generator for JavaScript.
Apache-2.0 - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-12-09 03:01:33 UTC

Login to resync this repository