![](\"./.github/documentation-js-logo.png\"){kind=logo}
\n\n \n
\n The documentation system for modern JavaScript\n
\n\n[](https://circleci.com/gh/documentationjs/documentation/tree/master)\n[](http://badge.fury.io/js/documentation)\n[](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\n[](https://david-dm.org/documentationjs/documentation)\n[](http://inch-ci.org/github/documentationjs/documentation)\n\n[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)\n\n* Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) type annotations.\n* Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.\n* Integrates with GitHub to link directly from documentation to the code it refers to.\n* Customizable output: HTML, JSON, Markdown, and more\n\n## Examples\n\n- [HTML output with default template](https://documentation.js.org/html-example/)\n- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)\n- [JSON](https://documentation.js.org/html-example/index.json)\n\n## Documentation\n\n- [Getting Started](docs/GETTING_STARTED.md): start here\n- [Usage](docs/USAGE.md): how to use documentation.js\n- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs\n- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation\n- [Configuring documentation.js](docs/CONFIG.md)\n- [FAQ](docs/FAQ.md)\n- [Troubleshooting](docs/TROUBLESHOOTING.md)\n- [Theming](docs/THEMING.md): tips for theming documentation output in HTML\n- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js\n\n## User Guide\n\nGlobally install `documentation` using the [npm](https://www.npmjs.com/) package manager:\n\n```sh\n$ npm install -g documentation\n```\n\nThis installs a command called `documentation` in your path, that you can\npoint at [JSDoc](http://usejsdoc.org/)-annotated source code to generate\nhuman-readable documentation. First, run `documentation` with the `--help`\noption for help:\n\n```sh\nUsage:\n\n# generate markdown docs for index.js and files it references\ndocumentation build index.js -f md\n\n# generate html docs for all files in src\ndocumentation build src/** -f html -o docs\n\n# document index.js, ignoring any files it requires or imports\ndocumentation build index.js -f md --shallow\n\n# build and serve HTML docs for app.js\ndocumentation serve app.js\n\n# build, serve, and live-update HTML docs for app.js\ndocumentation serve --watch app.js\n\n# validate JSDoc syntax in util.js\ndocumentation lint util.js\n\n# update the API section of README.md with docs from index.js\ndocumentation readme index.js --section=API\n\n# build docs for all values exported by index.js\ndocumentation build --document-exported index.js\n\nCommands:\n serve [input..] generate, update, and display HTML documentation\n build [input..] build documentation\n lint [input..] check for common style and uniformity mistakes\n readme [input..] inject documentation into your README.md\n\nOptions:\n --version Show version number [boolean]\n --help Show help [boolean]\n```\n\n## [Contributing](CONTRIBUTING.md)\n\n_We have plenty of\n[issues](https://github.com/documentationjs/documentation/issues) that we'd\nlove help with._\n\n- Robust and complete `JSDoc` support, including typedefs.\n- Strong support for HTML and Markdown output\n- Documentation coverage, statistics, and validation\n\ndocumentation is an OPEN Open Source Project. This means that:\n\nIndividuals making significant and valuable contributions are given\ncommit-access to the project to contribute as they see fit. This\nproject is more like an open wiki than a standard guarded open source project.\n","readmeFilename":"README.md"}