hexo-tag-uml

Render UML sequence diagram in your blog


Keywords
website, blog, cms, framework, hexo, mathjax
License
GPL-2.0
Install
npm install hexo-tag-uml@1.0.0

Documentation

hexo-tag-uml

Deprecated:

This project is deprecated.

Please use Hexo Diagram instead.

Render UML sequence diagram in your blog powered by Jumly.

snapshot

A Chinese version of document can be found here.

Feature

  • Sequence diagram
  • Robustness diagram

Install

npm install hexo-tag-uml --save

Initialize

  • Run in your blog project folder:
hexo uml install

This command will copy necessary scripts and style sheets to proper location.

  • Edit theme layout file:

Add the following line into a proper location of .ejs file:

<%- partial('jumly') %>

A proper place is usually in the <head> section. But always make sure that there are no other reference to jQuery otherwise it will cause conflicts.

Special note for hexo's landscape theme:

You should add the above line in _partial\after-footer.ejs.

And remove the original jQuery reference.

  • Edit _config.yml:
plugins:
- hexo-tag-uml

Usage

Syntax:

{% uml [diagram_type] %}
{% enduml %}

Valid diagram_type values are:

  • sequence
  • robustness

If user does not specify one, sequence will be used as default.

{% uml %}
@found "You", ->
  @message "Think", ->
    @message "Write your idea", "JUMLY", ->
      @create "Diagram"
jumly.css "background-color":"#8CC84B"
{% enduml %}

For more information on how to write jumly syntax, visit Jumly.