markdown-it-plantuml-ex2
v1.0.1
Published
Plugin to create block-level uml diagrams for markdown-it markdown parser using offline plantuml.jar
Downloads
21
Maintainers
Readme
markdown-it-plantuml-ex2
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:
- 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 totally offline;
- You can enjoy a better render performance;
- 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-ex2 --save
Basic usage
As we all known, markdown-it-plantuml-ex2 is a plugin of markdown-it, so you should setup markdown-it before you use markdown-it-plantuml-ex2.
import markit from "markdown-it";
import plantuml from "markdown-it-plantuml-ex2";
const md = markit();
md.use(plantuml);
See markdown-it repository for more details.
NOTICE: You should install Java by yourself before you start rendering.
Advanced usage
import markit from "markdown-it";
import plantuml from "markdown-it-plantuml-ex2";
const md = markit();
md.use(plantuml, 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.
- javaPath - optional string path to the java application, defaults to
java
- plantumlPath - optional string path to plantuml.jar, defaults to the internal