A blog that uses jekyll and mermaid for diagrams
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
.jekyll-assets-cache/resize updating consulting blog Jul 26, 2015
_assets adding new blog post on kafka and kinesis Jun 5, 2016
_data
_includes
_layouts adding a new blog entry for kinesis and kafka Jun 12, 2016
_plugins
_posts
_sass updating blog Aug 9, 2015
_templates
about adding some python concepts into the blog sections Aug 17, 2015
assets updating blog Aug 5, 2015
blog
code polishing blog posts Sep 22, 2015
delivery
images first commit for consulting blog Jul 19, 2015
js
services
spark
.gitignore adding new blog post on kafka and kinesis Jun 5, 2016
.jshintrc
404.md
CNAME
Gemfile
Gemfile.lock updating ems Aug 9, 2015
Gruntfile.js
LICENSE first commit for consulting blog Jul 19, 2015
README.md updating blog Jan 24, 2016
Rakefile updating rakefile config Aug 9, 2015
_config.yml updating ga account id Sep 30, 2015
_octopress.yml
favicon.ico first commit for consulting blog Jul 19, 2015
favicon.png
feed.xml
index.md updating blog again Aug 5, 2015
package.json

README.md

Jekyll-mermaid-blog

A Jekyll blog integrated with the mermaid library for diagrams and flowcharts in your posts and pages.

Installation

  1. Install Jekyll
  2. Download repository

Please see the Jekyll documentation for more installation options.

Config

The mermaid javascript files are sourced through _config.yml.

mermaid:
  src: '/js/mermaid.js'
  src_config: '/js/mermaid_config.js'

Publish the jekyll blog is done through the RakeFile so you will need to update the GITHUB_REPONAME.

Usage

Running the jekyll site locally by executing jekyll serve.

jekyll serve

The website can be published by executing a rake command.

rake publish

For working with mermaid diagrams, 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.

Demo

For a working example, check out the blog post as well the source code.