# @ansanloms/honkit-plugin-uml

> PlantUML Plugin for HonKit.

Latest version **0.0.8** (published 2021-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ansanloms/honkit-plugin-uml
pnpm add @ansanloms/honkit-plugin-uml
yarn add @ansanloms/honkit-plugin-uml
bun add @ansanloms/honkit-plugin-uml
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2021-10-10 |
| First published | 2020-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | ansanloms |
| Maintainers | ansanloms |

## Links

- npm: https://www.npmjs.com/package/@ansanloms/honkit-plugin-uml
- Repository: https://github.com/ansanloms/honkit-plugin-uml
- Homepage: https://github.com/ansanloms/honkit-plugin-uml#readme
- Issues: https://github.com/ansanloms/honkit-plugin-uml/issues
- npm.io page: https://npm.io/package/@ansanloms/honkit-plugin-uml

## Dependencies (2)

- [node-plantuml](https://npm.io/package/node-plantuml.md) ^0.9.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.15.4

## Recent versions

- 0.0.8 (latest) — 2021-10-10
- 0.0.7 — 2020-10-09
- 0.0.6 — 2020-07-21
- 0.0.5 — 2020-07-20
- 0.0.4 — 2020-07-06
- 0.0.2 — 2020-07-06

## README

# honkit-plugin-uml

[PlantUML](https://plantuml.com/) Plugin for [HonKit](https://github.com/HonKit/HonKit).

## Install

```
npm install @ansanloms/honkit-plugin-uml --save-dev
```

## Usage

Add the plugin to `book.json` .

```json
{
  "plugins": ["@ansanloms/uml"]
}
```

## Options

```json
"pluginsConfig": {
  "uml": {
     "format": "svg",
     "charset": "utf8",
     "config": "classic"
  }
}
```

- `format`
  - Format of the generated images. `png` , `svg` , `ascii` (ascii character only), `unicode` .
- `charset`
  - Use a specific charset.
- `config`
  - design settings. `classic` , `monochrome` or file path.

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