0.2.0 • Published 7 years ago

@toanzzz/jsdoc-webpack-plugin v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
7 years ago

jsdoc-webpack-plugin

JSDoc Plugin for Webpack v4+

Install

npm i -D @toanzzz/jsdoc-webpack-plugin

Usage

In webpack.config.js:

const JSDocWebpackPlugin = require('@toanzzz/jsdoc-webpack-plugin');

const jsdocConfig = require('./jsdoc.json') // Your jsdoc config

module.exports = {
    // ... other config
    plugins: [
        new JSDocWebpackPlugin(jsdocConfig)
    ]
}

Or you can pass config directly (if you don't have jsdoc config file)

const JSDocWebpackPlugin = require('@toanzzz/jsdoc-webpack-plugin');

module.exports = {
    // ... other config
    plugins: [
        new JSDocWebpackPlugin({
            opts: {
                recurse: true,
                destination: 'doc'
            }
        })
    ]
}

Options

  • workDir: Working directory, default to process.cwd()
  • jsdocRoot: Folder contain jsdoc executies, default to {workDir}/node_modules/.bin
0.2.0

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago