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
- Add the gem to the Jekyll
_config.yml
:
plugin:
- jekyll-pandoc-mermaid
- '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.
- '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
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request