jekyll-diagrams 0.10.0 → 0.11.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e747a50f5b7243d7385068b039987f6a562423a2de58c5fca5a6ba2b0e3f5fcd
-  data.tar.gz: 2d2e9080efbefdea34b81df49e7b47c01ebdc753571317754ae1bfb4e28a6e0f
+  metadata.gz: 4c05ad5b891c49be889b0cd7863bb51749df89d60e3e7ceef2082352592f685b
+  data.tar.gz: bb6b9315eac3c9df5302c9bf60775ffd6d76f794b4aba25ec89867b85af56fcd
 SHA512:
-  metadata.gz: dce4156ef2128881613b401747c9a32c17e0ac56f420e6359f32cb6c39478a5a39d807b2ed615e27f00b4ce0f357a2d3a444f50651247684f990769d0fc5a78e
-  data.tar.gz: 7d987eb136d804ce0023abe94f6acf48557063c96f9e94e11e082b65a3075d1f5fdd40d784fc682d1928bd63bc95a02fd041c8f5f782bf40303b8544bbef6edf
+  metadata.gz: a914e01964f644feae896ad105aa9867907d24b882cc786f08261897c488190d7c01f540f9946ee22e0bdf64db6d3890a018751c390a0086a10ee68aaff8caba
+  data.tar.gz: 025a693b41afd79be7a3f0e3b321a3b52f9c554d6b5cd4090525b935e159f203243d830d2beb5a078ad3f115f81cb5eefce6574a48eadebb1003aa36ef1f1f80

data/README.md

