a documentation generator
Last updated 2 years ago by fisch0920 .
ISC · Repository · Original npm · Tarball · package.json
$ cnpm install documentation-custom-markdown 
SYNC missed versions from official npm registry.

The documentation system for modern JavaScript

Greenkeeper badge Circle CI npm version Gitter David Coverage Status Inline docs

  • 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



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:


# generate markdown docs for index.js and files it references
bin/documentation.js build index.js -f md

# generate html docs for all files in src
bin/documentation.js build src/** -f html -o docs

# document index.js, ignoring any files it requires or imports
bin/documentation.js build index.js -f md --shallow

# build and serve HTML docs for app.js
bin/documentation.js serve app.js

# build, serve, and live-update HTML docs for app.js
bin/documentation.js serve --watch app.js

# validate JSDoc syntax in util.js
bin/documentation.js lint util.js

# update the API section of with docs from index.js
bin/documentation.js readme index.js --section=API

# build docs for all values exported by index.js
bin/documentation.js build --document-exported index.js

  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

  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]


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.

Current Tags

  • 6.3.5                                ...           latest (2 years ago)

4 Versions

  • 6.3.5                                ...           2 years ago
  • 6.3.4                                ...           2 years ago
  • 6.3.3                                ...           2 years ago
  • 6.3.2                                ...           2 years ago
Maintainers (1)
Today 0
This Week 0
This Month 12
Last Day 0
Last Week 4
Last Month 11
Dependencies (49)
Dev Dependencies (26)
Dependents (1)

Copyright 2014 - 2017 © |