rollup-plugin-jsdoc

0.1.2 • Public • Published

rollup-plugin-jsdoc

Build Status npm version

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

Readme

Keywords

Package Sidebar

Install

npm i rollup-plugin-jsdoc

Weekly Downloads

72

Version

0.1.2

License

MIT

Unpacked Size

9.95 kB

Total Files

7

Last publish

Collaborators

  • zoron