Narrating Prophetic Monks
Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

documentation

12.1.4 • Public • Published

The documentation system for modern JavaScript

Circle CI npm version Gitter David Inline docs

📅 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 
documentation build src/** -f html -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
 
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.

Install

npm i documentation

DownloadsWeekly Downloads

41,105

Version

12.1.4

License

ISC

Unpacked Size

2.63 MB

Total Files

108

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar