apeman-task-contrib-jsdoc
Apeman task contribution plugin to generate jsdoc.
Installation
Install module via npm
$ npm install apeman-task-contrib-jsdoc --save-devUsage
Define a task at $tasks property in you Apemanfile.
/**
* This is example Apemanfile to use "apeman-task-contrib-jsdoc".
* @see https://github.com/jadejs/jade
*/
"use strict";
module.exports = {
$pkg: {/*...*/},
$tasks: {
// Define your own task.
"my-task-01": require('apeman-task-contrib-jsdoc')("README.md", "lib/**/*.js", {
"verbose": true,
"tutorials": "docs/tutorials",
"destination": "docs/apiguide",
"template": "node_modules/ink-docstrap/template",
"configure": "docs/.apiguide.json"
});
}
};Then, run the task via apeman task command.
# Run the task from CLI.
$ apeman task "my-task-01"Option
Values which can be passed to $options property.
| Name | Type | Description |
|---|---|---|
| verbose | Boolean | Shows verbose log. |
| 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.
