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 render your diagrams, that means three things:
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.
Just install via npm or any other package manager of Node.
$ npm i markdown-it-plantuml-ex --save
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.
const md = require('markdown-it')()
.use(require('markdown-it-plantuml-ex'), options);
Options:
uml
.