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 referencesdocumentation build index.js -f md# generate html docs for all files in src, and include links to source files in githubdocumentation build src/** -f html --github -o docs# document index.js, ignoring any files it requires or importsdocumentation build index.js -f md --shallow# validate JSDoc syntax in util.jsdocumentation lint util.js# update the API section of README.md with docs from index.jsdocumentation readme index.js --section=API# build docs for all values exported by index.jsdocumentation build --document-exported index.js# build html docs for a TypeScript projectdocumentation
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.