apeman-task-doc

apeman task to run apeman doc command.

Usage no npm install needed!

<script type="module">
  import apemanTaskDoc from 'https://cdn.skypack.dev/apeman-task-doc';
</script>

README

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

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.

Links