rollup-plugin-jsdoc
v0.1.2
Published
Rollup plugin for jsdoc
Downloads
3,658
Readme
rollup-plugin-jsdoc
Rollup plugin of JSDoc, generating an API documentation for your library.
Installation
npm install -D rollup-plugin-jsdoc
Usage
// rollup.config.js
import jsdoc from 'rollup-plugin-jsdoc';
export default {
input: './src/index.js',
plugins: [
jsdoc({
args: ['-d', 'doc'], // Command-line options passed to JSDoc, Note: use "config" to indicate configuration file, do not use "-c" or "--configure" in "args"
config: 'jsdoc.config.json', // Path to the configuration file for JSDoc. Default: jsdoc.json
})
]
};
License
MIT