Skip to content
📖 documentation for modern JavaScript
JavaScript CSS Vue
Branch: master
Clone or download

Latest commit

Latest commit 35359ab May 9, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci test: Just test in v12 Apr 7, 2020
.github docs(readme): Improve README: add new logo, simplify (#714) Apr 10, 2017
__tests__ feat: upgrade babel dependencies Apr 7, 2020
bin refactor: remove flow and related dependencies, test on 10 not latest… Dec 10, 2018
declarations feat: TypeScript support & inference Apr 25, 2019
docs Update GETTING_STARTED.md (#1294) Mar 17, 2020
src feat: upgrade babel dependencies Apr 7, 2020
.editorconfig editorconfig rules should apply to CSS too (#1275) Aug 13, 2019
.eslintignore Native Flow, use Jest (#767) May 9, 2017
.eslintrc refactor: remove flow and related dependencies, test on 10 not latest… Dec 10, 2018
.gitattributes Ignore polyglot file for linguist. Fixes #281 Dec 7, 2015
.gitignore refactor: remove flow and related dependencies, test on 10 not latest… Dec 10, 2018
.npmignore build: Reduce npm package by removing development files (#1298) Nov 15, 2019
.prettierignore feat: Enable all parser plugins May 7, 2019
.prettierrc feat: use reference links for Markdown output, improving brevity Mar 1, 2018
CHANGELOG.md chore(release): 13.0.0 May 9, 2020
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#1290) Oct 14, 2019
CONTRIBUTING.md fix broken link (#842) Jul 15, 2017
ISSUE_TEMPLATE.md docs: Add issue template (#831) Jun 26, 2017
LICENSE feat(bin): Support globs on windows and use smarter recursion (#629) Dec 26, 2016
README.md ci(coveralls): Remove coveralls Dec 17, 2018
babel.config.js chore: upgrade dependencies Sep 21, 2018
package.json chore(release): 13.0.0 May 9, 2020
yarn.lock deps: Update chokidar, bump yarn.lock May 9, 2020

README.md

The documentation system for modern JavaScript

Circle CI npm version Gitter David 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
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.

You can’t perform that action at this time.