X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8b892fdff239355a89871f7a094cbc85ea5fc736..378a083529a00be1150e7591747a7cec9c467af7:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 9d66cb4..24c5c6c 100644 --- a/README.md +++ b/README.md @@ -48,22 +48,42 @@ Add the following line to your `.vimrc` to set the initial foldlevel. This optio 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 `` mappings. + +```vim +let g:vim_markdown_no_default_key_mappings=1 +``` + ## Mappings The following work on normal and visual modes: -- `]]`: go to next header. -- `[[`: go to previous header. Contrast with `]c`. -- `][`: go to next sibling header if any. -- `[]`: go to previous sibling header if any. -- `]c`: go to Current header. -- `]u`: go to parent header (Up). +- `]]`: go to next header. `(Markdown_MoveToNextHeader)` +- `[[`: go to previous header. Contrast with `]c`. `(Markdown_MoveToPreviousHeader)` +- `][`: go to next sibling header if any. `(Markdown_MoveToNextSiblingHeader)` +- `[]`: go to previous sibling header if any. `(Markdown_MoveToPreviousSiblingHeader)` +- `]c`: go to Current header. `(Markdown_MoveToCurHeader)` +- `]u`: go to parent header (Up). `(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 `` 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: -- **Ben Williams** (A.K.A. **platicboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/). +- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/). If you feel that your name should be on this list, please make a pull request listing your contributions.