documentjs

  • function
DocumentJS.apis.generate.documentjs  

Generates documentation on the command line.

documentjs [NAME[@PATH]] --watch

Reads the local directory's documentjs.json

Parameters

  1. NAME {String}Optional

    The name of a version or site that this generation will be limited too.

  2. PATH {String}Optional

    The path to the location of a local repository to stand-in for the version specified by name.

  3. --watch=false {String}Optional

    If watch is specified, the docs will be rerun when a source file changes.

  4. --forceBuild=true {String}Optional

    If watch is specified, the docs will be rerun when a source file changes.