markdown-it-plantuml-offline
v1.0.2
Published
Plugin to create block-level uml diagrams for markdown-it markdown parser by using the local Java-based PlantUML CLI (no remote server posts)
Downloads
8
Maintainers
Readme
markdown-it-plantuml
Plugin for creating block-level uml diagrams for markdown-it markdown parser.
With this plugin you can create uml diagrams inside your markdown files:
# UML example:
@startuml
Bob -> Alice : hello
@enduml
See plantuml website for more details.
Installation
node.js, browser:
$ npm install markdown-it-plantuml --save
Basic usage
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'));
See markdown-it repository for more details.
Advanced usage
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);
Options:
- openMarker - optional, defaults to
@startuml
. String to use as oppening delimiter. - closeMarker - optional, defaults to
@enduml
. String to use as closing delimiter. - generateSource - optional, defaults to using public plant-uml server. Generates the
src
property of the image element. - render - optional, defaults to markdown-it image renderer. Renderer function for opening/closing tokens.
Example: using custom URL to serve diagrams
const options = {
generateSource: function generateSource(umlCode) {
return `https://your.server/plant-uml/${yourEncodeFunction(umlCode)}`;
}
}
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);