Merge pull request #76 from cirosantilli/master

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index cc1f7ef96ad2b16fe77cd453b96a55fd53408771..24c5c6c041a6a1e8b9a7d909f7cadf9ab00d3aa6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,10 +50,10 @@ let g:vim_markdown_initial_foldlevel=1
 
 **Disable Default Key Mappings**
 
 
 **Disable Default Key Mappings**
 

-Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings
+Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.

 
 ```vim
 
 ```vim

-let g:markdown_no_default_key_mappings=1
+let g:vim_markdown_no_default_key_mappings=1

 ```
 
 ## Mappings
 ```
 
 ## Mappings


@@ -67,6 +67,18 @@ The following work on normal and visual modes:
 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
 
 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
 

+## Commands
+
+The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`).
+
+- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
+
+    Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
+
+- `: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
 
 The main contributors of vim-markdown are:
 ## Credits
 
 The main contributors of vim-markdown are: