jekyll-plantuml

A Jekyll plugin to simplify the creation of diagrams and flowcharts in your posts and pages with PlantUML (only).

P/s : This is fork project from https://rubygems.org/gems/jekyll-spaceship

Table of Contents

• Requirements
• Installation
• Usage
  • 1. PlantUML Usage
• Credits
• Contributing
• License

Requirements

• Ruby >= 2.3.0

Installation

Add jekyll-plantuml plugin in your site's Gemfile, and run bundle install.

gem 'jekyll-plantuml-embed'

Add jekyll-plantuml to the gems: section in your site's _config.yml.

plugins:
  - jekyll-plantuml-embed

Usage

1. PlantUML Usage

PlantUML is a component that allows to quickly write:

• sequence diagram,
• use case diagram,
• class diagram,
• activity diagram,
• component diagram,
• state diagram
• object diagram

There are two ways to create a diagram in your Jekyll blog page:

@startuml
Bob -> Alice : hello
@enduml

or

``` plantuml
Bob -> Alice : hello world
```

self note:

How to built gem file

$ gem build jekyll-plantuml-embed.gemspec
  Successfully built RubyGem
  Name: jekyll-plantuml-embed
  Version: 1.0.8
  File: jekyll-plantuml-embed-1.0.8.gem

How to push gem file

$ gem push jekyll-plantuml-embed-1.0.8.gem
Pushing gem to https://rubygems.org...
Successfully registered gem: jekyll-plantuml-embed (1.0.8)

How to delete pushed gem file

gem update --system
gem install gemcutter

$ gem yank
A version argument is required: gem yank GEM -v VERSION [-p PLATFORM] [--key KEY_NAME] [--host HOST]

Credits

• Jekyll - A blog-aware static site generator in Ruby.
• MultiMarkdown - Lightweight markup processor to produce HTML, LaTeX, and more.
• markdown-it-multimd-table - Multimarkdown table syntax plugin for markdown-it markdown parser.
• jeffreytse/jekyll-spaceship - This project is fork from here

Contributing

Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.

You can start by opening an issue describing the problem that you're looking to resolve and we'll go from there.

License

This software is licensed under the MIT license © robbinespu.