No commit activity in last 3 years
No release in over 3 years
jekyll-pandoc-mermaid can solve rendering issue that occures when using jekyll-pandoc and jekyll-mermaid plugin together
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 4.0, ~> 4.0
>= 1.0.0, ~> 1.0.0
>= 2.0.1, ~> 2.0.1
 Project Readme

jekyll-pandoc-mermaid

jekyll-pandoc-mermaid can solve rendering issue that occures when using jekyll-pandoc and jekyll-mermaid plugin together

'jekyll-pandoc-mermaid' is enable only when using gem jekyll-pandoc and jekyll-mermaid

'jekyll-pandoc-mermaid' uses Jekyll Hook.

Dependencies

  • Jekyll, version 4.0 or higher
  • jekyll-pandoc, version 2.0.1 or higher (Jekyll-Pandoc requires 'pandoc-ruby')
  • jekyll-mermaid, version 1.0.0 or higher

Installation

Run bundle install after adding the gem to your Jekyll Gemfile:

gem "jekyll-pandoc-mermaid"

Please see the Jekyll documentation for more installation options.

Configuration

  1. Add the gem to the Jekyll _config.yml:
plugin:
  - jekyll-pandoc-mermaid
  1. 'jekyll-pandoc-mermaid' is enable only when set as follows in the Jekyll _config.yml:
markdown: Pandoc

Please see the jekyll-pandoc Configuration for more configuration options.

  1. 'jekyll-pandoc-mermaid' is enable only when set as follows in the Jekyll _config.yml:
mermaid:
  src: 'path/to/mermaid.js' (eg. https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js)

Please see the jekyll-mermaid Configuration for more configuration options.

Usage

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

Please see the jekyll-mermaid usage and mermaid website for more examples.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT License.