/plantuml-visualizer

:factory: A Chrome / Firefox extension for visualizing PlantUML code.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

PlantUML Visualizer

Test semantic-release

Release

🏭 A Chrome / Firefox extension for visualizing PlantUML descriptions.

Release Pages

Visualizable Pages

GitHub

GitLab

  • Any page containing <pre> tag with prefix @startuml and suffix @enduml

(We will list GitLab pages with testing urls later)

.pu / .puml / .plantuml / .wsd files

Improve Default Allow/Deny Lists

The default lists are defined at https://github.com/WillBooster/plantuml-visualizer/blob/main/src/constants.ts Please help us to improve the default lists for enabling/disabling visualization on specific web pages!

Visualization Examples

The visualization result of https://github.com/WillBooster/plantuml-visualizer/pull/24/files is as follows.

Example

Default Visualization Server

The default server is https://plantuml-service-willbooster.fly.dev (source code). You may check the PlantUML version via this link.

You may use another HTTPS PlantUML server by changing settings in the configuration window.

Requirements for Development

Development Preparation

  1. yarn to install the latest dependencies
  2. yarn build
  3. Open Chrome browser
  4. Open chrome://extensions
  5. Enable Developer Mode
  6. Click Load Unpacked and open dist directory (plantuml-visualizer/dist)
    • Load Unpacked is パッケージ化されていない拡張機能を読み込む in Japanese

Development

  1. yarn to install the latest dependencies
  2. yarn start
  3. Open Chrome
  4. Rewrite some code files
  5. Close and Reopen Chrome browser (not only tabs)
    • or reload this extension in chrome://extensions and reload pages
  6. Debug code
  7. Go to step 4

Deployment for Chrome

  1. Bump version in manifest.json and package.json
  2. yarn package
  3. Open https://chrome.google.com/webstore/developer/dashboard
  4. Upload dist.zip

Deployment for Firefox

  1. Bump version in manifest.json and package.json
  2. yarn package
  3. Open https://addons.mozilla.org/en-US/developers/addon/plantuml-visualizer/edit
  4. Upload dist.zip file