jekyll-diagrams 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939c351c21994ececde693c60b108ddd81d8fd98f3dacc11a7722b8972f294bf
-  data.tar.gz: cb597bafa191ce822a239ab565718ae4efce683204bd45a39ed4e61f656e6b91
+  metadata.gz: 50b1e58e8ce58f22fef54776c2413abafc5ee1ee16b8ceecd84cf64b8bdfb25c
+  data.tar.gz: e440f946189747d473e4d0cca362a4732b7d1e2fcac94c91d8f0c63e1aaf416b
 SHA512:
-  metadata.gz: f19c1dd680ffdd9f11af3ea082e38759d120b63d163ecd9bba19ab27cfd185c08eca82ee036ae9f675597ccd58db60eabecac8abb9d0dfdf7f78b312ecc1e6fa
-  data.tar.gz: f6675947274f26d32558e06446ed3617fda8c183287aa54df9835df9446fccdcbb1d8eb7fa3126751ba70192f0e5de1b3b4362ccbf46fe4bb60eebe17a4130c4
+  metadata.gz: f62eab1353bd18378dc8b53ade153079fa4b9d99f032a81f5a7130fc15e86fb2727495eaff9e780d48fb8dfb4fc009c6d0d5ecdb1f226e65356da3546d7a615a
+  data.tar.gz: 48ab6a18cf4f93ac5ad50368674c2fb06a0b5ad134f51cadaa46355683751e79dad0e1edf8db60e2a66842c750a7352e49539842cd1ce826f8274be0dc943275

data/.travis.yml

@@ -10,11 +10,15 @@ addons:
   apt:
     packages:
       - default-jre
+      - gnuplot
       - graphviz
+      - node
+      - npm
       - python3
       - python3-pip
       - python3-setuptools
 
 before_install:
   - sudo pip3 install blockdiag seqdiag actdiag nwdiag
-  - gem update --system && gem install bundler
+  - gem update --system && gem install bundler
+  - npm install -g wavedrom-cli mermaid.cli

data/README.md

@@ -1,15 +1,19 @@
 # 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)
