README.md in jekyll-diagrams-0.4.2 vs README.md in jekyll-diagrams-0.5.0
- old
+ new
@@ -1,10 +1,9 @@
# Jekyll Diagrams
[![Travis](https://img.shields.io/travis/zhustec/jekyll-diagrams.svg?style=flat-square)](https://travis-ci.com/zhustec/jekyll-diagrams)
[![Gem](https://img.shields.io/gem/v/jekyll-diagrams.svg?style=flat-square)](https://rubygems.org/gems/jekyll-diagrams)
-[![Coveralls github](https://img.shields.io/coveralls/github/zhustec/jekyll-diagrams/master.svg?style=flat-square)](https://coveralls.io/github/zhustec/jekyll-diagrams)
[![Depfu](https://img.shields.io/depfu/zhustec/jekyll-diagrams.svg?style=flat-square)](https://depfu.com/repos/zhustec/jekyll-diagrams)
[![license](https://img.shields.io/github/license/zhustec/jekyll-diagrams.svg?style=flat-square)](https://github.com/zhustec/jekyll-diagrams/blob/master/LICENSE)
Jekyll Diagrams is a jekyll plugins for creating amazing diagrams, including:
@@ -82,11 +81,11 @@
D [shape=doublecircle, fillcolor=green];
S -> A [label=a];
S -> B [label=b];
A -> D [label=c];
B -> D [label=d];
-{% endgraphviz %}
+{% enddigraph %}
```
### Blockdiag
Blockdiag contains:
@@ -130,18 +129,19 @@
{% endseqdiag %}
```
## Configuration
-A simple configuration shows below:
+You need to provide a configuration.
+A simple configuration is shown below:
```yaml
diagrams:
graphviz:
engine: dot
options: '-Tsvg'
- diag:
+ blockdiag:
options: '-Tsvg --nodoctype'
```
### Graphviz
@@ -162,14 +162,14 @@
B -> D [label=d];
}
{% endgraphviz %}
```
-`options` is the command line options, and will be appended to the command. Default is set to '-Tsvg'.
+`options` is the command line options, and will be appended to the command.
-### Blockiag
+### Blockdiag
-`options` is the command line options, and will be appended to the command. Default is set to '-Tsvg --nodoctype'.
+`options` is the command line options, and will be appended to the command.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/zhustec/jekyll-diagrams. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.