rheehot / plantuml-extension

🏭 This is Google Chrome extension that replace PlantUML code blocks into preview images.

PlantUML Extension

This is a Google Chrome extension that replace PlantUML code blocks into preview images.

Install

• Chrome extension

The chrome version also works in Opera (using this) and Edge.

Features

• Preview
  • GitHub Issues
  • ZenHub Issues
• Support for GitHub Enterprise
• Support environment setting for each domain.
• Support !include directive
• Support rendering of .pu/.puml/.plantuml file

Sample contents

Sequence diagram with lang uml

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

State diagram with lang puml

@startuml
[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string

State1 -> State2
State2 --> [*]
@enduml

Other code blocks

These cannot preview.

Code block without lang uml

@startuml
hide empty description
[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string

State1 -> State2
State2 --> [*]
@enduml

uml code block does not starts with @start

foo
bar
baz

Support for GitHub Enterprise

If you're a GitHub Enterprise user, visit your Enterprise site, right-click on the extension’s icon in the toolbar and select Enable PlantUML Extension on this domain.

Using another options(PlantUML server) by domain

By default, this extension uses PlantUML server deployed to https://www.plantuml.com/plantuml.

However, if your UML is confidential and you cannot send it to an external server, you can also use any PlantUML server. Configuring "Base URL" on the setting page, delegates image generation to this server.

Examples.

• https://www.plantuml.com/plantuml/img/ (default)
• https://www.plantuml.com/plantuml/svg/
• https://any-plantuml-server.example.com:8080/img/

Also you can run PlantUML server in localhost using Docker as following command:

$ docker run -d -p 8080:8080 plantuml/plantuml-server

And you can specify http://localhost:8080/img/ as Base URL.

Note: To avoid mixed-content, if the Base URL is not HTTPS scheme, generated image is converted to DATA URI.

Contribution

1. Fork (wkcksome/plantuml-extension/fork)
2. Create a feature branch named like feature/something_awesome_feature from develop branch
3. Commit your changes
4. Rebase your local changes against the develop branch
5. Create new Pull Request

Author

Yeongjun Kim

See Also

• PlantUML Guide
• REAL WORLD PlantUML: Source code of real-world-plantuml.com
• https://github.com/rabelenda/gilbarbara-plantuml-sprites
• https://github.com/Roemer/plantuml-office