]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Make the default mappings buffer local
[etc/vim.git] / README.md
index cc1f7ef96ad2b16fe77cd453b96a55fd53408771..1c5b246c29a9a9abcf989a20adf0117dfeefa733 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,10 +50,10 @@ let g:vim_markdown_initial_foldlevel=1
 
 **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
-let g:markdown_no_default_key_mappings=1
+let g:vim_markdown_no_default_key_mappings=1
 ```
 
 ## Mappings
@@ -67,6 +67,16 @@ 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)`
 
+## Commands
+
+- `: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: