This plugin provides a live preview of the output PDF of your LaTeX file. The display of the output PDF file will be updated lively as you type (just hold the cursor and you will see the PDF file updated). Currently, vim-latex-live-preview only support UNIX-like systems. Please let me know if you have any suggestions.
Before installing, you need to make sure your Vim version is later than 7.3,
and is compiled with +python
feature.
Add the plugin in the vim-plug section of your ~/.vimrc
:
call plug#begin('~/.vim/plugged')
[...]
" A Vim Plugin for Lively Previewing LaTeX PDF Output
Plug 'xuhdev/vim-latex-live-preview', { 'for': 'tex' }
[...]
call plug#end()
Then reload the config and install the new plugin. Run inside vim
:
:so ~/.vimrc
:PlugInstall
Add the plugin in the Vundle section of your ~/.vimrc
:
call vundle#begin()
[...]
" A Vim Plugin for Lively Previewing LaTeX PDF Output
Plugin 'xuhdev/vim-latex-live-preview'
[...]
call vundle#end()
Then reload the config and install the new plugin. Run inside vim
:
:so ~/.vimrc
:PluginInstall
Copy plugin/latexlivepreview.vim
to ~/.vim/plugin
.
Simply execute :LLPStartPreview
to launch the previewer. Then try to type in
Vim and you should see the live update. The updating time could be set by Vim's
'updatetime' option. If your pdf viewer crashes when updates happen, you can
try to set 'updatetime' to a higher value to make it update less frequently. The
suggested value of 'updatetime' is 1000
.
If the root file is not the file you are currently editing, you can specify it
by executing :LLPStartPreview <root-filename>
or executing :LLPStartPreview
with the following declaration in the first line of your source file:
% !TEX root = <root-filename>
The path to the root file can be an absolute path or a relative path, in which case it is relative to the parent directory of the current file.
<root-filename>
contains special characters (such as space), they
must be escaped manually.
By default, you need to have evince or okular installed as pdf viewers.
But you can specify your own viewer by setting g:livepreview_previewer
option in your .vimrc
:
let g:livepreview_previewer = 'your_viewer'
Please note that not every pdf viewer could work with this plugin. Currently evince and okular are known to work well. You can find a list of known working pdf viewers here.
LLP
uses pdflatex
as default engine to output a PDF to be previewed. It
fallbacks to xelatex
if pdflatex
is not present. These defaults can be
overridden by setting g:livepreview_engine
variable:
let g:livepreview_engine = 'your_engine' . ' [options]'
LLP
uses bibtex
as the default executable to process .bib
files. This can
be overridden by setting the g:livepreview_use_biber
variable.
let g:livepreview_use_biber = 1
Please note that the package biblatex
can use both bibtex
and the newer
biber
, but uses biber
by default. To use bibtex
, add backend=bibtex
to your biblatex
usepackage declaration.
\usepackage[backend=bibtex]{biblatex}
Please note that biblatex
will NOT work straight out of the box, you will
need to set either g:livepreview_biber
or backend=bibtex
, but not both.
By default, the LaTeX sources will be recompiled each time the buffer is written
to disk, but also when the cursor holds. To prevent recompilation on cursor
hold (autocmd events CursorHold
and CursorHoldI
), use the feature flag:
let g:livepreview_cursorhold_recompile = 0
An error E768: Swap file exists
may occur. See
issue #7 to avoid
swap filename collision.
Currently, root file must be in the same directory or upper in the project tree (otherwise, one has to save file to update the preview).
See issue #12, provided the plugin is correctly installed, this is likely a Python issue.
See issue #24,
currently vim-latex-live-preview
does not support python/dyn
and Vim
must be recompiled with Python support.
Why doesn't my bibliography appear, with or without an error?
See issue #46 and
PR #99.
If you're using biblatex
this is most likely caused by not also setting
g:livepreview_use_biber = 1
in your .vimrc
. Or if you intended to use
bibtex
not using that option when using the biblatex
package. i.e.
\usepackage[backend=bibtex]{biblatex}