jekyll-diagrams 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2acdd1cfd11996e6bff65f52ec3b305401bc7bee
-  data.tar.gz: 41e77e050c03a246f752faa4333db6d4e2e3b09d
+  metadata.gz: 2f9a02b6f4fc3193e404f44742644052dc32945c
+  data.tar.gz: b48381286520b33e927760edd67fd5cd8449a71f
 SHA512:
-  metadata.gz: 69b4859fd220a7efc77d4d218c892bff96d9d3869f1ade3499220161fcff08d7d4d6624db75e44b01b375ae90caef1441b831496fabf77c21379578bc870d6f8
-  data.tar.gz: a4fe990ece18cca948f9d5ad2cdea1604fedbfd17884ca9d170ff84170fe7ab2aaf75929b47f82720739638b2cfd341c7c7be8a3958a91795d32926b111a3757
+  metadata.gz: ba738682197288298ee956e952fee4a5e5aa31b0d19a8d7918c80c42c9c9b318151a160e3d8fceae6995edf157d8723ff3084b7abd862e1682e8bbacc0c93da1
+  data.tar.gz: e3a702f169a966278106854b8ae8be7eeef6786471d69e06f017a408a23fde6c9a878cba7915adbae0a27b8911b999818c1c6ce3719ac655825fa319143759c8

data/README.md

@@ -1,40 +1,178 @@
-# Jekyll::Diagrams
+# Jekyll Diagrams
 
