serglider / rollup-plugin-typedoc

rollup-plugin-typedoc

This plugin runs Typedoc to generate your API documentation as a step of your Rollup flow.

Setup

npm i rollup-plugin-typedoc --save-dev

Typedoc is required as peer dependency.

npm i typedoc --save-dev

Usage

import typescript from '@rollup/plugin-typescript';
import typedoc from 'rollup-plugin-typedoc';

// see https://typedoc.org/guides/options/
const options = {
    out: './docsDir',
    entryPoints: ['./src'],
};
// the plugin reads tsconfig.json, typedoc.json,
// and your custom options (as above) and merges them
export default [
    {
        input: 'src/index.ts',
        plugins: [
            typescript(),
            typedoc(options)
        ],
    }
];

Note: do not include this plugin for your watch configurations for performance reasons.

License

Copyright © 2021, Sergey Chernykh. Released under the MIT License.