# rollup-plugin-typedoc

> Runs typedoc compilation as a rollup plugin

Latest version **0.1.2** (published 2021-02-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install rollup-plugin-typedoc
pnpm add rollup-plugin-typedoc
yarn add rollup-plugin-typedoc
bun add rollup-plugin-typedoc
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2021-02-20 |
| First published | 2021-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sergey Chernykh |
| Maintainers | serglider |
| Keywords | typedoc, rollup, rollup-plugin, documentation, typescript |

## Links

- npm: https://www.npmjs.com/package/rollup-plugin-typedoc
- Repository: https://github.com/serglider/rollup-plugin-typedoc
- Issues: https://github.com/serglider/rollup-plugin-typedoc/issues
- npm.io page: https://npm.io/package/rollup-plugin-typedoc

## Dependencies (2)

- [lodash.clone](https://npm.io/package/lodash.clone.md) ^4.5.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2021-02-20
- 0.1.3 — 2021-02-08
- 0.1.2-beta.0 — 2021-02-08
- 0.1.1 — 2021-02-06

## README

# do not use it

# it's broken currently

### rollup-plugin-typedoc
This plugin runs [Typedoc](https://typedoc.org/) to generate your API documentation as a step of your [Rollup](http://rollupjs.org/) flow.

## Setup

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

Typedoc is required as peer dependency. 
```bash
npm i typedoc --save-dev
```
<!-- todo: no-.nojekyll -->
## Usage
```js
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](https://github.com/serglider).
Released under the [MIT License](LICENSE).

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