Skip to content

jasonbellamy/jekyll-mermaid

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 

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
  1. 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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages