Plantuml Previewer Vim

Vim/NeoVim plugin for preview PlantUML

Dependencies

• Java
• Graphviz (https://www.graphviz.org/download/)
  • brew install graphviz
  • apt-get install graphviz
• open-browser.vim
• aklt/plantuml-syntax (vim syntax file for plantuml)

Usage

1. Start editing plantuml file in Vim
2. Run :PlantumlOpen to open previewer webpage in browser
3. Saving plantuml file in Vim, then previewer webpage will refresh

Commands

PlantumlOpen

Open previewer webpage in browser, and watch current buffer

PlantumlStart

Like PlantumlOpen, but won't open in browser

PlantumlStop

Stop watch buffer

PlantumlSave [filepath] [format]

Export uml diagram to file path
Available formats

png, svg, eps, pdf, vdx, xmi, scxml, html, txt, utxt, latex

Example:

:e diagram.puml

:PlantumlSave
:PlantumlSave diagram.png
:PlantumlSave diagram.svg

Variables

g:plantuml_previewer#plantuml_jar_path

Custom plantuml.jar file path

If plant uml was installed by homebrew, you can add the following code to your .vimrc to use the version installed by homebrew:

au FileType plantuml let g:plantuml_previewer#plantuml_jar_path = get(
    \  matchlist(system('cat `which plantuml` | grep plantuml.jar'), '\v.*\s[''"]?(\S+plantuml\.jar).*'),
    \  1,
    \  0
    \)

g:plantuml_previewer#file_pattern

Files that will be watched by plugin.

Default: *.pu,*.uml,*.plantuml,*.puml,*.iuml

If you want add another files, place something like this to your .vimrc:

let g:plantuml_previewer#file_pattern = "*.pu,*.uml,*.plantuml,*.puml,*.iuml,*.md"

g:plantuml_previewer#save_format

:PlantumlSave default format
Default: 'png'

g:plantuml_previewer#viewer_path

Custom plantuml viewer path
The plugin will copy viewer to here if the directory does not exist
And tmp.puml and tmp.svg will output to here

g:plantuml_previewer#debug_mode

Debug mode
The plugin will print debug message if this is set to 1
Default: 0

Related

• vim-slumlord
• previm