https://github.com/jasonbellamy/jekyll-mermaid

A Jekyll plugin to simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
https://github.com/jasonbellamy/jekyll-mermaid

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jasonbellamy/jekyll-mermaid
• Owner: jasonbellamy
• License: mit
• Created: 2014-12-19T17:10:48.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-04-08T08:55:14.000Z (over 5 years ago)
• Last Synced: 2024-04-26T02:43:45.640Z (8 months ago)
• Language: Ruby
• Size: 113 KB
• Stars: 126
• Watchers: 5
• Forks: 24
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • Contributing: contributing.md
  • License: license

Awesome Lists containing this project

• awesome-jekyll-plugins - **Mermaid** - mermaid](https://rubygems.org/gems/jekyll-mermaid)) -- Simplify the creation of mermaid diagrams and flowcharts in your posts and pages. (Tags)

README

        
# Jekyll-mermaid

A [Jekyll](http://jekyllrb.com/) plugin to simplify the creation of [mermaid](https://github.com/knsv/mermaid) diagrams and flowcharts in your posts and pages.

## Installation

1. Install the gem:

  ```bash

  gem install jekyll-mermaid

  ```

2. Add the gem to your Jekyll `_config.yml`:

  ```ruby

  gems: [jekyll-mermaid]

  ```

Please see the [Jekyll documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) for more installation options.

## Config

You'll need to update your `_config.yml` with the location of the [mermaid](https://github.com/knsv/mermaid) source javascript file you want to use.

```ruby

mermaid:

  src: 'path/to/mermaid.js'

```

## Usage

Simply include the [jekyll-mermaid](https://github.com/jasonbellamy/jekyll-mermaid) block helper in any of your templates.

```liquid

{% mermaid %}

graph TD;

    A-->B;

    A-->C;

    B-->D;

    C-->D;

{% endmermaid %}

```

Please see the [mermaid documentation](https://github.com/knsv/mermaid/wiki) 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 ](http://jasonbellamy.com)

Licensed under the MIT license.