USAGE.md

Using documentation on the command line

Install the documentation binary with npm.

$ npm install -g documentation

documentation then installs a command called documentation. Run it with -h to get help.

Usage: documentation <command> [options]

Commands:
  build   build documentation
  serve   generate, update, and display HTML documentation
  lint    check for common style and uniformity mistakes
  readme  inject documentation into your README.md

Options:
  --help               Show help                                       [boolean]
  --version            Show version number                             [boolean]
  --shallow            shallow mode turns off dependency resolution, only
                       processing the specified files (or the main script
                       specified in package.json)     [boolean] [default: false]
  --config, -c         configuration file. an array defining explicit sort order
  --external           a string / glob match pattern that defines which external
                       modules will be whitelisted and included in the generated
                       documentation.                            [default: null]
  --extension, -e      only input source files matching this extension will be
                       parsed, this option can be used multiple times.
  --polyglot           polyglot mode turns off dependency resolution and enables
                       multi-language support. use this to document c++[boolean]
  --private, -p        generate documentation tagged as private
                                                      [boolean] [default: false]
  --access, -a         Include only comments with a given access level, out of
                       private, protected, public, undefined. By default,
                       public, protected, and undefined access levels are
                       included
                        [choices: "public", "private", "protected", "undefined"]
  --github, -g         infer links to github in documentation          [boolean]
  --infer-private      Infer private access based on the name. This is a regular
                       expression that is used to match the name        [string]
  --document-exported  Generate documentation for all exported bindings and
                       members even if there is no JSDoc for them
                                                      [boolean] [default: false]
  --sort-order         The order to sort the documentation
                                [choices: "source", "alpha"] [default: "source"]
  --theme, -t          specify a theme: this must be a valid theme module
  --name               project name. by default, inferred from package.json
  --watch, -w          watch input files and rebuild documentation when they
                       change                                          [boolean]
  --project-version    project version. by default, inferred from package.json
  --output, -o         output location. omit for stdout, otherwise is a filename
                       for single-file outputs and a directory name for
                       multi-file outputs like html          [default: "stdout"]
  --format, -f       [choices: "json", "md", "remark", "html"] [default: "json"]

Examples:
  documentation build foo.js -f md >        parse documentation in a file and
  API.md                                    generate API documentation as
                                            Markdown