The documentation system for modern JavaScript
- 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
- Getting Started: start here
- Usage: how to use documentation.js
- Recipes: tricks for writing effective JSDoc docs
- Node API: documentation.js's self-generated documentation
- Configuring documentation.js
- FAQ
- Troubleshooting
- Theming: tips for theming documentation output in HTML
- See also: a list of projects similar to documentation.js
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
# build html docs for a TypeScript project
documentation build index.ts --parse-extension ts -f html -o docs
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
JSDocsupport, 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.
### v3
2.7k Dec 29, 2022
889 Dec 25, 2022
5.1k Jan 2, 2023
7.9k Jan 4, 2023
304 Sep 30, 2022
1k Dec 26, 2022
89 Jan 4, 2023
1.5k Nov 28, 2022
147 Dec 8, 2022
3 May 18, 2022
8 Aug 15, 2022
6 Sep 1, 2022
6 Nov 20, 2022
5.6k Jan 4, 2023
4 May 3, 2022
14 Jan 3, 2023
4 Dec 15, 2022
8 Sep 9, 2022
4 Oct 13, 2022
18.7k Jan 4, 2023