A Jekyll plugin to simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib initial commit Dec 19, 2014
.gitignore initial commit Dec 19, 2014
contributing.md initial commit Dec 19, 2014
jekyll-mermaid.gemspec initial commit Dec 19, 2014
license initial commit Dec 19, 2014
readme.md initial commit Dec 19, 2014

readme.md

Jekyll-mermaid

A Jekyll plugin to simplify the creation of mermaid diagrams and flowcharts in your posts and pages.

Installation

  1. Install the gem:

    gem install jekyll-mermaid
  2. Add the gem to your Jekyll _config.yml:

    gems: [jekyll-mermaid]

Please see the Jekyll documentation for more installation options.

Config

You'll need to update your _config.yml with the location of the mermaid source javascript file you want to use.

mermaid:
  src: 'path/to/mermaid.js'

Usage

Simply include the jekyll-mermaid block helper in any of your templates.

{% mermaid %}
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
{% endmermaid %}

Please see the mermaid documentation for more examples.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

License

Copyright (c) 2014 Jason Bellamy Licensed under the MIT license.