@knodes/typedoc-pluginutils/README.md

A set of utilities for TypeDoc plugins

<!-- HEADER -->
# @knodes/typedoc-pluginutils

> A set of utilities for TypeDoc plugins

[![npm version](https://img.shields.io/npm/v/@knodes/typedoc-pluginutils?style=for-the-badge)](https://www.npmjs.com/package/@knodes/typedoc-pluginutils)
[![npm downloads](https://img.shields.io/npm/dm/@knodes/typedoc-pluginutils?style=for-the-badge)](https://www.npmjs.com/package/@knodes/typedoc-pluginutils)
[![Compatible with TypeDoc](https://img.shields.io/badge/For%20typedoc-^0.23.0-green?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/typedoc)

---

[![CircleCI](https://img.shields.io/circleci/build/github/KnodesCommunity/typedoc-plugins/main?style=for-the-badge)](https://circleci.com/gh/KnodesCommunity/typedoc-plugins/tree/main)
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage-letter/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)

For more infos, please refer to [the documentation](https://knodescommunity.github.io/typedoc-plugins/modules/_knodes_typedoc_pluginutils.html)
<!-- HEADER end -->

<!-- INSTALL -->
## Quick start

```sh
npm install --save-dev @knodes/typedoc-pluginutils typedoc@^0.23.0
```

## Compatibility

This plugin version should match TypeDoc `^0.23.0` for compatibility.

> **Note**: this plugin version was released by testing against `^0.23.28`.
<!-- INSTALL end -->