-[![Build Status](https://travis-ci.org/farkasity/jekyll-diagrams.svg?branch=master)](https://travis-ci.org/farkasity/jekyll-diagrams.svg?branch=master)
+[![Build Status](https://travis-ci.org/farkasity/jekyll-diagrams.svg?branch=master)](https://travis-ci.org/farkasity/jekyll-diagrams.svg)
 [![Build status](https://ci.appveyor.com/api/projects/status/f5l7k3971pmjbjcq?svg=true)](https://ci.appveyor.com/project/farkasity/jekyll-diagrams)
 [![Dependency Status](https://gemnasium.com/farkasity/jekyll-diagrams.svg)](https://gemnasium.com/farkasity/jekyll-diagrams)
 [![Code Climate](https://codeclimate.com/github/farkasity/jekyll-diagrams/badges/gpa.svg)](https://codeclimate.com/github/farkasity/jekyll-diagrams)
 [![Inline Docs](https://inch-ci.org/github/farkasity/jekyll-diagrams.svg)](https://inch-ci.org/github/farkasity/jekyll-diagrams)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/diagrams`. To experiment with that code, run `bin/console` for an interactive prompt.
+Jekyll Diagrams is a jekyll plugins for creating amazing diagrams, including:
+
+- Graphviz
+- Blockdiag, Seqdiag, Actdiag and Nwdiag
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### When using bundler
+
+Add these lines to your application's `Gemfile` file:
 
 ```ruby
-gem 'jekyll-diagrams'
+group :jekyll_plugins do
+  gem 'jekyll-diagrams'
+end
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
+
+### Or installing manually
 
-Or install it yourself as:
+```bash
+$ gem install jekyll-diagrams
+```
 
-    $ gem install jekyll-diagrams
+And then add this line to your application's `_config.yml` file:
+
+```yaml
+gems:
+  - jekyll-diagrams
+```
 
 ## Usage
 
-## Development
+### Graphviz
+
+You need first install graphviz with package manager on your system. e.g.
+
+* Gentoo Linux : `emerge graphviz`
+* Arch Linux : `pacman -S graphviz`
+
+Then you can use `graphviz`, `graph`, and `digraph` Liquid Tag for creating amazing Graphviz images!
+
+```
+{% 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 %}
+```
+
+You can also use `diagraph` and `graph` tag. e.g.
+
+```
+{% 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 %}
+```
+
+### Diag
+
+Diag contains:
+
+* `blockdiag` : simple block-diagram image generator
+* `seqdiag` : simple sequence-diagram image generator
+* `actdiag` : simple activity-diagram image generator
+* `nwdiag` : simple network-diagram image generators
+
+Fisrt you should install them via `pip`:
+
+```bash
+$ pip install blockdiag seqdiag actdiag nwdiag
+```
+
+And set `$PATH` to make sure your system can find it in `$PATH`.
+
+Then you can use `blockdiag`, `seqdiag`, `actdiag` and `nwdiag` Liquid Tag. e.g.
+
+```
+{% blockdiag %}
+blockdiag {
+   A -> B -> C -> D;
+   A -> E -> F -> G;
+}
+{% endblockdiag %}
+```
+
+And `seqdiag`:
+
+```
+{% 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 %}
+```
+
+## Configuration
+
+A simple configuration shows below:
+
+```yaml
+diagrams:
+  graphviz:
+    engine: dot
+    options: '-Tsvg'
+  diag:
+    options: '-Tsvg --nodoctype'
+```
+
+### Graphviz
+
+`engine` is the default image render engine. Default is set to `dot`. You can also specify for every single image via:
+
+```
+{% graphviz neato %}
+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 %}
+```
+
+`options` is the command line options, and will be appended to the command. Default is set to '-Tsvg'.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Diag
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`options` is the command line options, and will be appended to the command. Default is set to '-Tsvg --nodoctype'.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/farkasity/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.
 
 ## License
 

data/jekyll-diagrams.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["farkasity"]
   spec.email         = ["farkasity@gmail.com"]
 
-  spec.summary       = "Jekyll plugins for diagrams support, including Graphviz."
-  spec.description   = "Jekyll plugins for diagrams support, including Graphviz."
+  spec.summary       = "Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag and so on."
+  spec.description   = "Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag and so on."
   spec.homepage      = "https://github.com/farkasity/jekyll-diagrams"
   spec.license       = "MIT"
 

data/lib/jekyll/diagrams/diag.rb

@@ -12,7 +12,7 @@ module Jekyll
       def render(context)
         config = context.registers[:site].config["diagrams"]
 
-        @renderer = DiagRenderer.new(config[@tag_name])
+        @renderer = DiagRenderer.new(config['diag'])
 
         render_diagram(super)
       end
@@ -53,7 +53,7 @@ module Jekyll
       private
 
       def wrap_div(svg, engine)
-        "<div class='#{engine}'>#{svg}</div>"
+        "<div class='diag #{engine}'>#{svg}</div>"
       end
     end
   end

data/lib/jekyll/diagrams/graphviz.rb

@@ -21,15 +21,15 @@ module Jekyll
 
       def render_diagram(code)
         code = case @tag_name
-               when 'graphviz'
-                 code
-               when 'graph'
-                 "graph {\n#{code}\n}"
-               when 'digraph'
-                 "digraph {\n#{code}\n}"
-               else
-                 raise "unknown liquid tag name: #{@tag_name}"
-               end
+        when 'graphviz'
+          code
+        when 'graph'
+          "graph {\n#{code}\n}"
+        when 'digraph'
+          "digraph {\n#{code}\n}"
+        else
+          raise "unknown liquid tag name: #{@tag_name}"
+         end
 
         @renderer.render(code, @engine)
       end
@@ -66,7 +66,7 @@ module Jekyll
       private
 
       def strip_metainfo(svg)
-        svg.gsub(/(?:.*\n){4}/, '')
+        svg.gsub(/(?:.*\n){6}/, '')
       end
 
       def wrap_div(svg)

data/lib/jekyll/diagrams/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Diagrams
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - farkasity
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Jekyll plugins for diagrams support, including Graphviz.
+description: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag
+  and so on.
 email:
 - farkasity@gmail.com
 executables: []
@@ -109,5 +110,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Jekyll plugins for diagrams support, including Graphviz.
+summary: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag
+  and so on.
 test_files: []