Repository files navigation

The documentation system for modern JavaScript

📅 Current maintenance status

• Supports modern #"https://flow.org/" rel="nofollow">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

• HTML output with default template
• Markdown
• JSON

• 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

Globally installdocumentation using thenpm package manager:

$ npm install -g documentation

This installs a command calleddocumentation in your path, that you canpoint atJSDoc-annotated source code to generatehuman-readable documentation. First, rundocumentation with the--helpoption 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 build index.ts --parse-extension ts -f html -o docsCommands:  build [input..]   build documentation  lint [input..]    checkfor common style and uniformity mistakes  readme [input..]  inject documentation into your README.mdOptions:  --version  Show version number                                       [boolean]  --help     Showhelp                                                 [boolean]

We have plenty ofissues that we'dlove help with.

• Robust and completeJSDoc 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 givencommit-access to the project to contribute as they see fit. Thisproject is more like an open wiki than a standard guarded open source project.