49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# plantuml-encoder
|
|
PlantUML encoder for browsers and Node.js.
|
|
|
|
[](https://www.npmjs.com/package/plantuml-encoder) [](https://travis-ci.org/markushedvall/plantuml-encoder) [](https://github.com/feross/standard)
|
|
|
|
Encoded PlantUML can be used to create PlantUML URL links.
|
|
|
|
# Install
|
|
|
|
Node.js:
|
|
|
|
```
|
|
npm install plantuml-encoder
|
|
```
|
|
|
|
browser:
|
|
|
|
```
|
|
bower install plantuml-encoder
|
|
```
|
|
|
|
# Example
|
|
|
|
```javascript
|
|
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:
|
|
|
|
|
|
|
|
# Decode example
|
|
|
|
```javascript
|
|
var plantumlEncoder = require('plantuml-encoder')
|
|
|
|
var plain = plantumlEncoder.decode('SrJGjLDmibBmICt9oGS0')
|
|
console.log(plain) // A -> B: Hello
|
|
|
|
```
|
|
|
|
# License
|
|
MIT
|