# malta-jsdoc

> Malta plugin to have jsdoc running live

Latest version **1.0.8** (published 2020-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install malta-jsdoc
pnpm add malta-jsdoc
yarn add malta-jsdoc
bun add malta-jsdoc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2020-07-28 |
| First published | 2016-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Federico Ghedina |
| Maintainers | fedeghe |
| Keywords | malta, malta plugin, malta jsdoc, malta jsdoc plugin |

## Links

- npm: https://www.npmjs.com/package/malta-jsdoc
- Repository: https://fedeghe@github.com/fedeghe/malta-jsdoc
- Issues: https://github.com/fedeghe/malta-jsdoc/issues
- npm.io page: https://npm.io/package/malta-jsdoc

## Dependencies (1)

- [malta](https://npm.io/package/malta.md) 4.1.19

## Recent versions

- 1.0.8 (latest) — 2020-07-28
- 1.0.7 — 2020-03-08
- 1.0.6 — 2019-07-19
- 1.0.5 — 2019-07-06
- 1.0.4 — 2018-11-08
- 1.0.3 — 2018-10-19
- 1.0.2 — 2018-04-24
- 1.0.1 — 2017-02-23
- 1.0.0 — 2017-02-11
- 0.0.12 — 2016-12-05
- 0.0.11 — 2016-11-22
- 0.0.10 — 2016-11-21
- 0.0.9 — 2016-11-17
- 0.0.8 — 2016-11-17
- 0.0.7 — 2016-11-17
- … 5 more at https://npm.io/package/malta-jsdoc/versions

## README

---
[![npm version](https://badge.fury.io/js/malta-jsdoc.svg)](http://badge.fury.io/js/malta-jsdoc)
[![npm downloads](https://img.shields.io/npm/dt/malta-jsdoc.svg)](https://npmjs.org/package/malta-jsdoc)
[![npm downloads](https://img.shields.io/npm/dm/malta-jsdoc.svg)](https://npmjs.org/package/malta-jsdoc)  
---  

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 : 
``` js
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('=========');
    });
```

---
_Source: https://npm.io/package/malta-jsdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._