jekyll-diagrams 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f1fe990807c62c25fe99620086be43c6ee2686466a343ca5ae3c46bc22a62b
-  data.tar.gz: be24cab35d4b8afdd58956532d200b9010d3e4ef33a1961e532b9d1a857eac41
+  metadata.gz: ba2145fe38bb652b970e45b0b4e311d9c56c8950078b0e127bf8d907a5f96061
+  data.tar.gz: 8f020319e7e68c1f47114d1f990efff6a50bda4c7bac076a617c3284ccf38951
 SHA512:
-  metadata.gz: 2852b19ce85eef87ae1e362d63047aadf101f3867c8027650c49c3f9118533ba4615a36b1f748ea16cf373ab774729f04c8870c6a15d2f2268b447e926209901
-  data.tar.gz: 448d85033efb665594918b9ef20a0827de05407757afc3440311f43e45f4d184cae890f8bfc63fd900c3ee4e092e3ceb9557c42aac01263bdbc867bd1d659154
+  metadata.gz: 521daa00f341db66db49086c50febc4c092b0f126a7777104b00d6c1072d1ee5ca6786a1bb32f19a5fa2ccad4b693c8e58986a3798e05cb3e61b4ada710e5dc1
+  data.tar.gz: fd97bc95da594fd38864c05ebf317d4b585a2173e4b76da836e84bc817ce00dc0ecc84dd8b2a26b668f65a533d077b078777938785b862252bfe66025281f7f9

data/.travis.yml

@@ -78,13 +78,4 @@ jobs:
       before_install:
         - pip3 install blockdiag seqdiag actdiag nwdiag syntrax
 
-script: bundle exec rake 'dummy_site:build[$DIAGRAM]'
-
-deploy:
-  provider: rubygems
-  api_key:
-    secure: b8mpSmo1IqW0DWhqwbZtrNWS/XIUGdLvtFuvBptdA979lpb9aDFfWaFgHnZ6IahP2djRT1yRx6fg/6cp2ZShC/FdpekeASEUn4KGz+1kNh/rfSYPQV5Cs7nkw9i2/WWmze4al5cS7IhnOr2vYXlGTZZeC6Lb+3eQHtVJYQpG3bGwg9ozyekYC2VWQdzFVAvLsjAGMEi2S5GQobbmfN5FvUZb4dnnl3crI+q0NoDkafpzZBcH8ITTZyttZDU26JIptXM5qRGZGGYSREzCc3frLpoIbAB1Vbz/A4+RF8wecsmBMOPNCPWWMvjtgkII5fHmDF/cXAnbktVzG3ECNIGmv7UPA64Mjgl9WZKZH1rujDievVz9aRryA8jIIBbbfqNZeQ+SwP3401vPLSW7yWWJdkPrFMe9+OpV47azmdTVG0PmIdPhkSOI4s3sR0BAFp6TPgaLEH1zrm3sPfLkkVD5XGfQTlI7KIS4e68qGHC2mO5LGXby8SMMp+5/+A5Pzo0dbtXtOJxNwI+iZEhNJh49Qgwc/Cd0cRbFXGWOBMNDozW95LlrDWw9rdwWE4HjuEWfwRbQGydymp+CskkKne7bz4F27UbHI0ougdekI+TaY5w6UL12rZhwbutxASLH0d+dT2OR+rC7prbJRjcwpxEFt/DwiGsVepgB8Uwge8CPSYI=
-  gem: jekyll-diagrams
-  on:
-    tags: true
-    repo: zhustec/jekyll-diagrams
+script: bundle exec rake 'dummy_site:build[$DIAGRAM]'

data/Dockerfile

@@ -10,16 +10,12 @@ RUN set -eux; \
 RUN set -eux; \
         gem update -N --system; \
         gem install -N bundler; \
-        npm install -g --silent mermaid.cli nomnoml state-machine-cat wavedrom-cli; \
+        npm install -g --silent mermaid.cli nomnoml state-machine-cat; \
+        npm install -g vega-cli vega-lite wavedrom-cli; \
         pip3 install blockdiag seqdiag actdiag nwdiag syntrax
 
 WORKDIR /opt/jekyll-diagrams
 
 COPY . .
 
