documentation

14.0.3 • Public • Published

The documentation system for modern JavaScript

Circle CI npm version Gitter Inline docs

📅 Current maintenance status

  • Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations.
  • Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
  • Integrates with GitHub to link directly from documentation to the code it refers to.
  • Customizable output: HTML, JSON, Markdown, and more

Examples

Documentation

User Guide

Globally install documentation using the npm package manager:

$ npm install -g documentation

This installs a command called documentation in your path, that you can point at JSDoc-annotated source code to generate human-readable documentation. First, run documentation with the --help option for help:

Usage:

# generate markdown docs for index.js and files it references
documentation build index.js -f md

# generate html docs for all files in src, and include links to source files in github
documentation build src/** -f html --github -o docs

# document index.js, ignoring any files it requires or imports
documentation build index.js -f md --shallow

# validate JSDoc syntax in util.js
documentation lint util.js

# update the API section of README.md with docs from index.js
documentation readme index.js --section=API

# build docs for all values exported by index.js
documentation build --document-exported index.js

# build html docs for a TypeScript project
documentation build index.ts --parse-extension ts -f html -o docs

Commands:
  build [input..]   build documentation
  lint [input..]    check for common style and uniformity mistakes
  readme [input..]  inject documentation into your README.md

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Contributing

We have plenty of issues that we'd love help with.

  • Robust and complete JSDoc support, including typedefs.
  • Strong support for HTML and Markdown output
  • Documentation coverage, statistics, and validation

documentation is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
14.0.336,787latest
14.0.0-alpha.153alpha
10.0.0-alpha.02prerelease

Version History

VersionDownloads (Last 7 Days)Published
14.0.336,787
14.0.212,604
14.0.119,629
14.0.02,517
14.0.0-alpha.153
14.0.0-alpha.04
13.2.532,367
13.2.410
13.2.32
13.2.23
13.2.1331
13.2.0156
13.1.11,534
13.1.04,349
13.0.21,932
13.0.1337
13.0.0787
12.3.09,889
12.2.0297
12.1.44,648
12.1.3219
12.1.2523
12.1.1687
12.1.079
12.0.3442
12.0.235
12.0.124
12.0.0332
11.0.12,988
11.0.0242
10.1.0713
10.0.0303
10.0.0-alpha.02
9.3.15,901
9.3.0939
9.2.158
9.2.0159
9.1.11,979
9.1.020
9.0.0275
9.0.0-alpha.137
9.0.0-alpha.051
8.1.24,675
8.1.142
8.1.041
8.0.235
8.0.113
8.0.0335
7.1.0356
7.0.021
6.3.3399
6.3.2257
6.3.12
6.3.05
6.2.0630
6.1.090
6.0.023
5.5.017,652
5.4.0172
5.3.5598
5.3.44
5.3.31,530
5.3.22,267
5.3.1195
5.3.0150
5.2.2131
5.2.116
5.2.03
5.1.18
5.1.011
5.0.12
5.0.033
4.0.07,768
4.0.0-rc.1590
4.0.0-rc.0317
4.0.0-beta.195
4.0.0-beta.181,230
4.0.0-beta.1766
4.0.0-beta1634
4.0.0-beta1510
4.0.0-beta142
4.0.0-beta136
4.0.0-beta1296
4.0.0-beta1120
4.0.0-beta10858
4.0.0-beta92,112
4.0.0-beta846
4.0.0-beta7117
4.0.0-beta62
4.0.0-beta5222
4.0.0-beta42
4.0.0-beta32
4.0.0-beta23
4.0.0-beta13
4.0.0-beta4
3.0.41,851
3.0.32
3.0.22
3.0.13
3.0.026
2.1.0-alpha27
2.1.0-alpha12
2.1.0-alpha1
2.0.140
2.0.03
1.4.011
1.3.21
1.3.12
1.3.02
1.2.03
1.1.01
1.0.71
1.0.62
1.0.51
1.0.41
1.0.31
1.0.21
1.0.12
1.0.02

Package Sidebar

Install

npm i documentation

Weekly Downloads

189,423

Version

14.0.3

License

ISC

Unpacked Size

1.88 MB

Total Files

108

Last publish

Collaborators

  • mourner
  • jfirebaugh
  • tmcw
  • anandthakker
  • birkskyum