Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.19 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.19 KB

plantuml-encoder

PlantUML encoder for browsers and Node.js.

npm Version build-status js-standard-style

Encoded PlantUML can be used to create PlantUML URL links.

Install

Node.js:

npm install plantuml-encoder

browser:

bower install plantuml-encoder

Example

var plantumlEncoder = require('plantuml-encoder')

var encoded = plantumlEncoder.encode('A -> B: Hello')
console.log(encoded) // UDfpLD2rKt2oKl18pSd91m0KGWDz

var url = 'http://www.plantuml.com/plantuml/img/' + encoded

The URL can then be used to display the diagram:

alt tag

Decode example

var plantumlEncoder = require('plantuml-encoder')

var plain = plantumlEncoder.decode('UDfpLD2rKt2oKl18pSd91m0KGWDz')
console.log(plain) // A -> B: Hello

License

MIT