@@ -2,12 +2,26 @@
 
 [![Gem](https://img.shields.io/gem/v/jekyll-diagrams.svg?label=Gem&style=flat-square)](https://rubygems.org/gems/jekyll-diagrams)
 [![Test](https://img.shields.io/github/workflow/status/zhustec/jekyll-diagrams/Test?label=Test&style=flat-square)](https://github.com/zhustec/jekyll-diagrams/actions?query=workflow%3ATest)
-[![Travis](https://img.shields.io/travis/zhustec/jekyll-diagrams.svg?label=Travis&style=flat-square)](https://travis-ci.com/zhustec/jekyll-diagrams)
+[![Feature](https://img.shields.io/travis/com/zhustec/jekyll-diagrams.svg?label=Feature&style=flat-square)](https://travis-ci.com/zhustec/jekyll-diagrams)
 [![Linter](https://img.shields.io/github/workflow/status/zhustec/jekyll-diagrams/Linter?label=Linter&style=flat-square)](https://github.com/zhustec/jekyll-diagrams/actions?query=workflow%3ALinter)
 [![Coverage](https://img.shields.io/coveralls/github/zhustec/jekyll-diagrams?label=Coverage&style=flat-square)](https://coveralls.io/github/zhustec/jekyll-diagrams)
 [![License](https://img.shields.io/github/license/zhustec/jekyll-diagrams.svg?label=License&style=flat-square)](https://github.com/zhustec/jekyll-diagrams/blob/master/LICENSE)
 
-Jekyll Diagrams is a jekyll plugins for creating diagrams, currently support for [**Blockdiag**](http://blockdiag.com/en/), [**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/), [**Vega-Lite**](https://vega.github.io/vega-lite/) and [**WaveDrom**](https://wavedrom.com/). More diagrams support will be added in future versions.
+Jekyll Diagrams is a jekyll plugins for creating diagrams, it is inspired by [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram). Currently support:
+
+- [**Blockdiag**](http://blockdiag.com/en/)
+- [**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/)
+- [**Vega-Lite**](https://vega.github.io/vega-lite/)
+- [**WaveDrom**](https://wavedrom.com/).
+
+**WARNING:** Since it is just 0.x.x currently, internal implementation maybe **CHANGED FREQUENTLY**. So don't rely on the internal implementation unless you know what you are doing.
 
 **NOTICE:** This plugin render **SVG** format image and directly **embed into html file**, so you don't need to worry about where to store the image. But, please feel free to tell me if you **unlikely** want other image format.
 
@@ -15,19 +29,9 @@ Jekyll Diagrams is a jekyll plugins for creating diagrams, currently support for
 - [Configurations](#configurations)
   - [Error Mode](#error-mode)
 - [Usage](#usage)
-  - [Blockdiag](#blockdiag)
-  - [Erd](#erd)
-  - [Graphviz](#graphviz)
-  - [Mermaid](#mermaid)
-  - [Nomnoml](#nomnoml)
-  - [PlantUML](#plantuml)
-  - [State Machine Cat](#state-machine-cat)
-  - [Svgbob](#svgbob)
-  - [Syntrax](#syntrax)
-  - [Vega](#vega)
-  - [Wavedrom](#wavedrom)
 - [Contributing](#contributing)
 - [License](#license)
+- [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -49,7 +53,7 @@ end
 Finally run:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ## Configurations
@@ -103,407 +107,18 @@ jekyll-diagrams:
   error_mode: 'mode'
 ```
 
-## Usage
-
-### Blockdiag
-
-#### Prerequisites
-
-Install it.
-
-```bash
-$ pip3 install blockdiag seqdiag actiag nwdiag
-```
-
-Then you can use following tags:
-
-* `blockdiag`
-* `seqdiag`
-* `actdiag`
-* `nwdiag`
-* `rackdiag`
-* `packetdiag`
-
-#### Examples
-
-```text
-{% blockdiag %}
-blockdiag {
-   A -> B -> C -> D;
-   A -> E -> F -> G;
-}
-{% endblockdiag %}
-```
-
-And `seqdiag`:
-
-```text
-{% seqdiag %}
-seqdiag {
-  browser  -> webserver [label = "GET /index.html"];
-  browser <-- webserver;
-  browser  -> webserver [label = "POST /blog/comment"];
-              webserver  -> database [label = "INSERT comment"];
-              webserver <-- database;
-  browser <-- webserver;
-}
-{% endseqdiag %}
-```
-
-#### Configurations
-
-| Config      | Default     | Description                             |
-| ----------- | ----------- | --------------------------------------- |
-| `antialias` | unspecified | Pass diagram image to anti-alias filter |
-| `font`      | unspecified | use FONT to draw diagram                |
-| `fontmap`   | unspecified | use FONTMAP file to draw diagram        |
-| `size`      | unspecified | Size of diagram (ex. 320x240)           |
-
-### Erd
-
-#### Prerequisites
-
-- Install Graphviz
-- Install Erd
-
-```bash
-$ sudo apt install graphviz cabal-install
-$ cabal update && cabal install erd
-```
-
-#### Examples
-
-```text
-{% erd %}
-[Person]
-*name
-height
-weight
-`birth date`
-+birth_place_id
-
-[`Birth Place`]
-*id
-`birth city`
-'birth state'
-"birth country"
-
-Person *--1 `Birth Place`
-{% enderd %}
-```
-
-#### Configurations
-
-| Config       | Default     | Description                                                                |
-| ------------ | ----------- | -------------------------------------------------------------------------- |
-| `config`     | unspecified | Configuration file                                                         |
-| `edge`       | unspecified | Select one type of edge: compound, noedge, ortho, poly, spline             |
-| `dot-entity` | unspecified | When set, output will consist of regular dot tables instead of HTML tables |
-
-### Graphviz
-
-#### Prerequisites
-
-Install it.
-
-#### Examples
-
-```text
-{% graphviz %}
-digraph {
-  node [shape=circle, style=filled];
-  S [fillcolor=green];
-  A [fillcolor=yellow];
-  B [fillcolor=yellow];
-  C [fillcolor=yellow];
-  D [shape=doublecircle, fillcolor=green];
-  S -> A [label=a];
-  S -> B [label=b];
-  A -> D [label=c];
-  B -> D [label=d];
-}
-{% endgraphviz %}
-```
-
-#### Configurations
-
-| Config             | Default     | Description                  |
-| ------------------ | ----------- | ---------------------------- |
-| `default_layout`   | dot         | Set layout engine            |
-| `graph_attributes` | unspecified | Set default graph attributes |
-| `node_attributes`  | unspecified | Set default node attributes  |
-| `edge_attributes`  | unspecified | Set default edge attributes  |
-| `encoding`         | utf-8       | Set default SVG encoding     |
-
-**NOTICE:** attributes can be `String`(when just one attribute), `Array` or `Hash`.
-
-### Mermaid
-
-#### Prerequisites
-
-Install `mermaid.cli`.
-
-```bash
-$ npm install -g mermaid.cli
-```
-
-**Notice:** You may need to install some missing libraries, follow the output of `mmdc`.
-
-#### Examples
-
-```text
-{% mermaid %}
-sequenceDiagram
-    participant John
-    participant Alice
-    Alice->>John: Hello John, how are you?
-    John-->>Alice: Great!
-{% endmermaid %}
-```
-
-#### Configurations
-
-| Config            | Default | Description                                                   |
-| ----------------- | ------- | ------------------------------------------------------------- |
-| `width`           | 800     | Width of the page                                             |
-| `height`          | 600     | Height of the page                                            |
-| `backgroundColor` | white   | Background color. Example: transparent, red, '#F0F0F0'        |
-| `theme`           | default | Theme of the chart, could be default, forest, dark or neutral |
-
-### Nomnoml
-
-#### Prerequisites
-
-Install it.
-
-```bash
-$ npm install -g nomnoml
-```
-#### Examples
-
-```text
-{% nomnoml %}
-[Pirate|eyeCount: Int|raid();pillage()|
-  [beard]--[parrot]
-  [beard]-:>[foul mouth]
-]
-
-[<abstract>Marauder]<:--[Pirate]
-[Pirate]- 0..7[mischief]
-[jollyness]->[Pirate]
-[jollyness]->[rum]
-[jollyness]->[singing]
-[Pirate]-> *[rum|tastiness: Int|swig()]
-[Pirate]->[singing]
-[singing]<->[rum]
-
-[<start>st]->[<state>plunder]
-[plunder]->[<choice>more loot]
-[more loot]->[st]
-[more loot] no ->[<end>e]
-
-[<actor>Sailor] - [<usecase>shiver me;timbers]
-{% endnomnoml %}
-```
-
-### PlantUML
-
-#### Prerequisites
-
-Install java runtime.
-
-```bash
-$ sudo apt install default-jre
-```
-
-#### Examples
-
-```text
-{% plantuml %}
-@startuml
-class Car
-
-Driver - Car : drives >
-Car *- Wheel : have 4 >
-Car -- Person : < owns
-
-@enduml
-{% endplantuml %}
-```
-
-### State Machine Cat
-
-#### Prerequisites
-
-Install it.
-
-```bash
-$ npm install -g state-machine-cat
-```
-
-#### Examples
-
-```text
-{% smcat %}
-initial,
-"tape player off",
-"tape player on" {
-  stopped => playing : play;
-  playing => stopped : stop;
-  playing => paused  : pause;
-  paused  => playing : pause;
-  paused  => stopped : stop;
-};
-
-initial           => "tape player off";
-"tape player off" => stopped           : power;
-"tape player on"  => "tape player off" : power;
-{% endsmcat %}
-```
-
-#### Configuration
-
-| Config       | Default    | Description                                                                         |
-| ------------ | ---------- | ----------------------------------------------------------------------------------- |
-| `input-type` | `smcat`    | Input type. `smcat scxml json`                                                      |
-| `engine`     | `dot`      | Layout engine to use. `dot circo fdp neato osage twopi`                             |
-| `direction`  | `top-down` | Direction of the state machine diagram. `top-down bottom-top left-right right-left` |
-
-### Svgbob
-
-#### Prerequisites
-
-Install `svgbob_cli`.
-
-```bash
-$ sudo apt install cargo
-$ cargo install svgbob_cli
-```
-
-#### Examples
-
-```text
-{% svgbob %}
-                           .--->  F
-  A       B      C  D     /
-  *-------*-----*---*----*----->  E
-           \            ^ \
-            v          /   '--->  G
-             B --> C -'
-{% endsvgbob %}
-```
-
-#### Configuration
-
-| Config         | Default | Description                                                |
-| -------------- | ------- | ---------------------------------------------------------- |
-| `font-family`  | arial   | Font                                                       |
-| `font-size`    | 12      | Font size                                                  |
-| `scale`        | 1       | Scale the entire svg (dimensions, font size, stroke width) |
-| `stroke-width` | 2       | stroke width for all lines                                 |
-
-### Syntrax
-
-#### Prerequisites
-
-- Install Pango, Cairo and PangoCairo support
-- Install `syntrax`
-
-```bash
-$ sudo apt install libpango1.0-dev python3-cairo python3-gi python3-gi-cairo
-$ pip3 install syntrax
-```
-
-#### Examples
-
-```text
-{% syntrax %}
-indentstack(10,
-  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
-    opt('.', loop('0-9', None))),
-
-  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
-)
-{% endsyntrax %}
-```
-
-#### Configurations
-
-| Config        | Default     | Description            |
-| ------------- | ----------- | ---------------------- |
-| `scale`       | 1           | Scale image            |
-| `style`       | unspecified | Style config file      |
-| `transparent` | false       | Transparent background |
-
-### Vega
-
-#### Prerequisites
-
-Install `vega-cli` and `vega-lite`.
-
-```bash
-$ npm install -g vega-cli vega-lite
-```
-
-The you can use `vega` and `vegalite` tag.
-
-
-#### Examples
-
-```text
-{% vegalite %}
-{
-  "": "https://vega.github.io/schema/vega-lite/v4.json",
-  "description": "A simple bar chart with embedded data.",
-  "data": {
-    "values": [
-      {"a": "A", "b": 28}, {"a": "B", "b": 55}, {"a": "C", "b": 43},
-      {"a": "D", "b": 91}, {"a": "E", "b": 81}, {"a": "F", "b": 53},
-      {"a": "G", "b": 19}, {"a": "H", "b": 87}, {"a": "I", "b": 52}
-    ]
-  },
-  "mark": "bar",
-  "encoding": {
-    "x": {"field": "a", "type": "ordinal"},
-    "y": {"field": "b", "type": "quantitative"}
-  }
-}
-{% endvegalite %}
-```
-
-#### Configurations
-
-| Config  | Default | Description         |
-| ------- | ------- | ------------------- |
-| `scale` | 1       | Scale image[Number] |
-
-### Wavedrom
-
-#### Prerequisites
-
-Install `wavedrom-cli`.
-
-```bash
-$ npm install -g wavedrom-cli
-```
-
-#### Examples
+## Configurations
 
-```text
-{% wavedrom %}
-{signal: [
-  {name: 'clk', wave: 'p.....|...'},
-  {name: 'dat', wave: 'x.345x|=.x', data: ['head', 'body', 'tail', 'data']},
-  {name: 'req', wave: '0.1..0|1.0'},
-  {name: 'ack', wave: '1.....|01.'}
-]}
-{% endwavedrom %}
-```
+Form more configurations please refer to [Liquid Diagrams](https://github.com/zhustec/liquid-diagrams)
 
 ## 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.
+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 [code of conduct](https://github.com/zhustec/jekyll-diagrams/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `jekyll-diagrams` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).