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.335,643latest
14.0.0-alpha.167alpha
10.0.0-alpha.01prerelease

Version History

VersionDownloads (Last 7 Days)Published
14.0.335,643
14.0.210,975
14.0.18,273
14.0.02,108
14.0.0-alpha.167
14.0.0-alpha.04
13.2.526,425
13.2.418
13.2.312
13.2.22
13.2.1211
13.2.0136
13.1.11,105
13.1.02,747
13.0.21,378
13.0.172
13.0.090
12.3.07,945
12.2.0276
12.1.42,379
12.1.3219
12.1.2529
12.1.1702
12.1.0114
12.0.3519
12.0.235
12.0.126
12.0.0320
11.0.12,196
11.0.0238
10.1.0459
10.0.046
10.0.0-alpha.01
9.3.12,932
9.3.0146
9.2.117
9.2.0184
9.1.11,690
9.1.07
9.0.026
9.0.0-alpha.141
9.0.0-alpha.056
8.1.22,594
8.1.151
8.1.040
8.0.255
8.0.119
8.0.0363
7.1.0411
7.0.022
6.3.3316
6.3.2239
6.3.13
6.3.06
6.2.0537
6.1.085
6.0.024
5.5.013,834
5.4.0204
5.3.5662
5.3.43
5.3.31,574
5.3.21,812
5.3.1165
5.3.0183
5.2.2131
5.2.117
5.2.05
5.1.19
5.1.08
5.0.12
5.0.033
4.0.02,906
4.0.0-rc.1394
4.0.0-rc.0329
4.0.0-beta.198
4.0.0-beta.181,128
4.0.0-beta.1739
4.0.0-beta1641
4.0.0-beta1510
4.0.0-beta141
4.0.0-beta135
4.0.0-beta12122
4.0.0-beta1119
4.0.0-beta10168
4.0.0-beta9320
4.0.0-beta85
4.0.0-beta7137
4.0.0-beta61
4.0.0-beta524
4.0.0-beta41
4.0.0-beta31
4.0.0-beta21
4.0.0-beta12
4.0.0-beta3
3.0.4547
3.0.31
3.0.21
3.0.11
3.0.034
2.1.0-alpha27
2.1.0-alpha11
2.1.0-alpha1
2.0.152
2.0.06
1.4.011
1.3.21
1.3.11
1.3.02
1.2.01
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

140,120

Version

14.0.3

License

ISC

Unpacked Size

1.88 MB

Total Files

108

Last publish

Collaborators

  • mourner
  • jfirebaugh
  • tmcw
  • anandthakker
  • birkskyum