PlantUML plugin for Jekyll
Clone or download
Latest commit 5eec98f Feb 8, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github .github templates Feb 8, 2018
lib Prefix SVG image src attribute with Jekyll baseurl May 19, 2017
.0pdd.yml 0pdd config Jan 29, 2018
.gitignore gem is ready Jun 24, 2014
.pdd .pdd added Dec 22, 2016
.rultor.yml #13 sudo removed May 19, 2017
.travis.yml travis Aug 30, 2016
Gemfile gem is ready Jun 24, 2014
LICENSE.txt Up to 2017, Happy New Year! Jan 5, 2017
README.md ref #2 How to setup in Linux Sep 6, 2016
Rakefile Up to 2017, Happy New Year! Jan 5, 2017
jekyll-plantuml.gemspec version Nov 3, 2015

README.md

Gem Version

Install Jekyll plugin

Install it first:

gem install jekyll-plantuml

With Jekyll 2, simply add the gem to your _config.yml gems list:

gems: ['jekyll-plantuml', ... your other plugins]

Or for previous versions, create a plugin file within your Jekyll project's _plugins directory:

# _plugins/plantuml-plugin.rb
require "jekyll-plantuml"

Highly recommend to use Bundler. If you're using it, add this line to your Gemfile:

gem "jekyll-plantuml"

Install plantuml.jar

Then, make sure PlantUML is installed on your build machine, and can be executed with a simple plantuml command.

For Linux user, you could create a /usr/bin/plantuml with contents:

#!/bin/bash

java -jar /home/user/Downloads/plantuml.jar "$1" "$2"

Remember to change the path to plantuml.jar file.

Then set executable permission.

chmod +x /usr/bin/plantuml

Test

Now, it's time to create a diagram, in your Jekyll blog page:

{% plantuml %}
[First] - [Second]
{% endplantuml %}

Check this blog post. UML sequence diagram in this page is generated with this plugin. Blog sources are available in Github.