+[![Travis](https://img.shields.io/travis/zhustec/jekyll-diagrams.svg?style=flat-square)](https://travis-ci.com/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:
 
+- Blockdiag(Blockdia, Seqdiag, Actdiag, Nwdiag, Rackdiag and Packatdiag)
+- Erd
 - Graphviz
-- Blockdiag, Seqdiag, Actdiag and Nwdiag
+- Mermaid
 - PlantUML
+- State Machine cat
+- Syntrax
 
 ## Installation
 
@@ -44,47 +48,6 @@ plugins:
 
 ## Usage
 
-### Graphviz
-
-You need first install graphviz with package manager on your system. Then you can use `graphviz` Liquid Tag to create amazing Graphviz images!
-
-```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 %}
-```
-
-#### Configuration
-
-A simple configuration example is shown below:
-
-```yaml
-jekyll-diagrams:
-  graphviz:
-    default_layout: dot
-    graph_attribute: color=red
-    node_attribute:
-      - color=blue
-      - fillcolor=red
-    edge_attribute:
-      color: red
-      fillcolor: blue
-```
-
-- `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.
-
 ### Blockdiag
 
 Blockdiag contains:
@@ -96,7 +59,16 @@ Blockdiag contains:
 * `rackdiag` : generates rack structure diagram
 * `packetdiag` : generates packet header diagram
 
-You need first install it and set path properly to make sure your system can find it. Then you can use `blockdiag`, `seqdiag`, `actdiag`, `nwdiag`, `rackdiag`, `packetdiag` Liquid Tag.
+#### Prerequisites
+
+- Install it via pip or other methods
+- Set path properly, make sure your system can find it
+
+```bash
+$ pip install blockdiag seqdiag actiag nwdiag
+```
+
+#### Examples
 
 ```text
 {% blockdiag %}
@@ -122,7 +94,7 @@ seqdiag {
 {% endseqdiag %}
 ```
 
-#### Configuration
+#### Configurations
 
 ```yaml
 jekyll-diagrams:
@@ -134,8 +106,116 @@ jekyll-diagrams:
     size: 320x400
 ```
 
+### Erd
+
+#### Prerequisites
+
+- Install Graphviz
+- [**Install Erd**](https://github.com/BurntSushi/erd#installation)
+
+#### 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
+
+```yaml
+jekyll-diagrams:
+  erd:
+    config: path_to_config_file
+    edge: 'one type of edge: compound, noedge, ortho, poly, spline'
+```
+
+### 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
+
+```yaml
+jekyll-diagrams:
+  graphviz:
+    default_layout: dot
+    graph_attribute: color=red
+    node_attribute:
+      - color=blue
+      - fillcolor=red
+    edge_attribute:
+      color: red
+      fillcolor: blue
+```
+
+- `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.
+
+### Mermaid
+
+#### Prerequisites
+
+- [**Install mermaid.cli**](https://github.com/mermaidjs/mermaid.cli#mermaidcli)
+
+#### Configurations
+
+```yaml
+jekyll-diagrams:
+  mermaid:
+    theme: default,
+    width: 800,
+    height: 600,
+    backgroundColor: white
+```
+
+- `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)
+
 ### PlantUML
 
+#### Prerequisites
+
+- Java Runtime
+
+#### Examples
+
 ```text
 {% plantuml %}
 @startuml
@@ -149,6 +229,77 @@ Car -- Person : < owns
 {% endplantuml %}
 ```
 
+### State Machine cat
+
+#### Prerequisites
+
+- Nodejs Runtime
+- Install it `npm install [-g] state-machine-cat`
+- Set path
+
+#### 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
+
+```yaml
+jekyll-diagrams:
+  smcat:
+    input-type: smcat
+    engine: dot
+    direction: top-down
+```
+
+- `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")
+
+### Syntrax
+
+#### Prerequisites
+
+- [Install it with Pango and PangoCairo](https://kevinpt.github.io/syntrax/#requirements)
+
+#### 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
+
+```yaml
+jekyll-diagrams:
+  syntrax:
+    scale: 'Scale image'
+    style: 'Style config file'
+    transparent: 'Transparent background'
+```
+
 ## 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/block.rb

@@ -17,7 +17,7 @@ module Jekyll
       end
       
       def wrap_class(content)
-        "<div class='diagrams #{block_name}'>#{content}</div>"
+        "<div class='jekyll-diagrams diagrams #{block_name}'>#{content}</div>"
       end
     end
   end

data/lib/jekyll-diagrams/blockdiag.rb

@@ -7,7 +7,7 @@ module Jekyll
       def render_svg(code, config)
         command = build_command(config)
         
-        render_with_tempfile(command, code, :svg) do |command, input, output|
+        render_with_tempfile(command, code) do |command, input, output|
           "#{command} #{input} -o #{output}"
         end
       end
@@ -18,16 +18,10 @@ module Jekyll
 
       def build_command(config)
         command = "#{block_name} -Tsvg --nodoctype"
+        command << ' --antialias' if config.has_key?('antialias')
 
-        antialias = config.fetch('antialias', false)
-
-        if antialias && antialias != 'false'
-          command << ' --antialias'
-        end
-
-        %w(config font fontmap size).each do |key|
-          value = config.fetch(key, nil)
-          command << " --#{key}=#{value}" if value
+        %w(config font fontmap size).each do |conf|
+          command << " --#{conf}=#{config[conf]}" if config.has_key?(conf)
         end
 
         command

data/lib/jekyll-diagrams/erd.rb

@@ -0,0 +1,21 @@
+module Jekyll
+    module Diagrams
+      class ErdBlock < Block
+        def render_svg(code, config)
+          render_with_stdin_stdout(build_command(config), code)
+        end
+  
+        def build_command(config)
+          command = 'erd --fmt=svg'
+
+          %w(config edge).each do |conf|
+            command << " --#{conf}=#{config[conf]}" if config.has_key?(conf)
+          end
+
+          command
+        end
+      end
+    end
+  end
+  
+  Liquid::Template.register_tag(:erb, Jekyll::Diagrams::ErdBlock)

data/lib/jekyll-diagrams/mermaid.rb

@@ -0,0 +1,31 @@
+module Jekyll
+    module Diagrams
+      class MermaidBlock < Block
+        CONFIGURATIONS = {
+          'theme' => 'default',
+          'width' => 800,
+          'height' => 600,
+          'backgroundColor' => 'white'
+        }.freeze
+
+        def render_svg(code, config)
+          render_with_tempfile(build_command(config), code) do |command, input, output|
+            "#{command} --input #{input} --output #{output}"
+          end
+        end
+  
+        def build_command(config)
+          command = 'mmdc'
+          command << ' --transparent' if config.has_key?('transparent')
+
+          CONFIGURATIONS.merge(config).each do |conf, value|
+            command << " --#{conf} #{value}"
+          end
+
+          command
+        end
+      end
+    end
+  end
+  
+  Liquid::Template.register_tag(:mermaid, Jekyll::Diagrams::MermaidBlock)

data/lib/jekyll-diagrams/renderer.rb

@@ -10,8 +10,8 @@ module Jekyll
         render_with_command(command, :stdout, stdin_data: content, binmode: true)
       end
 
-      def render_with_stdin(command, content, format)
-        Tempfile.open(['jekyll_diagrams_output', ".#{format}"]) do |output|
+      def render_with_stdin(command, content)
+        Tempfile.open(['jekyll_diagrams_output', ".svg"]) do |output|
           output.close
           command = yield command, output.path
 
@@ -19,11 +19,11 @@ module Jekyll
         end
       end
 
-      def render_with_tempfile(command, content, format)
+      def render_with_tempfile(command, content)
         Tempfile.open('jekyll_diagrams_input') do |input|
           File.write(input.path, content)
           
-          Tempfile.open(['jekyll_diagrams_output', ".#{format}"]) do |output|
+          Tempfile.open(['jekyll_diagrams_output', ".svg"]) do |output|
             output.close
             command = yield command, input.path, output.path
 

data/lib/jekyll-diagrams/smcat.rb

@@ -0,0 +1,31 @@
+module Jekyll
+    module Diagrams
+      class SMCatBlock < Block
+        CONFIGURATIONS = {
+          'input-type' => 'smcat',
+          'engine' => 'dot',
+          'direction' => 'top-down'
+        }.freeze
+
+        def render_svg(code, config)
+          svg = render_with_tempfile(build_command(config), code) do |command, input, output|
+            "#{command} #{input} --output-to #{output}"
+          end
+
+          svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
+        end
+  
+        def build_command(config)
+          command = 'smcat'
+
+          CONFIGURATIONS.merge(config).each do |conf, value|
+            command << " --#{conf} #{value}"
+          end
+
+          command
+        end
+      end
+    end
+  end
+  
+  Liquid::Template.register_tag(:smcat, Jekyll::Diagrams::SMCatBlock)

data/lib/jekyll-diagrams/syntrax.rb

@@ -0,0 +1,23 @@
+module Jekyll
+    module Diagrams
+      class SyntraxBlock < Block
+        def render_svg(code, config)
+          render_with_tempfile(build_command(config), code) do |command, input, output|
+            "#{command} --input #{input} --output #{output}"
+          end
+        end
+  
+        def build_command(config)
+          command = 'syntrax'
+
+          %w(scale style).each do |conf|
+            command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
+          end
+
+          command
+        end
+      end
+    end
+  end
+  
+  Liquid::Template.register_tag(:syntrax, Jekyll::Diagrams::SyntraxBlock)

data/lib/jekyll-diagrams/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Diagrams
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/jekyll-diagrams/wavedrom.rb

@@ -0,0 +1,17 @@
+module Jekyll
+    module Diagrams
+      class WavedromBlock < Block
+        def render_svg(code, config)
+          render_with_tempfile(build_command(config), code) do |command, input, output|
+            "#{command} --input #{input} --svg #{output}"
+          end
+        end
+  
+        def build_command(config)
+          'wavedrom-cli'
+        end
+      end
+    end
+  end
+  
+  Liquid::Template.register_tag(:wavedrom, Jekyll::Diagrams::WavedromBlock)

data/lib/jekyll-diagrams.rb

@@ -1,6 +1,11 @@
 require_relative 'jekyll-diagrams/util'
 require_relative 'jekyll-diagrams/renderer'
 require_relative 'jekyll-diagrams/block'
+
 require_relative 'jekyll-diagrams/blockdiag'
+require_relative 'jekyll-diagrams/erd'
 require_relative 'jekyll-diagrams/graphviz'
-require_relative 'jekyll-diagrams/plantuml'
+require_relative 'jekyll-diagrams/mermaid'
+require_relative 'jekyll-diagrams/plantuml'
+require_relative 'jekyll-diagrams/smcat'
+require_relative 'jekyll-diagrams/wavedrom'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - zhustec
@@ -89,11 +89,16 @@ files:
 - lib/jekyll-diagrams.rb
 - lib/jekyll-diagrams/block.rb
 - lib/jekyll-diagrams/blockdiag.rb
+- lib/jekyll-diagrams/erd.rb
 - lib/jekyll-diagrams/graphviz.rb
+- lib/jekyll-diagrams/mermaid.rb
 - lib/jekyll-diagrams/plantuml.rb
 - lib/jekyll-diagrams/renderer.rb
+- lib/jekyll-diagrams/smcat.rb
+- lib/jekyll-diagrams/syntrax.rb
 - lib/jekyll-diagrams/util.rb
 - lib/jekyll-diagrams/version.rb
+- lib/jekyll-diagrams/wavedrom.rb
 - test/test_helper.rb
 - vendor/plantuml.1.2020.1.jar
 homepage: https://github.com/zhustec/jekyll-diagrams