Skip to content

ZenUml/zenuml-intellij-plugin

 
 

Repository files navigation

ZenUML Integration for IntelliJ

Build Status (GitHub Workflow Build) JetBrains Plugins Downloads

This official extension integrates ZenUML directly into all JetBrains IDEs. It supports ZenUML diagram files with the extensions .z, .zen and .zenuml.

The editor uses an offline version of ZenUML renderer, therefore it works without an internet connection and content stays local in your IDE.

Free

  • Full support of ZenUML DSL
    • Sync and Async messages
    • Creation, Return/Reply messages
    • Alt, Loop, Par, try/catch/finally fragments
  • Live preview of your diagrams
  • Cloud and other common icons (EC2, Lambda, Database, Boundary, etc.)

Paid

Generate ZenUML diagram from Java code only on Intellij IDEA.

Hacking / reverse engineering

To enable DevTools,

  1. Open menu item Help > Find action... and search for "Registry..."
  2. Enable "ide.browser.jcef.contextMenu.devTools.enabled"

About

This plugin is still an early version and experimental. If you like, you can help to evolve it.

screenshot

Installation

Releases are available on the JetBrains Marketplace. Use Install plugin from repository to install them.

For pre-releases, either

References

Authors

Docs

An architecture overview can be found at https://drawio-intellij-plugin.netlify.app/ .

FAQ

How do I build and run this project?

For development purpose, clone the project locally and start it with the command

./gradlew runIde

This will build the plugin and start an Instance of IntelliJ with the plugin already installed. You can even start this in debug mode.

Environment Variables

This project requires the MIXPANEL_PROJECT_TOKEN to be set as a system environment variable for analytics to work.

Setting the environment variable

  • On macOS/Linux (zsh/bash):
    export MIXPANEL_PROJECT_TOKEN=your_token_here
  • On Windows (cmd):
    set MIXPANEL_PROJECT_TOKEN=your_token_here
  • In IntelliJ IDEA, you can set environment variables in your Run/Debug Configuration under the "Environment variables" field.

Note

  • Do not commit secrets to version control.
  • For production or CI/CD, ensure the environment variable is set in your deployment environment.

About

An IntelliJ plugin which allows you to edit ZenUML diagrams directly in IntelliJ!

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Kotlin 73.0%
  • HTML 9.8%
  • Vue 7.6%
  • TypeScript 3.8%
  • JavaScript 3.6%
  • Shell 1.0%
  • Other 1.2%