Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yegor256/jekyll-plantuml
PlantUML plugin for Jekyll: helps you embed UML diagrams into static pages
https://github.com/yegor256/jekyll-plantuml
diagram jekyll plantuml ruby
Last synced: 5 days ago
JSON representation
PlantUML plugin for Jekyll: helps you embed UML diagrams into static pages
- Host: GitHub
- URL: https://github.com/yegor256/jekyll-plantuml
- Owner: yegor256
- License: mit
- Created: 2014-06-24T15:28:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T15:33:41.000Z (19 days ago)
- Last Synced: 2024-10-16T19:14:01.900Z (18 days ago)
- Topics: diagram, jekyll, plantuml, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/jekyll-plantuml
- Size: 124 KB
- Stars: 47
- Watchers: 4
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-jekyll-plugins - **PlantUML** - plantuml](https://rubygems.org/gems/jekyll-plantuml)) -- Tag that renders UML diagrams using [PlantUML](http://plantuml.com/). (Tags)
README
[](http://www.rultor.com/p/yegor256/jekyll-plantuml)
[](https://www.jetbrains.com/ruby/)
[](https://github.com/yegor256/jekyll-plantuml/actions/workflows/rake.yml)
[](http://badge.fury.io/rb/jekyll-plantuml)
[](https://codecov.io/github/yegor256/jekyll-plantuml?branch=master)
Install it first:
```
$ gem install jekyll-plantuml
```
With Jekyll 2, simply add the gem to your `_config.yml` gems list:
```yaml
gems: ['jekyll-plantuml', ... your other plugins]
```
Or for previous versions,
create a plugin file within your Jekyll project's `_plugins` directory:
```ruby
# _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"
```
The plugin is compatible with
[Jekyll 3.9.3](https://jekyllrb.com/news/2023/01/29/jekyll-3-9-3-released/) and
[Jekyll 4.3.2](https://jekyllrb.com/news/2023/01/20/jekyll-4-3-2-released/).
You can find our integration tests, which prove the compatibility,
[here](https://github.com/yegor256/jekyll-plantuml/tree/master/test-jekylls).
## Install plantuml.jar
Then, make sure [PlantUML](http://plantuml.sourceforge.net/download.html)
is installed on your build machine, and can
be executed with a simple `plantuml` command.
On Ubuntu, just `apt-get install -y plantuml` should work.
However, if it doesn't, you can create a `/usr/bin/plantuml` with the
following content:
```
#!/bin/bash
java -jar /home/user/Downloads/plantuml.jar "$1" "$2"
```
Remember to change the path to the `plantuml.jar` file.
Then, set the executable permission of the file:
```
$ chmod +x /usr/bin/plantuml
```
## Test
Now, it's time to create a diagram, in your Jekyll blog page:
```
{% plantuml %}
[First] - [Second]
{% endplantuml %}
```
Now, check [this blog post](http://www.yegor256.com/2014/06/01/aop-aspectj-java-method-logging.html):
the UML sequence diagram in it is auto-generated using exactly this plugin.
The sources of the blog are available in [GitHub](https://github.com/yegor256/blog).
## How to contribute
Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure you build is green before you contribute
your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
[Bundler](https://bundler.io/) installed. Then:
```
$ bundle update
$ bundle exec rake
```
If it's clean and you don't see any error messages, submit your pull request.