2.0.0 • Published 10 years ago

apeman-task-doc v2.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
10 years ago

apeman-task-doc

Build Status Code Climate Code Coverage npm Version

apeman task to run apeman doc command.

Installation

$ npm install apeman-task-doc --save-dev

Usage

  1. Define a task within Apemanfile.js
  2. 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

KeyTypeDefaultDescription
outstring'doc/apdoc.md'Output file path.
configurationstringApeman configuration path.

License

This software is released under the MIT License.

Links

2.0.0

10 years ago

1.0.0

10 years ago