malta-jsdoc

1.0.8 • Public • Published

npm version npm downloads npm downloads

This plugin can be used on: .js files and even on .coffee and .ts files after using the right plugin

jsdoc needs to be available from the console.

Options : - d : the folder where all documentation must be generated, relative to outdir.
- c : the path of the config.json for jsdoc, relative to template folder - t : absolute path for the template

Sample usage:

malta app/source/index.js public/js -plugins=malta-jsdoc[outFolder:\"docs\"]

or in the .json file :

"app/source/index.js" : "public/js -plugins=malta-jsdoc[d:'docs']",
"app/source/index.ts" : "public/js -plugins=malta-typescript...malta-jsdoc[d:'docs']"

or in a script :

var Malta = require('malta');
Malta.get().check([
    'app/source/index.js',
    'public/js',
    '-plugins=malta-jsdoc[d:"docs"]',
    '-options=showPath:false,watchInterval:500,verbose:0'
    ]).start(function (o) {
        var s = this;
        console.log('name : ' + o.name)
        console.log("content : \n" + o.content);
        'plugin' in o && console.log("plugin : " + o.plugin);
        console.log('=========');
    });

Package Sidebar

Install

npm i malta-jsdoc

Weekly Downloads

0

Version

1.0.8

License

MIT

Unpacked Size

4.38 kB

Total Files

4

Last publish

Collaborators

  • fedeghe