Graphviz.vim

An almost completely-rewritten fork of wmgraphviz.vim.

• Less commands.
• Simpler configuration.
• Add completion support for ncm2 and coc.nvim.

Note: The command :Graphviz only exists when you open a .gv or .dot file.

Requirement

• Graphviz

Installation

• Using vim-plug:

Plug 'liuchengxu/graphviz.vim'

• Clone the repo into your vim config folder

mkdir -p ~/.vim/pack/vendor/start
git clone https://github.com/liuchengxu/graphviz.vim ~/.vim/pack/vendor/start/graphviz.vim

Usage

Open the output file whose filename is based on the current filename with .format appended.

" `.format` is 'pdf' by default.
" Option: 'ps', 'pdf', 'png', 'jpg', 'gif', 'svg'
:Graphviz

" Open the generated png file
:Graphviz png

:Graphviz! is same with :Graphviz, but compile first if the output file does not exist.

" Open the generated png file, try compiling if the target does not exist.
" Options are same with `:GraphvizCompile`.
:Graphviz! png

:Graphviz!! is same with :GraphvizCompile | Graphviz!.

Compile the graph in the same directory as the current source dot-file.

" :GraphvizCompile [exe] [format]

" By default:
" :GraphvizCompile dot pdf
:GraphvizCompile

" Specify the output format
:GraphvizCompile png

" Specify the exe and format
:GraphvizCompile dot gif

Customization

" How to open the generated output file.
" If does not exist, graphviz.vim will automatically choose the right way depending on the platform.
let g:graphviz_viewer = 'open'

" Default output format. Default is 'pdf'.
let g:graphviz_output_format = 'pdf'

" Options passed on to dot. Default is ''.
let g:graphviz_shell_option = ''

Related Projects

• dot-language-server