Skip to content

weirongxu/plantuml-previewer.vim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plantuml Previewer Vim

Vim/NeoVim plugin for preview PlantUML

image

Dependencies

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#save_format

:PlantumlSave default format
Default: 'png'

g:plantuml_previewer#viewer_path

Custom plantuml viewer path.
tmp.puml and tmp.svg will output to here

You may need to use with plantuml_previewer#default_viewer_path()

Functions

plantuml_previewer#default_viewer_path()

Default path of viewer, it's useful to sync to a custom location.

use with rsync:

command PlantumlViewerRsync call system('rsync -r ' . plantuml_previewer#default_viewer_path() . '/ ' . g:plantuml_previewer#viewer_path . '/')

Related