README.md in jekyll-diagrams-0.9.2 vs README.md in jekyll-diagrams-0.9.3

- old
+ new

@@ -1,22 +1,21 @@ # Jekyll Diagrams -[![Gem](https://img.shields.io/gem/v/jekyll-diagrams.svg?style=flat-square)](https://rubygems.org/gems/jekyll-diagrams) -[![Depfu](https://img.shields.io/depfu/zhustec/jekyll-diagrams.svg?style=flat-square)](https://depfu.com/repos/zhustec/jekyll-diagrams) -[![GitHub Action](https://img.shields.io/github/workflow/status/zhustec/jekyll-diagrams/Test?label=Github%20Action&style=flat-square)](https://github.com/zhustec/jekyll-diagrams/actions?query=workflow%3ATest) -[![Travis](https://img.shields.io/travis/zhustec/jekyll-diagrams.svg?style=flat-square)](https://travis-ci.com/zhustec/jekyll-diagrams) -[![Coveralls](https://img.shields.io/coveralls/github/zhustec/jekyll-diagrams?style=flat-square)](https://coveralls.io/github/zhustec/jekyll-diagrams?branch=master) -[![License](https://img.shields.io/github/license/zhustec/jekyll-diagrams.svg?style=flat-square)](https://github.com/zhustec/jekyll-diagrams/blob/master/LICENSE) +[![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) +[![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. **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) - [Configurations](#configurations) - - [Site Configurations](#site-configurations) - - [Page Configurations](#page-configurations) + - [Error Mode](#error-mode) - [Usage](#usage) - [Blockdiag](#blockdiag) - [Erd](#erd) - [Graphviz](#graphviz) - [Mermaid](#mermaid) @@ -53,14 +52,12 @@ $ bundle install ``` ## Configurations -### Site Configurations +Configurations can be set in your site's config file under `jekyll-diagrams` key as below: -Site configurations can be set in your site's config file under `jekyll-diagrams` key, e.g: - ```yaml jekyll-diagrams: graphviz: # configurations for graphviz blockdiag: @@ -68,28 +65,43 @@ syntrax: # configurations for syntrax # and so on ``` -### Page Configurations +You can override global config in the front matter of each page, e.g. -You can set configurations in the front matter of each page, this will overwite global config. e.g. - ```text --- title: Custom configurations per page jekyll-diagrams: graphviz: # configurations for graphviz - blockdiag: - # configurations for blockdiag - syntrax: - # configurations for syntrax - # and so on --- -# your content +# Your content +``` + +### Error Mode + +You can use `error_mode` to configure how to response to errors. `jekyll-diagrams` respect the global [liquid options](https://jekyllrb.com/docs/configuration/liquid/): + +```yaml +liquid: + error_mode: 'mode' +``` + +Avaliable options: + +- `lax`: Ignore all errors +- `warn`: Output a warning on the console for each error +- `strict`: Output an error message and stop the build + +You can also override it for just `jekyll-diagrams`: + +```yaml +jekyll-diagrams: + error_mode: 'mode' ``` ## Usage ### Blockdiag