pe

plantuml-encoder

PlantUML encoder, works in browser & node.js

Showing:

Popularity

Downloads/wk

21.5K

GitHub Stars

64

Maintenance

Last Commit

2yrs ago

Contributors

4

Package

Dependencies

0

Size (min+gzip)

15.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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) // SrJGjLDmibBmICt9oGS0

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('SrJGjLDmibBmICt9oGS0')
console.log(plain) // A -> B: Hello

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100