lervag/vimtex

VimTeX is a modern Vim and Neovim filetype and syntax plugin for LaTeX files.

• Requirements
• Installation
• Configuration
• Quick Start
  • Tutorial
  • Documentation
• Screenshots
  • GIFs
• Features
• Other relevant plugins
  • Linting and syntax checking
  • Snippets and templates
  • Tag navigation
• Alternatives

VimTeX requires Vim version 9.2 or Neovim version 0.12.4. The requirements were updated in July 2026 after the release of VimTeX 2.18. If you are stuck on older versions of Vim or Neovim, then you should not use the most recent version of VimTeX, but instead remain at the v2.17 tag (or older).

Some features require external tools. For example, the default compiler backend relies on latexmk. Users are encouraged to read the requirements section in the documentation (:h vimtex-requirements).

There are a lot of methods for installing plugins. The following explains the most common and popular approaches.

Neovim has a built-in plugin manager called vim.pack. To use it, simply create a file like ~/.config/nvim/plugin/vimtex.lua with:

-- Note that v2.15 is NOT the most recent version!
vim.pack.add { { src = "https://github.com/lervag/vimtex", version = "v2.15" } }

-- To use the most recent version from git, you can do simply:
vim.pack.add { "https://github.com/lervag/vimtex" }

-- VimTeX configuration goes here, e.g.
vim.g.vimtex_view_method = "zathura"

VimTeX is mostly implemented with Vimscript and is configured with the classical vimscript variable convention like g:vimtex_OPTION_NAME. Nowadays, Neovim is often configured with Lua, thus some users may be interested in reading :help lua-vimscript.

To install VimTeX with lazy.nvim, add a plugin spec similar to this:

{
  "lervag/vimtex",
  lazy = false,     -- we don't want to lazy load VimTeX
  -- tag = "v2.15", -- uncomment to pin to a specific release
  init = function()
    -- VimTeX configuration goes here, e.g.
    vim.g.vimtex_view_method = "zathura"
  end
}

If you use vim-plug, then add one of the following lines to your configuration. The first will use the latest versions from the master branch, whereas the second will pin to a release tag.

Plug 'lervag/vimtex'
Plug 'lervag/vimtex', { 'tag': 'v2.15' }

There are many other plugin managers out there. They are typically well documented, and it should be straightforward to extrapolate the above snippets.

After installing VimTeX, you should edit your .vimrc file or init.vim file to configure VimTeX to your liking. Users should read the documentation to learn the various configuration possibilities, but the below is a simple overview of some of the main aspects.

" This is necessary for VimTeX to load properly. The "indent" is optional.
" Note: Most plugin managers will do this automatically!
filetype plugin indent on

" This enables Vim's and neovim's syntax-related features. Without this, some
" VimTeX features will not work (see ":help vimtex-requirements" for more
" info).
" Note: Most plugin managers will do this automatically!
syntax enable

" Viewer options: One may configure the viewer either by specifying a built-in
" viewer method:
let g:vimtex_view_method = 'zathura'

" Or with a generic interface:
let g:vimtex_view_general_viewer = 'okular'
let g:vimtex_view_general_options = '--unique file:@pdf\#src:@line@tex'

" VimTeX uses latexmk as the default compiler backend. If you use it, which is
" strongly recommended, you probably don't need to configure anything. If you
" want another compiler backend, you can change it as follows. The list of
" supported backends and further explanation is provided in the documentation,
" see ":help vimtex-compiler".
let g:vimtex_compiler_method = 'latexrun'

" Most VimTeX mappings rely on localleader and this can be changed with the
" following line. The default is usually fine and is the symbol "\".
let maplocalleader = ","

The following video shows how to use VimTeX's main features (credits: @DustyTopology from #1946). The example LaTeX file used in the video is available under test/example-quick-start/main.tex and it may be instructive to copy the file and play with it to learn some of these basic functions.

Both new and experienced users are encouraged to read the excellent guide by @ejmastnak: Getting started with the VimTeX plugin. The guide covers all the fundamentals of setting up a VimTeX-based LaTeX workflow, including usage of the VimTeX plugin, compilation, setting up forward and inverse search with a PDF reader, and Vimscript tools for user-specific customization.

Users are of course strongly encouraged to read the documentation, at least the introduction, to learn about the different features and possibilities provided by VimTeX (see :h vimtex). Advanced users and potential developers may also be interested in reading the supplementary documents:

• CONTRIBUTING.md
• DOCUMENTATION.md

Here is an example of the syntax highlighting provided by VimTeX. The conceal feature is active on the right-hand side split. The example is made by @DustyTopology with the vim-colors-xcode colorscheme with some minor adjustments described here.

See the file VISUALS.md for screencast-style GIFs demonstrating VimTeX's core motions, text-editing commands, and text objects.

