PlantUML

Intro #

PlantUML is a convinient tool to make diagrams using UML language/format, such as sequence diagrams, use cases, flow diagrams etc.

pic-ref

Selected Tools #

• VSCode: Live preview in Visual Studio VSCode plugins: jebbs.plantuml w/ encoded url. (Tip1: render by either local (suggested, needs java+graphviz) or server. Tip2: config “server” as the bold part of: http://www.plantuml.com/plantuml/uml/xxxyyyzzz)
• PlantText.com: shareable source code (encoded url). A site that can support PNG, SVG, ASCII/TXT, save/generate encoded url (“Edit” button), and have many examples
  • Sunny’s puml sequence diagram template v5 by PlantText (bitly backup bit.ly/s_puml-seq-v5)
• Font OK + History, NO sharable code kkeisuke.com
• A standard/plain/vanila editor w/ history: https://plantuml-editor.kkeisuke.com/
• PlantUML vanila editor w/ shareable source code (encoded url) plantuml.com/plantuml
• PlantUML official self-host server or docker
• A previewer from github w/ history: sujoyu.github.io
• Others collected by the official web: http://plantuml.com/running
• Atom has a community maintained plantuml syntax highlighter and viewer.
• Live preview online vizard.io (discontinued) & code

Alternatives that do NOT require external web services [ref]:

• for flow/Gantt/sequence diagrams, “Mermaid” is also a good choice.
  • Good:
    • easier/simpler/less than writing puml.
    • real-time online rendering with js.
    • CJK/non-UTF ok.
  • Bad:
    • all symbols should use html codes.
    • not so professional as puml.
    • no professional class diagram
  • Live editors:
    • All features, rich links, md etc.: mermaid-js.github.io beta
    • All basic features: mermaid-js.github.io
• yUML is easier to use.