Plugin to create block-level uml diagrams for markdown-it markdown parser
npm install 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:
``markdownUML example:
@startuml
Bob -> Alice : hello
@enduml
`
See plantuml website for more details.
node.js, browser:
`bash`
$ npm install markdown-it-plantuml --save
`js`
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'));
See markdown-it repository for more details.
`js`
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);
Options:
- __openMarker__ - optional, defaults to @startuml. String to use as oppening delimiter.@enduml
- __closeMarker__ - optional, defaults to . String to use as closing delimiter.src
- __generateSource__ - optional, defaults to using public plant-uml server. Generates the property of the image element.uml
- __diagramName__ - optional, defaults to . Name used by generateSoruce to generate diagram tags like @startuml, @startditaa, etc.svg
- __imageFormat__ - optional, defaults to . Format used by generateSource to generate the src of the image element.http://www.plantuml.com/plantuml
- __render__ - optional, defaults to markdown-it image renderer. Renderer function for opening/closing tokens.
- __server__ - optional, defaults to . Defines the plantuml server used for image generation.
#### Example: using custom URL to serve diagrams
`jshttps://your.server/plant-uml/${yourEncodeFunction(umlCode)}
const options = {
generateSource: function generateSource(umlCode) {
return ;
}
}
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);
`
#### Example: generating ditaa diagrams
`js
const options = {
openMarker: '@startditaa',
closeMarker: '@endditaa',
diagramName: 'ditaa',
imageFormat: 'png'
}
const md = require('markdown-it')()
.use(require('markdown-it-plantuml'), options);
``