Giter Site home page Giter Site logo

plantuml4idea's Introduction

PlantUML plugin for IntelliJ platform

JetBrains plugins JetBrains plugins

This plugin provides integration with popular PlantUML diagramming tool


Sponsored by


Manage pull requests and conduct code reviews in your IDE with full source-tree context. Comment on any line, not just the diffs. Use jump-to-definition, your favorite keybindings, and code intelligence with more of your workflow.
Learn More


Author: Eugene Steinberg

Contributors:

Features

  • PlantUML tool window renders PlantUML source code under caret in currently selected editor
  • Structure view, code navigation between declaration and usages, renaming
  • Supports multiple sources per file
  • Supports pagination and zoom
  • Can copy diagram to clipboard or export as PNG, EPS or SVG, ASCII Art
  • Caching and incremental rendering

Tips

  • PlantUML code must be inside @startuml and @enduml tags to be rendered.
  • To be able to generate many diagram types, you must have Graphviz installed on your machine (not needed for Windows, it is bundled in the PlantUML jar).
  1. Download PlantUML jar - https://plantuml.com/download
  2. Download JLatexMath libs - https://jar-download.com/artifacts/org.scilab.forge/jlatexmath - use Download jlatexmath.jar (xxx) button, unzip jar_files.zip
  3. Go to setting in IntelliJ for PlantUML
  4. Set PlantUML JAR to the folder containing jars you downloaded

Developer notes

  • debug logs can be enabled by adding '#org.plantuml' and 'org.plantuml' to [Help | Debug Log Settings]
  • use Jetbrains JDK if normal JDK produces UI bugs

There are following branches:

master

  • Current production branch

grammar

  • old experimental syntax support - never finished
  • Grammar classes can be generated using tools/grammar-gen.sh
  • This script can run automatically when you run the plugin using "Plugin" Run/Debug configuration. Just add the script above as an external tool and make it run before the "Make" step.

plantuml4idea's People

Contributors

62mkv avatar aadrian avatar alterdego avatar bevalorous avatar bkolb avatar calmarj avatar cervonwong avatar cr7pt0gr4ph7 avatar digitalroot avatar esteinberg avatar hza avatar jord1e avatar krasa avatar markiewb avatar pdelre avatar rogerdahl avatar thirtque avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.