vimtex/README.md

57 lines
2.3 KiB
Markdown
Raw Normal View History

2013-10-05 07:53:42 -04:00
# vim-latex
## Introduction
There exists several LaTeX plugins for vim, for instance:
2013-10-05 10:39:04 -04:00
- [LaTeX-Suite](http://vim-latex.sourceforge.net):
[vimscript#475](http://www.vim.org/scripts/script.php?script_id=475)
- [AutomaticTexPlugin](http://atp-vim.sourceforge.net):
[vimscript#2945](http://www.vim.org/scripts/script.php?script_id=2945)
- [LaTeX-Box](https://github.com/LaTeX-Box-Team/LaTeX-Box):
[vimscript#3109](http://www.vim.org/scripts/script.php?script_id=3109)
2013-10-05 07:53:42 -04:00
I have been using both LaTeX-Suite and LaTeX-Box myself, but I found both of
these to be relatively bulky and difficult to manage and extend. LaTeX-Box
was supposed to be simple and lightweight, and I think it was close to being
just that. However, after having worked on it for some time, I felt that much
of the simplicity could be improved by a complete restructuring.
Enter vim-latex, which is a lightweight and simple plugin that provides LaTeX
support for vim. It has most of the functionality of LaTeX-Box, but the idea
is to combine vim-latex with the strength of other plugins. I personally
recommend [UltiSnips](https://github.com/SirVer/ultisnips) for snippets and
[neocomplete](https://github.com/Shougo/neocomplete.vim) for completion.
Note, however, that I do not fully support windows at the current time. That
is, the latexmk functionality will most probably not work. The reason for this
is that I do not personally use windows, which makes it difficult to test.
With some assistance I might consider adding support for windows at a later
time.
2013-10-05 07:53:42 -04:00
Read the documentation for a more thorough introduction.
## Installation
### With gmarik vundle
_https://github.com/gmarik/vundle_
Add `Bundle 'lervag/vim-latex'` to your ~/.vimrc and run
`:BundleInstall` in a vim buffer. Add `!` to the command to update.
### With neobundle
_https://github.com/Shougo/neobundle.vim_
Add `NeoBundle 'lervag/vim-latex'` to your ~/.vimrc and run
`:NeoBundleInstall` in a vim buffer. Add `!` to the command to update.
### With pathogen
_https://github.com/tpope/vim-pathogen_
Add the vim-latex bundle to your bundle directory, for instance with `git
clone`. This will typically be enough:
cd ~/.vim/bundle
git clone git://github.com/lervag/vim-latex
### Without a plugin manager
Copy the directories to your `.vim/` folder.