Use getloclist() for location list of :Toc

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 20a74e3806b319d7b2745c1edd9ae582c61e49f7..18044db9d042181c4871062592ec5f78936dfefa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,9 +6,12 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
 
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
 

+    Plugin 'godlygeek/tabular'

     Plugin 'plasticboy/vim-markdown'
 
     Plugin 'plasticboy/vim-markdown'
 

-And then run inside Vim:
+The `tabular` plugin come *before* `vim-markdown`.
+
+Then run inside Vim:

 
     :so ~/.vimrc
     :PluginInstall
 
     :so ~/.vimrc
     :PluginInstall


@@ -69,13 +72,17 @@ The following work on normal and visual modes:
 
 ## Commands
 
 
 ## Commands
 

-- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
+- `:HeaderDecrease`:

 
 

-    Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
+    Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.

 
 

-- `:Toch`: Same as `:Toc` but in an horizontal window.
-- `:Toct`: Same as `:Toc` but in a new tab.
-- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
+    If range is given, only operate in the range.
+
+    If an `h1` would be decreased, abort.
+
+    For simplicity of implementation, Setex headers are converted to Atx.
+
+- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.

 
 - `:SetexToAtx`:
 
 
 - `:SetexToAtx`:
 


@@ -83,17 +90,22 @@ The following work on normal and visual modes:
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 

-- `:HeaderDecrease`:
+- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).

 
 

-    Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
+    Requires [Tabular](https://github.com/godlygeek/tabular).

 
 

-    If range is given, only operate in the range.
+    The input table *must* already have a separator line as the second line of the table.
+    That line only needs to contain the correct pipes `|`, nothing else is required.

 
 

-    If an `h1` would be decreased, abort.
+- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.

 
 

-    For simplicity of implementation, Setex headers are converted to Atx.
+    Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.

 
 

-- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+- `:Toch`: Same as `:Toc` but in an horizontal window.
+
+- `:Toct`: Same as `:Toc` but in a new tab.
+
+- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.

 
 ## Credits
 
 
 ## Credits