-# RUN set -eux; \
-#         apt-get install -y --no-install-recommends cabal-install; \
-#         cabal update; \
-#         cabal install erd
-
-# RUN bundle install
+RUN bundle install

data/README.md

@@ -5,7 +5,9 @@
 [![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:
+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.
+
+**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.
 
 - [Installation](#installation)
 - [Configuration](#configuration)
@@ -49,7 +51,7 @@ $ bundle install
 
 ## Configuration
 
-All configurations are at `_config.yml` file under `jekyll-diagrams`, e.g:
+All configurations are under `jekyll-diagrams`, e.g:
 
 ```yaml
 jekyll-diagrams:
@@ -57,6 +59,8 @@ jekyll-diagrams:
     # configurations for graphviz
   blockdiag:
     # configurations for blockdiag
+  syntrax:
+    # configurations for syntrax
   # and so on
 ```
 
@@ -64,24 +68,23 @@ jekyll-diagrams:
 
 ### Blockdiag
 
-Blockdiag contains:
-
-* `blockdiag` : generates block diagram image
-* `seqdiag` : generates sequence diagram image
-* `actdiag` : generates activity diagram image
-* `nwdiag` : generates network diagram image
-* `rackdiag` : generates rack structure diagram
-* `packetdiag` : generates packet header diagram
-
 #### Prerequisites
 
-- Install it via pip or other methods
-- Set path properly, make sure your system can find it
+Install it.
 
 ```bash
-$ pip install blockdiag seqdiag actiag nwdiag
+$ pip3 install blockdiag seqdiag actiag nwdiag
 ```
 
+Then you can use following tags:
+
+* `blockdiag`
+* `seqdiag`
+* `actdiag`
+* `nwdiag`
+* `rackdiag`
+* `packetdiag`
+
 #### Examples
 
 ```text
@@ -110,23 +113,24 @@ seqdiag {
 
 #### Configurations
 
-```yaml
-jekyll-diagrams:
-  blockdiag:
-    antialias: true
-    config: configuration_file
-    font: your_custom_font
-    fontmap: your_custom_font
-    size: 320x400
-```
+| 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**](https://github.com/BurntSushi/erd#installation)
-- Set path properly, make sure your system can find it
+- Install Erd
+
+```bash
+$ sudo apt install graphviz cabal-install
+$ cabal update && cabal install erd
+```
 
 #### Examples
 
@@ -151,18 +155,17 @@ Person *--1 `Birth Place`
 
 #### Configurations
 
-```yaml
-jekyll-diagrams:
-  erd:
-    config: path_to_config_file
-    edge: 'one type of edge: compound, noedge, ortho, poly, spline'
-```
+| 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. Formatting will be disabled |
 
 ### Graphviz
 
 #### Prerequisites
 
-- Install it.
+Install it.
 
 #### Examples
 
@@ -185,47 +188,43 @@ digraph {
 
 #### Configurations
 
-```yaml
-jekyll-diagrams:
-  graphviz:
-    default_layout: dot
-    graph_attribute: color=red
-    node_attribute:
-      - color=blue
-      - fillcolor=red
-    edge_attribute:
-      color: red
-      fillcolor: blue
-```
+| Config             | Default     | Description                 |
+| ------------------ | ----------- | --------------------------- |
+| `default_layout`   | dot         | Set default layout engine   |
+| `graph_attributes` | unspecified | Set default graph attribute |
+| `node_attributes`  | unspecified | Set default node attribute  |
+| `edge_attributes`  | unspecified | Set default edge attribute  |
 
-- `default_layout`: Change the default layout here.
-- `graph/node/edge_attribute`: Default graph/node/edge attribute, can be String(when just one attribute), Array or Hash.
+**NOTICE:** attributes can be `String`(when just one attribute), `Array` or `Hash`.
 
 ### Mermaid
 
 #### Prerequisites
 
-- [**Install mermaid.cli**](https://github.com/mermaidjs/mermaid.cli#mermaidcli)
-- Set path properly, make sure your system can find it
+Install `mermaid.cli`.
 
-#### Configurations
-
-```yaml
-jekyll-diagrams:
-  mermaid:
-    theme: default,
-    width: 800,
-    height: 600,
-    backgroundColor: white
+```bash
+$ npm install -g mermaid.cli
 ```
 
-- `theme`: Theme of the chart, could be default, forest, dark or neutral. (default: default)
-- `width`: Width of the page. (default: 800)
-- `height`: Height of the page. (default: 600)
-- `backgroundColor`: Background color. Example: transparent, red, '#F0F0F0'. (default: white)
+#### Configurations
+
+| Config            | Default | Description                                                   |
+| ----------------- | ------- | ------------------------------------------------------------- |
+| `theme`           | default | Theme of the chart, could be default, forest, dark or neutral |
+| `width`           | 800     | Width of the page                                             |
+| `height`          | 600     | Height of the page                                            |
+| `backgroundColor` | white   | Background color. Example: transparent, red, '#F0F0F0'        |
 
 ### Nomnoml
 
+#### Prerequisites
+
+Install it.
+
+```bash
+$ npm install -g nomnoml
+```
 #### Examples
 
 ```text
@@ -257,7 +256,11 @@ jekyll-diagrams:
 
 #### Prerequisites
 
-- Java Runtime
+Install java runtime.
+
+```bash
+$ sudo apt install default-jre
+```
 
 #### Examples
 
@@ -278,9 +281,11 @@ Car -- Person : < owns
 
 #### Prerequisites
 
-- Nodejs Runtime
-- Install it `npm install [-g] state-machine-cat`
-- Set path properly, make sure your system can find it
+Install it.
+
+```bash
+$ npm install -g state-machine-cat
+```
 
 #### Examples
 
@@ -304,26 +309,44 @@ initial           => "tape player off";
 
 #### Configuration
 
-```yaml
-jekyll-diagrams:
-  smcat:
-    input-type: smcat
-    engine: dot
-    direction: top-down
+| 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 `cargo`
+- Install `svgbob_cli`
+
+```bash
+$ sudo apt install cargo
+$ cargo install svgbob_cli
 ```
 
-- `input-type`: `smcat|scxml|json` (Default: `smcat`)
-- `engine`: `dot|circo|fdp|neato|osage|twopi` (Default: `dot`)
-- `direction`: `top-down|bottom-top|left-right|right-left` (Default: `top-down`)
+#### Configuration
 
-### Svgbob
+| 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 Syntrax, Pango and PangoCairo](https://kevinpt.github.io/syntrax/#requirements)
-- Set path properly, make sure your system can find it
+- Install Pango, Cairo and PangoCairo
+- Install `syntrax`
+
+```bash
+$ sudo apt install libpango1.0-dev python3-cairo python3-gi
+$ pip3 install syntrax
+```
 
 #### Examples
 
@@ -340,18 +363,53 @@ indentstack(10,
 
 #### Configurations
 
-```yaml
-jekyll-diagrams:
-  syntrax:
-    scale: 'Scale image'
-    style: 'Style config file'
-    transparent: 'Transparent background'
-```
+| 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.
+
+#### Configurations
+
+| Config  | Default | Description         |
+| ------- | ------- | ------------------- |
+| `scale` | 1       | Scale image[Number] |
+
 ### Wavedrom
 
+#### Prerequisites
+
+Install `wavedrom-cli`.
+
+```bash
+$ npm install -g wavedrom-cli
+```
+
+#### Examples
+
+```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 %}
+```
+
 ## 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.

data/lib/jekyll-diagrams/graphviz.rb

@@ -3,9 +3,9 @@ module Jekyll
     class GraphvizBlock < Block
       CONFIGRATIONS = {
         'K' => 'default_layout',
-        'G' => 'graph_attribute',
-        'N' => 'node_attribute',
-        'E' => 'edge_attribute'
+        'G' => 'graph_attributes',
+        'N' => 'node_attributes',
+        'E' => 'edge_attributes'
       }.freeze
 
       def render_svg(code, config)

data/lib/jekyll-diagrams/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Diagrams
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - zhustec
@@ -139,7 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, PlantUML