jekyll-remote-plantuml 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.txt +20 -0
- data/README.md +51 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ef3b3830254af6eb301a6a952509d1890f8ceccf
|
|
4
|
+
data.tar.gz: 180146fbde5d88778a055590bf42e23820cd64ce
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d40428cd4f2781f08690f8e6b5dc901ebeb6397104aa58f49e30ce252ffd99cb167263b8835a98ef027e034b63f72c6600fbf46e193e435083c1689dbc0b35fa
|
|
7
|
+
data.tar.gz: 6da9259e12e38aa6254159e8b895e6f0c96d30c2102ef1f0fc29f3c811aebf84f38e5cad1afce5a6b1b35487f8c638fb099f71667717b692ee05f589d5982412
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2015 Patrick Allain
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
7
|
+
the Software without restriction, including without limitation the rights to
|
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
10
|
+
subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# jekyll-remote-plantuml
|
|
2
|
+
|
|
3
|
+
A plugin for jekyll to use plantuml diagram inside your [Jekyll](http://jekyllrb.com/) for you website. This will use external resource to build plantuml diagram. Once created, the diagram is store on the filesystem to prevent any unnecessary diagram generation. So, using this plugin, provide a simple way to integrate plantuml diagramm without the [Graphiz](http://www.graphviz.org/) software or the using the [plantuml](http://sourceforge.net/projects/plantuml/files/plantuml.jar/download) jar file.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To install this plugin on Jekyll, you just have to follow the guideline of Jekyll [documentation](http://jekyllrb.com/docs/plugins/)
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
To use the jekyll-remote-plantuml plugin, you just have to wrap you text between `{% uml %}` and `{% enduml %}` tags.
|
|
12
|
+
|
|
13
|
+
For example, to create a basic shema between Bob and Alice, you can write the following code :
|
|
14
|
+
|
|
15
|
+
``` text
|
|
16
|
+
{% minibundle js %}
|
|
17
|
+
Bob -> Alice : Hello
|
|
18
|
+
{% endminibundle %}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
This will retrieve the binary from a remote provider and add it into the folder defined in your configuration.
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
The generated html will have be something like :
|
|
26
|
+
|
|
27
|
+
``` html
|
|
28
|
+
<img src="/assets/images/plantuml/765f88ab868d9706e797ff2c90c67a549a144c52adf0bf2e247d355cf981b9aa.png" />
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Any update of the uml will regenerated the image file using the remote. If the uml is not modified, no request will be made on the remote provider.
|
|
32
|
+
|
|
33
|
+
## Configuration
|
|
34
|
+
|
|
35
|
+
For now, the configuration is really poor. You can just change the remote provider and the location where are store the binary files.
|
|
36
|
+
|
|
37
|
+
``` yaml
|
|
38
|
+
plantuml:
|
|
39
|
+
url: 'http://www.plantuml.com/plantuml/png/{code}'
|
|
40
|
+
assets: 'assets/images/plantuml/'
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Notes
|
|
44
|
+
|
|
45
|
+
I'm sorry if it's sad code for a ruby developper which I'm not. I tried to do my best and to share it with the community. So please be lenient.
|
|
46
|
+
|
|
47
|
+
If you have any request, please leave a message and don't hesitate for any pull request.
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
This plugin is under the MIT license. See [LICENSE.txt](./LICENSE.txt) file for more details.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-remote-plantuml
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Patouche
|
|
@@ -59,11 +59,13 @@ executables: []
|
|
|
59
59
|
extensions: []
|
|
60
60
|
extra_rdoc_files: []
|
|
61
61
|
files:
|
|
62
|
+
- LICENSE.txt
|
|
63
|
+
- README.md
|
|
62
64
|
- lib/jekyll-remote-plantuml.rb
|
|
63
65
|
- lib/plantuml-config.rb
|
|
64
66
|
- lib/plantuml-encode64.rb
|
|
65
67
|
- lib/plantuml-loader.rb
|
|
66
|
-
homepage: http://
|
|
68
|
+
homepage: http://github.com/Patouche/jekyll-remote-plantuml
|
|
67
69
|
licenses:
|
|
68
70
|
- MIT
|
|
69
71
|
metadata: {}
|