documentation 0,3,6,2,4,0,1,3 editorconfig eslint circleci npm

:book: documentation for modern JavaScript

2 years after ISC

The documentation system for modern JavaScript

Greenkeeper badge Circle CI npm version Gitter David Coverage Status Inline docs

  • Supports modern JavaScript: ES5, ES2017, JSX, 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 -h option for help:

Usage:

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

# generate html docs for all files in src
bin/documentation.js build src/** -f html -o docs

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

# build and serve html docs for app.js
bin/documentation.js serve app.js

# build, serve, and live-update html docs for app.js
bin/documentation.js serve --watch app.js

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

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

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

Commands:
  serve [input..]   generate, update, and display HTML documentation
  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.

Related Repositories

api-documentation

api-documentation

This is the 500px API documentation. ...

serverless-aws-documentation

serverless-aws-documentation

Serverless 1.0 plugin to add documentation and models to the serverless generate ...

api-documentation

api-documentation

This is Kippt's API documentation ...

gulp-documentation

gulp-documentation

Use gulp with documentation to generate great documentation for your JavaScript ...

user-documentation

user-documentation

Documentation for those that use HHVM and write Hack and PHP code for HHVM. http ...


Top Contributors

tmcw jfirebaugh anandthakker arv beaugunderson lavrton ikokostya danez akiellor carbonrobot btd montogeek knownasilya anselmbradford deedubs gamtiq iilei ahocevar monkbroc karlhorky kripod lucaswoj mhyfritz oizulain odub rclark sethvincent stevoland wooorm mourner

Dependencies

package version
ansi-html ^0.0.7
babel-core ^6.17.0
babel-generator 6.25.0
babel-plugin-system-import-transformer 3.1.0
babel-plugin-transform-decorators-legacy ^1.3.4
babel-preset-es2015 ^6.16.0
babel-preset-react ^6.16.0
babel-preset-stage-0 ^6.16.0
babel-traverse ^6.16.0
babel-types ^6.16.0
babelify ^7.3.0
babylon ^6.17.2
chalk ^2.0.0
chokidar ^1.2.0
concat-stream ^1.5.0
disparity ^2.0.0
doctrine-temporary-fork 2.0.0-alpha-allowarrayindex
get-port ^3.1.0
git-url-parse ^6.0.1
github-slugger 1.1.3
glob ^7.0.0
globals-docs ^2.3.0
highlight.js ^9.1.0
js-yaml ^3.8.4
lodash ^4.11.1
mdast-util-inject ^1.1.0
micromatch ^3.0.0
mime ^1.3.4
module-deps-sortable 4.0.6
parse-filepath ^1.0.1
pify ^3.0.0
read-pkg-up ^2.0.0
remark ^8.0.0
remark-html 6.0.1
remark-toc ^4.0.0
remote-origin-url 0.4.0
shelljs ^0.7.5
stream-array ^1.1.0
strip-json-comments ^2.0.0
tiny-lr ^1.0.3
unist-builder ^1.0.0
unist-util-visit ^1.0.1
vfile ^2.0.0
vfile-reporter ^4.0.0
vfile-sort ^2.0.0
vinyl ^2.0.0
vinyl-fs ^2.3.1
yargs ^6.0.1
dev are-we-flow-yet ^1.0.0
babel-cli ^6.24.1
babel-eslint ^7.2.3
babel-jest ^20.0.1
babel-plugin-transform-es2015-modules-commonjs ^6.24.1
babel-preset-flow ^6.23.0
chdir 0.0.0
coveralls ^2.13.1
cz-conventional-changelog 2.0.0
documentation-schema 0.0.1
eslint ^4.1.1
eslint-config-prettier ^2.3.0
eslint-plugin-flowtype ^2.34.1
flow-bin ^0.46.0
fs-extra ^4.0.0
husky ^0.14.0
jest ^20.0.4
json-schema 0.2.3
lint-staged ^4.0.0
mock-fs ^4.2.0
p-event ^1.0.0
prettier ^1.0.0
standard-version ^4.0.0
tmp ^0.0.31

Releases

-   v4.0.0-beta9 zip tar
-   v4.0.0-beta7 zip tar
-   v4.0.0-beta6 zip tar
-   v4.0.0-beta5 zip tar
-   v4.0.0-beta4 zip tar
-   v4.0.0-beta3 zip tar
-   v4.0.0-beta2 zip tar
-   v4.0.0-beta1 zip tar
-   v4.0.0-beta zip tar
-   v3.0.4 zip tar
-   v3.0.3 zip tar
-   v3.0.2 zip tar
-   v3.0.1 zip tar
-   v3.0.0 zip tar
-   v2.1.0-alpha zip tar
-   v2.0.1 zip tar
-   v2.0.0 zip tar
-   v2.0.0-alpha2 zip tar
-   v1.4.0 zip tar
-   v1.3.2 zip tar
-   v1.3.1 zip tar
-   v1.3.0 zip tar
-   v1.2.0 zip tar
-   v1.1.0 zip tar
-   v1.0.7 zip tar
-   v1.0.6 zip tar
-   v1.0.5 zip tar
-   v1.0.4 zip tar
-   v1.0.3 zip tar
-   v1.0.2 zip tar