apeman-doc

Document generator for apeman.

Installation

Install apeman-doc module via npm.

$ npm install apeman-doc -g

Usage

1. Prepare an Apemanfile.js at your project root.
2. Run the command via CLI.

Apemanfile.js

/** Example of Apemanfile.js */

'use strict'

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $api: { /* ... */ }
}

Then,

# Generate doc about current apemanfile.
$ apeman-doc apemanfile doc/apemanfile-doc.md

CLI Options

$ apeman-doc -h

  Usage: apeman-doc [options] 

  Generate project documentation.

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -o, --out <out>                      Output directory path.
    -c, --configuration <configuration>  Pathname of Apemanfile
    -C, --context <context>              Pathname of mock context file.

  Examples:

    $ apeman-doc -o doc/apdoc.md                    # Generate apemanfile doc.

Programmatic API

apeman-doc also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-doc --save-dev

Then,

'use strict'

const apemanDoc = require('apeman-doc')

apemanDoc("apemanfile", "doc/apemanfile-doc.md", {}).then(() => {
    /* ... */
})

Programmatic Options

| Key | Description | Default | | --- | ----------- | ------- | | out | Output directory path. | doc/apdoc.md | | configuration | Pathname of Apemanfile | | | context | Pathname of mock context file. | |

License

This software is released under the MIT License.

Links

• apeman
• apeman-cmd-labo