README.md in jekyll-diagrams-0.7.1 vs README.md in jekyll-diagrams-0.8.0

- old
+ new

@@ -5,47 +5,61 @@ [![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**](#blockdiag) -- [**Erd**](#erd) -- [**Graphviz**](#graphviz) -- [**Mermaid**](#mermaid) -- [**PlantUML**](#plantUML) -- [**State Machine Cat**](#state-machine-cat) -- [**Syntrax**](#syntrax) +- [Installation](#installation) +- [Configuration](#configuration) +- [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) ## Installation -### When using bundler +Add the following to your site's `_config.yml`: -Add these lines to your application's `Gemfile` file: +```yaml +plugins: + - jekyll-diagrams +``` +And the following to your site's `Gemfile`: + ```ruby group :jekyll_plugins do gem 'jekyll-diagrams' end ``` -And then execute: +Finally run: ```bash -$ bundle +$ bundle install ``` -### Or installing manually +## Configuration -```bash -$ gem install jekyll-diagrams -``` +All configurations are at `_config.yml` file under `jekyll-diagrams`, e.g: -And then add this line to your application's `_config.yml` file: - ```yaml -plugins: - - jekyll-diagrams +jekyll-diagrams: + graphviz: + # configurations for graphviz + blockdiag: + # configurations for blockdiag + # and so on ``` ## Usage ### Blockdiag @@ -208,10 +222,39 @@ - `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) +### 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 - Java Runtime @@ -271,10 +314,12 @@ - `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`) +### Svgbob + ### Syntrax #### Prerequisites - [Install Syntrax, Pango and PangoCairo](https://kevinpt.github.io/syntrax/#requirements) @@ -300,9 +345,13 @@ syntrax: scale: 'Scale image' style: 'Style config file' transparent: 'Transparent background' ``` + +### Vega + +### Wavedrom ## 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. \ No newline at end of file