X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/81a417ffbe1fc1a67ed28e9322690888e2f49160..071f06220f7e61a020de4895c1bf936ec99a12a8:/README.md?ds=inline diff --git a/README.md b/README.md index 843405f..dd67309 100644 --- a/README.md +++ b/README.md @@ -6,12 +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`: - Bundle 'plasticboy/vim-markdown' + Plugin 'plasticboy/vim-markdown' And then run inside Vim: :so ~/.vimrc - :BundleInstall + :PluginInstall If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this: @@ -48,21 +48,27 @@ 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.