/markdown-it-plantuml

Primary LanguageJavaScriptMIT LicenseMIT

markdown-it-plantuml

Plugin for creating block-level uml diagrams for markdown-it markdown parser.

With this plugin you can create uml diagrams like:

@startuml
Bob -> Alice : hello
@enduml

See plantuml website for more details.

Installation

node.js, browser:

$ npm install markdown-it-plantuml --save

API

var md = require('markdown-it')()
            .use(require('markdown-it-plantuml')[, options]);

Params:

options:

  • render - optional, renderer function for opening/closing tokens.
  • generateSource - optional, generates the src property of the image element.
  • openMarker - optional (@startuml), string to use as oppening delimiter.
  • closeMarker - optional (@enduml), string to use as closing delimiter.

License

MIT