mirror of
https://github.com/dhruvasagar/vim-table-mode.git
synced 2025-11-08 11:03:47 -05:00
ff040d25ceabe06063a14fb0770f92d4626491a2
VIM Table Mode
An awesome automatic table creator & formatter allowing one to create neat tables as you type.
Installation
There are 2 ways to do this
-
I recommend installing pathogen.vim and then adding a git submodule for your plugin:
$ cd ~/.vim $ git submodule add git@github.com:dhruvasagar/vim-table-mode.git bundle/table-mode
2. Copy table-mode.vim into ~/.vim/plugin/ (Unix) or vimfiles/plugin/ (Windows)
as with other plugins.
# Requirements
Depends on <a href="https://github.com/godlygeek/tabular">Tabular</a>. Make
sure Tabular is installed and loaded into your runtime to ensure this works.
# Usage
By default the table column separator is '|' (it can be changed). As soon as
you type it on a new line (ignores indentation) the script gets to work on
creating the table around it. As you type and define more columns, the table is
completed, formatted and aligned automatically.
Since this could lead to unwanted behavior I have disabled table mode by
default. You would have to use `:TableModeToggle` command or the table mode
toggle mapping, which is `<Leader>tm` by default. This is on a per buffer basis
and so it does not mess up unless enabled explicitly. Please read `:h table-mode`
for further information.
Demo:
<iframe width="420" height="315"
src="http://www.youtube.com/embed/sK2IH1hiDkw?rel=0" frameborder="0"
allowfullscreen></iframe>
# Credits
I must thank Tim Pope for inspiration. The initial concept was created by him
named cucumbertables.vim and can be found <a
href="https://gist.github.com/tpope/287147">here</a>.
Also a shout out to godlygeek who developed the incredible <a
href="http://github.com/godlygeek/tabular">Tabular</a> plugin which does most
of the grunt work behind the scenes.
Description
Languages
Vim Script
100%