documentation
a documentation generator
Last updated 13 hours ago by tmcw .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install documentation 
SYNC missed versions from official npm registry.

The documentation system for modern JavaScript

Circle CI npm version Gitter David Inline docs

:date: 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
documentation build src/** -f html -o docs

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

# build and serve HTML docs for app.js
documentation serve app.js

# build, serve, and live-update HTML docs for app.js
documentation serve --watch app.js

# 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

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.

Current Tags

  • 12.0.3                                ...           latest (13 hours ago)
  • 10.0.0-alpha.0                                ...           prerelease (4 months ago)

95 Versions

  • 12.0.3                                ...           13 hours ago
  • 12.0.2                                ...           7 days ago
  • 12.0.1                                ...           13 days ago
  • 12.0.0                                ...           13 days ago
  • 11.0.1                                ...           a month ago
  • 11.0.0                                ...           2 months ago
  • 10.1.0                                ...           3 months ago
  • 10.0.0                                ...           3 months ago
  • 10.0.0-alpha.0                                ...           4 months ago
  • 9.3.1                                ...           4 months ago
  • 9.3.0                                ...           5 months ago
  • 9.2.1                                ...           5 months ago
  • 9.2.0                                ...           5 months ago
  • 9.1.1                                ...           7 months ago
  • 9.1.0                                ...           7 months ago
  • 9.0.0                                ...           7 months ago
  • 9.0.0-alpha.1                                ...           9 months ago
  • 9.0.0-alpha.0                                ...           10 months ago
  • 8.1.2                                ...           a year ago
  • 8.1.1                                ...           a year ago
  • 8.1.0                                ...           a year ago
  • 8.0.2                                ...           a year ago
  • 8.0.1                                ...           a year ago
  • 8.0.0                                ...           a year ago
  • 7.1.0                                ...           a year ago
  • 7.0.0                                ...           a year ago
  • 6.3.3                                ...           a year ago
  • 6.3.2                                ...           a year ago
  • 6.3.1                                ...           a year ago
  • 6.3.0                                ...           a year ago
  • 6.2.0                                ...           a year ago
  • 6.1.0                                ...           a year ago
  • 6.0.0                                ...           a year ago
  • 5.5.0                                ...           a year ago
  • 5.4.0                                ...           a year ago
  • 5.3.5                                ...           2 years ago
  • 5.3.4                                ...           2 years ago
  • 5.3.3                                ...           2 years ago
  • 5.3.2                                ...           2 years ago
  • 5.3.1                                ...           2 years ago
  • 5.3.0                                ...           2 years ago
  • 5.2.2                                ...           2 years ago
  • 5.2.1                                ...           2 years ago
  • 5.2.0                                ...           2 years ago
  • 5.1.1                                ...           2 years ago
  • 5.1.0                                ...           2 years ago
  • 5.0.1                                ...           2 years ago
  • 5.0.0                                ...           2 years ago
  • 4.0.0                                ...           2 years ago
  • 4.0.0-rc.1                                ...           2 years ago
  • 4.0.0-rc.0                                ...           2 years ago
  • 4.0.0-beta.19                                ...           2 years ago
  • 4.0.0-beta.18                                ...           3 years ago
  • 4.0.0-beta.17                                ...           3 years ago
  • 4.0.0-beta16                                ...           3 years ago
  • 4.0.0-beta15                                ...           3 years ago
  • 4.0.0-beta14                                ...           3 years ago
  • 4.0.0-beta13                                ...           3 years ago
  • 4.0.0-beta12                                ...           3 years ago
  • 4.0.0-beta11                                ...           3 years ago
  • 4.0.0-beta10                                ...           3 years ago
  • 4.0.0-beta9                                ...           3 years ago
  • 4.0.0-beta8                                ...           3 years ago
  • 4.0.0-beta7                                ...           3 years ago
  • 4.0.0-beta6                                ...           3 years ago
  • 4.0.0-beta5                                ...           3 years ago
  • 4.0.0-beta4                                ...           3 years ago
  • 4.0.0-beta3                                ...           3 years ago
  • 4.0.0-beta2                                ...           3 years ago
  • 4.0.0-beta1                                ...           3 years ago
  • 4.0.0-beta                                ...           3 years ago
  • 3.0.4                                ...           4 years ago
  • 3.0.3                                ...           4 years ago
  • 3.0.2                                ...           4 years ago
  • 3.0.1                                ...           4 years ago
  • 3.0.0                                ...           4 years ago
  • 2.1.0-alpha2                                ...           4 years ago
  • 2.1.0-alpha1                                ...           4 years ago
  • 2.1.0-alpha                                ...           4 years ago
  • 2.0.1                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.4.0                                ...           4 years ago
  • 1.3.2                                ...           4 years ago
  • 1.3.1                                ...           4 years ago
  • 1.3.0                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.7                                ...           4 years ago
  • 1.0.6                                ...           4 years ago
  • 1.0.5                                ...           4 years ago
  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Downloads
Today 160
This Week 396
This Month 4,809
Last Day 236
Last Week 1,962
Last Month 897
Dependencies (65)
Dev Dependencies (18)
Dependents (196)

Copyright 2014 - 2016 © taobao.org |