apeman-task-doc
v2.0.0
Published
apeman task to run apeman doc command.
Downloads
6
Readme
apeman-task-doc
apeman task to run apeman doc command.
Installation
$ npm install apeman-task-doc --save-dev
Usage
- Define a task within Apemanfile.js
- Call the task via apeman task command.
Apemanfile.js
/** This example Apemanfile to use apeman-task-doc */
"use strict";
module.exports = {
$pkg: {/*...*/},
$tasks: {
// Define your own task.
'my-task-01': require('apeman-task-doc')({
//Options
out: 'doc/apemanfile-doc.md'
})
}
};
Then,
$ apeman task my-task-01
Options
| Key | Type | Default | Description | | --- | ---- | --- | --- | | out | string | 'doc/apdoc.md' | Output file path. | | configuration | string | | Apeman configuration path. |
License
This software is released under the MIT License.