Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 

README.md

@wafer-li 's hexo-filter-plantuml has been transfered to me duo to maintain issues.


version download

Features

  • Generate raw/base64/urlencoded svg at compile time, no external css and js required.
  • Privacy guaranteed. Support rendering locally or self-hosting server.
  • Zero npm dependencies.

How Does it work

Install

npm install --save hexo-filter-plantuml

Minimum configuration

It will send your text to plantuml.com for rendering, and the base64-encoded images will be inlined in the html.

plantuml:
  render: "PlantUMLServer"

Advanced configuration

Server-side(recommend)

Please keep in mind, if you want more about privacy/safety, please replace your own self-hosting render server.

plantuml:
  #  Local or PlantUMLServer.
  render: "PlantUMLServer"

  # the server,you can change your self-hosted sever for privacy
  server: "http://www.plantuml.com/plantuml"
  # "inline": <svg>xxx<svg/>
  # "inlineUrlEncode": <img src='data:image/svg+xml;> 
  # "inlineBase64": <img src='data:image/svg+xml;base64> 
  # "localLink": <img src="/assert/puml/xxxx.svg">
  # "externalLink": <img src="http://www.plantuml.com/plantuml/svg/xxx">
  link: "inline"

  # common options: svg/png
  outputFormat: "svg"

Client-side

It may be slower for plantuml.jar will restart JVM per code fragment.

plantuml:
  #  Local or PlantUMLServer.
  render: "Local"

  # "inline": <svg>xxx<svg/>
  # "inlineUrlEncode": <img src='data:image/svg+xml;> 
  # "inlineBase64": <img src='data:image/svg+xml;base64> 
  # "localLink": <img src="/assert/puml/xxxx.svg">
  link: "inline"

  # where your dot binary
  GraphvizDotFile: "/usr/local/bin/dot"
  # where your jar
  PlantJar: "/usr/local/Cellar/plantuml/1.2019.10/libexec/plantuml.jar"

  # common options: svg/png
  outputFormat: "svg"

How to use it?

{% plantuml %}
@startuml
Object <|-- ArrayList
Object : equals()
ArrayList : Object[] elementData
ArrayList : size()
@enduml
{% endplantuml %}

@startuml and @endpuml are ALWAYS required or the image will fail to be generated.

or

​```puml
@startuml
Object <|-- ArrayList
Object : equals()
ArrayList : Object[] elementData
ArrayList : size()
@enduml

Plugin will pick up block body and replace it with generated base64 svg diagram.

> `puml` and `plantuml` tags both work.

see more details at <http://plantuml.com/sitemap-language-specification>

About

Using PlantUML to generate UML Diagram for hexo

Topics

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.