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.
node.js, browser:
$ npm install markdown-it-plantuml --save
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'));
See markdown-it repository for more details.
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);
Options:
@startuml
. String to use as oppening delimiter.@enduml
. String to use as closing delimiter.src
property of the image element.uml
. Name used by generateSoruce to generate diagram tags like @startuml
, @startditaa
, etc.svg
. Format used by generateSource
to generate the src
of the image element.http://www.plantuml.com/plantuml
. Defines the plantuml server used for image generation.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);
const options = {
openMarker: '@startditaa',
closeMarker: '@endditaa',
diagramName: 'ditaa',
imageFormat: 'png'
}
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);