@fanls/markdown-it-plantuml-ex

markdown-it-plantuml-ex

Plugin for creating block-level uml diagrams for markdown-it markdown parser using offline plantuml.jar.

Using this plugin and you can create uml diagrams inside your markdown files.

Differ with markdown-it-plantuml, markdown-it-plantuml-ex use offline plantuml.jar to redner your diagrams, that means three things:

1. You can safely use it in your secret project or some internal docs of your employer, because markdown-it-plantuml-ex will not upload any of your data to any server, it's just offline;
2. You can enjoy a better render performance;
3. You should install Java by yourself before you start rendering, because markdown-it-plantuml-ex relies on it.

UML example:

The diagrams you can use in your markdown file just like codes below.

```plantuml
@startuml
Bob -> Alice : hello
@enduml
```

You can visit plantuml website for more details.

Installation

Just install via npm or any other package manager of Node.

$ npm i markdown-it-plantuml-ex --save

Basic usage

As we all known, markdown-it-plantuml-ex is a plugin of markdown-it, so you should setup markdown-it before you use markdown-it-plantuml-ex.

const md = require('markdown-it')()
           .use(require('markdown-it-plantuml-ex'));

See markdown-it repository for more details.

NOTICE: You should install Java by yourself before you start rendering.

Advanced usage

const md = require('markdown-it')()
           .use(require('markdown-it-plantuml-ex'), options);

Options:

• openMarker - optional, defaults to "```plantuml". String to use as oppening delimiter.
• closeMarker - optional, defaults to "```" . String to use as closing delimiter.
• diagramName - optional, defaults to uml.
• render - optional, defaults to markdown-it image renderer. Renderer function for opening/closing tokens.

License

MIT