Below is a list of features offered by VimTeX. The features are accessible as both commands and mappings. The mappings generally start with <localleader>l, but if desired one can disable default mappings to define custom mappings. Nearly all features are enabled by default, but each feature may be disabled if desired. The two exceptions are code folding and formating, which are disabled by default and must be manually enabled.

• Document compilation with latexmk, latexrun, tectonic, or arara
• LaTeX log parsing for quickfix entries using
  • internal method
  • pplatex
• Compilation of selected part of document
• Support for several PDF viewers with forward search
  • MuPDF
  • Okular
  • qpdfview
  • Skim
  • SumatraPDF
  • TeXShop
  • Zathura
  • Other viewers are supported through a general interface
• Completion of
  • citations
  • labels
  • commands
  • file names for figures, input/include, includepdf, includestandalone
  • glossary entries
  • package and documentclass names based on available .sty and .cls files
• Document navigation through
  • table of contents
  • table of labels
  • proper settings for 'include', 'includeexpr', 'suffixesadd' and 'define', which among other things
    • allow :h include-search and :h definition-search
    • give enhanced gf command
• Easy access to (online) documentation of packages
• Word count (through texcount)
• Motions (link to GIF demonstrations)
  • Move between section boundaries with [[, [], ][, and ]]
  • Move between environment boundaries with [m, [M, ]m, and ]M
  • Move between math environment boundaries with [n, [N, ]n, and ]N
  • Move between frame environment boundaries with [r, [R, ]r, and ]R
  • Move between comment boundaries with [* and ]*
  • Move between matching delimiters with %
• Text objects (link to GIF demonstrations)
  • ic ac Commands
  • id ad Delimiters
  • ie ae LaTeX environments
  • i$ a$ Math environments
  • iP aP Sections
  • im am Items
• Other mappings (link to GIF demonstrations)
  • Delete the surrounding command, environment or delimiter with dsc/dse/ds$/dsd
  • Change the surrounding command, environment or delimiter with csc/cse/cs$/csd
  • Toggle between complementary environments with tse (see v2.16 release notes)
  • Toggle starred command or environment with tsc/tss
  • Toggle inline and displaymath with ts$
  • Toggle between e.g. () and \left(\right) with tsd
  • Toggle (inline) fractions with tsf
  • Toggle line-break macro \\ with tsb
  • Close the current environment/delimiter in insert mode with ]]
  • Add \left ... \right) modifiers to surrounding delimiters with <F8>
  • Insert new command with <F7>
  • Convenient insert mode mappings for faster typing of e.g. maths
  • Context menu on citations (e.g. \cite{...}) mapped to <cr>
• Improved folding (:h 'foldexpr')
• Improved indentation (:h 'indentexpr')
• Syntax highlighting
  • A consistent core syntax specification
  • General syntax highlighting for several popular LaTeX packages
  • Nested syntax highlighting for several popular LaTeX packages
  • Highlight matching delimiters
• Support for multi-file project packages
  • import
  • subfiles

See the documentation for a thorough introduction to VimTeX (e.g. :h vimtex).

Even though VimTeX provides a lot of nice features for working with LaTeX documents, there are several features that are better served by other, dedicated plugins. For a more detailed listing of these, please see :help vimtex-and-friends.

• ale
• neomake
• syntastic

• UltiSnips
• neosnippet

• vim-gutentags

The following are some alternative LaTeX plugins for Vim:

• LaTeX-Suite

  The main difference between VimTeX and LaTeX-Suite (aka vim-latex) is probably that VimTeX does not try to implement a full fledged IDE for LaTeX inside Vim. E.g.:

  • VimTeX does not provide a full snippet feature, because this is better handled by UltiSnips or neosnippet or similar snippet engines.
  • VimTeX builds upon Vim principles: It provides text objects for environments, inline math, it provides motions for sections and paragraphs
  • VimTeX uses latexmk, latexrun, tectonic or arara for compilation with a callback feature to get instant feedback on compilation errors
  • VimTeX is very modular: if you don't like a feature, you can turn it off.

• TexMagic.nvim

  "A simple, lightweight Neovim plugin that facilitates LaTeX build engine selection via magic comments. It is designed with the TexLab LSP server's build functionality in mind, which at the time of this plugin's inception had to be specified in init.lua/init.vim and could not be set on a by-project basis."

  This plugin should be combined with the TexLab LSP server, and it only works on neovim.

• LaTeX-Box

  VimTeX currently has most of the features of LaTeX-Box, as well as some additional ones. See here for a relatively complete list of features.

  One particular feature that LaTeX-Box has but VimTeX misses, is the ability to do single-shot compilation with callback. This functionality was removed because it adds a lot of complexity for relatively little gain (IMHO).

• AutomaticTexPlugin

• vim-latex-live-preview

For more alternatives and more information and discussions regarding LaTeX plugins for Vim, see:

• What are the differences between LaTeX plugins
• List of LaTeX editors (not only Vim)