README.md in liquid-diagrams-0.3.0 vs README.md in liquid-diagrams-0.4.0
- old
+ new
@@ -5,27 +5,12 @@
[](https://travis-ci.com/zhustec/liquid-diagrams)
[](https://github.com/zhustec/liquid-diagrams/actions?query=workflow%3ALint)
[](https://coveralls.io/github/zhustec/liquid-diagrams)
[](https://github.com/zhustec/liquid-diagrams/blob/master/LICENSE)
-Liquid Diagrams is a liquid plugins for creating diagrams, it is inspired by [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram). Currently support:
+Liquid Diagrams is a liquid plugins for rendering svg diagrams, it is inspired by [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram). Currently support: [**Blockdiag**](http://blockdiag.com/en/), [**Bitfield**](https://github.com/wavedrom/bitfield), [**Erd**](https://github.com/BurntSushi/erd), [**GraphViz**](http://graphviz.org/), [**Mermaid**](https://mermaid-js.github.io/mermaid/), [**Nomnoml**](http://nomnoml.com/), [**Netlistsvg**](https://github.com/nturley/netlistsvg), [**PlantUML**](https://plantuml.com/), [**Svgbob**](https://ivanceras.github.io/svgbob-editor/), [**Syntrax**](https://kevinpt.github.io/syntrax/), [**Vega**](https://vega.github.io/vega/), [**Vegalite**](https://vega.github.io/vega-lite/), [**Wavedrom**](https://wavedrom.com/).
-- [**Blockdiag**](http://blockdiag.com/en/)
-- [**Bitfield**](https://github.com/wavedrom/bitfield)
-- [**Erd**](https://github.com/BurntSushi/erd)
-- [**GraphViz**](http://graphviz.org/)
-- [**Mermaid**](https://mermaid-js.github.io/mermaid/)
-- [**Nomnoml**](http://nomnoml.com/)
-- [**PlantUML**](https://plantuml.com/)
-- [**Svgbob**](https://ivanceras.github.io/svgbob-editor/)
-- [**Syntrax**](https://kevinpt.github.io/syntrax/)
-- [**Vega**](https://vega.github.io/vega/)
-- [**Vegalite**](https://vega.github.io/vega-lite/)
-- [**Wavedrom**](https://wavedrom.com/).
-
-**NOTE:** This project is under development currently.
-
- [Installation](#installation)
- [Usage](#usage)
- [Supported diagrams](#supported-diagrams)
- [Register diagrams](#register-diagrams)
- [Use diagrams tag](#use-diagrams-tag)
@@ -35,16 +20,18 @@
- [Blockdiag](#blockdiag)
- [Bitfield](#bitfield)
- [Erd](#erd)
- [Graphviz](#graphviz)
- [Mermaid](#mermaid)
+ - [Netlistsvg](#netlistsvg)
- [Nomnoml](#nomnoml)
- [PlantUML](#plantuml)
- [State Machine Cat](#state-machine-cat)
- [Svgbob](#svgbob)
- [Syntrax](#syntrax)
- [Vega](#vega)
+ - [Vegalite](#vegalite)
- [Wavedrom](#wavedrom)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
@@ -159,10 +146,12 @@
You still need to install some dependencies, please refer to [Prerequisites](Prerequisites.md).
## Configurations
+**Warning:** All default configuration are provided by upstream, so it maybe different from here.
+
### Blockdiag
| Config | Type | Default | Description |
| ----------- | ------------- | ----------- | --------------------------------------- |
| `antialias` | `boolean` | unspecified | Pass diagram image to anti-alias filter |
@@ -216,10 +205,14 @@
| `width` | `int` | 800 | Width of the page |
| `height` | `int` | 600 | Height of the page |
| `backgroundColor` | `string` | white | Background color |
| `theme` | `string` | default | Theme of the chart |
+### Netlistsvg
+
+Currently no configurations
+
### Nomnoml
Currently no configurations
### PlantUML
@@ -256,9 +249,15 @@
| `scale` | `int` | 1 | Scale image |
| `style` | `string` | unspecified | Style config file |
| `transparent` | `boolean` | unspecified | Transparent background |
### Vega
+
+| Config | Type | Default | Description |
+| ------- | ----- | ------- | ----------- |
+| `scale` | `int` | 1 | Scale image |
+
+### Vegalite
| Config | Type | Default | Description |
| ------- | ----- | ------- | ----------- |
| `scale` | `int` | 1 | Scale image |