# @keep2zero/jsdoc-webpack-plugin

> JsDoc Webpack Plugin

Latest version **0.0.2** (published 2018-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @keep2zero/jsdoc-webpack-plugin
pnpm add @keep2zero/jsdoc-webpack-plugin
yarn add @keep2zero/jsdoc-webpack-plugin
bun add @keep2zero/jsdoc-webpack-plugin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-11-12 |
| First published | 2018-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Mitko Tschimev |
| Maintainers | keep2zero |
| Keywords | jsdoc, webpack |

## Links

- npm: https://www.npmjs.com/package/@keep2zero/jsdoc-webpack-plugin
- Repository: https://github.com/tfiwm/jsdoc-webpack-plugin
- Homepage: https://github.com/tfiwm/jsdoc-webpack-plugin#readme
- Issues: https://github.com/tfiwm/jsdoc-webpack-plugin/issues
- npm.io page: https://npm.io/package/@keep2zero/jsdoc-webpack-plugin

## Dependencies (3)

- [jsdoc](https://npm.io/package/jsdoc.md) ^3.4.0
- [lodash](https://npm.io/package/lodash.md) ^4.11.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.30.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2018-11-12

## README

jsdoc-webpack-plugin
==========================


WebPack plugin that runs [jsdoc](http://usejsdoc.org/) on your bundles

# Usage
In webpack.config.js:
```javascript
var webpack = require('webpack');
var JsDocPlugin = require('jsdoc-webpack-plugin');

module.exports = {
    /// ... rest of config
    plugins: [
        new JsDocPlugin({
            conf: './jsdoc.conf'
        })
    ]
}

```

There are two ways how this plugin recognizes the files

1. It takes the information from the jsdoc config file "source.include"
2. If no "source.include" provided, it takes the whole files from your bundles

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