vim/vimtex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated the README file

Browse Source
This commit is contained in:
Karl Yngve Lervåg 2015-03-08 19:12:31 +01:00
parent e906ceca5a
commit 0bb6f1c937
1 changed files with 21 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -2,29 +2,14 @@
## Introduction
There exists several LaTeX plugins for vim, for instance:
- [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)
- [vim-latex-live-preview](https://github.com/xuhdev/vim-latex-live-preview):
[vimscript#4524](http://www.vim.org/scripts/script.php?script_id=4524)
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 vimtex, 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 vimtex 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.
Read the documentation for a more thorough introduction.
`vimtex` is a [vim](http://www.vim.org/) plugin that provides support for writing LaTeX documents. The
main features are:
1. Control over document compilation (through [latexmk](http://users.phys.psu.edu/~collins/software/latexmk-jcc/))
2. Completion of citations and labels
3. A Convenient table of contents
4. Control over `pdf` viewers with forward search for several different viewers
5. Some vim motions and mappings
See the [documentation](https://raw.githubusercontent.com/lervag/vimtex/master/doc/vimtex.txt) for a more thorough introduction of the plugin.
## Installation
@ -53,3 +38,16 @@ clone`. This will typically be enough:
Copy the directories to your `.vim/` folder.
## Alternatives
There exists several vim plugins for writing LaTeX documents. Some of the most
popular and/or interesting ones are:
- [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)
- [vim-latex-live-preview](https://github.com/xuhdev/vim-latex-live-preview):
[vimscript#4524](http://www.vim.org/scripts/script.php?script_id=4524)