Neurotic Programmer Masquerade
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

This version has been deprecated

Author message:

## NO LONGER MAINTAINED

apeman-task-jsdoc

1.0.1 • Public • Published

apeman-task-jsdoc

Build Status Code Climate Code Coverage npm Version

apeman task to generate jsdoc.

Installation

$ npm install apeman-task-jsdoc --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-jsdoc */
 
"use strict";
 
module.exports = {
    $pkg: {/*...*/},
    $tasks: {
        // Define your own task.
        'my-task-01': require('apeman-task-jsdoc')([
            "README.md",
            "lib/**/*.js"
        ], {
            "tutorials": "doc/tutorials",
            "destination": "doc/apiguide",
            "template": "node_modules/ink-docstrap/template",
            "configure": "doc/.apiguide.json"
        })
    }
};

Then,

$ apeman task my-task-01

Options

Key Type Description
tutorials string File path of tutorial markdowns
destination string Destination file path
template string File path of template.
configure string Config json file path

License

This software is released under the MIT License.

Links