markdown-it-plantuml-ex
v1.0.0
Published
Plugin to create block-level uml diagrams for markdown-it markdown parser using offline plantuml.jar
Downloads
540
Maintainers
Readme
markdown-it-plantuml-ex
Plugin for creating block-level uml diagrams for markdown-it markdown parser using offline
plantuml.jar
.
With this plugin you can create uml diagrams inside your markdown files:
UML example:
```plantuml
@startuml
Bob -> Alice : hello
@enduml
```
See plantuml website for more details.
Installation
node.js, browser:
$ npm install markdown-it-plantuml-ex --save
Basic usage
const md = require('markdown-it')()
.use(require('markdown-it-plantuml-ex'));
See markdown-it repository for more details.
Advanced usage
const md = require('markdown-it')()
.use(require('markdown-it-plantuml-ex'), options);
Options:
- openMarker - optional, defaults to
@startuml
. String to use as oppening delimiter. - closeMarker - optional, defaults to
@enduml
. String to use as closing delimiter. - diagramName - optional, defaults to
uml
. Name used by generateSoruce to generate diagram tags like@startuml
,@startditaa
, etc. - render - optional, defaults to markdown-it image renderer. Renderer function for opening/closing tokens.