Need help with documentation?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

documentationjs
5.3K Stars 472 Forks Other 1.2K Commits 189 Opened issues

Description

:book: documentation for modern JavaScript

Services available

!
?

Need anything else?

Contributors list

The documentation system for modern JavaScript

Circle CI npm version Gitter David Inline docs

:date: Current maintenance status

  • 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

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, 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]

Contributing

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.