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: @startumlBob -> Alice : hello@enduml
See plantuml website for more details.
Installation
node.js, browser:
$ npm install markdown-it-plantuml --save
Basic usage
const md = ;
See markdown-it repository for more details.
Advanced usage
const md = ;
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. - diagramName - optional, defaults to
uml
. Name used by generateSoruce to generate diagram tags like@startuml
,@startditaa
, etc. - imageFormat - optional, defaults to
svg
. Format used bygenerateSource
to generate thesrc
of the image element. - render - optional, defaults to markdown-it image renderer. Renderer function for opening/closing tokens.
- server - optional, defaults to
http://www.plantuml.com/plantuml
. Defines the plantuml server used for image generation.
Example: using custom URL to serve diagrams
const options = { return `https://your.server/plant-uml/`; } const md = ;
Example: generating ditaa diagrams
const options = openMarker: '@startditaa' closeMarker: '@endditaa' diagramName: 'ditaa' imageFormat: 'png' const md = ;