:book: documentation for modern JavaScript
The documentation system for modern JavaScript
:date: Current maintenance status
Globally install
documentationusing the npm package manager:
$ npm install -g documentation
This installs a command called
documentationin your path, that you can point at JSDoc-annotated source code to generate human-readable documentation. First, run
documentationwith the
--helpoption 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, and include links to source files in github
documentation build src/** -f html --github -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]
We have plenty of issues that we'd love help with.
JSDocsupport, including typedefs.
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.