X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/81a417ffbe1fc1a67ed28e9322690888e2f49160..2d54234befa961ca8ee85de0aadc2f9c3ec04d31:/README.md diff --git a/README.md b/README.md index 843405f..7d75420 100644 --- a/README.md +++ b/README.md @@ -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. @@ -71,6 +77,24 @@ The following commands currently only work for atx style headers (`#`). Pull req - `:Toct`: Same as `:Toc` but in a new tab. - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`. +- `:SetexToAtx`: + + Convert all Setex style headers in buffer to Atx. + + If a range is given, e.g. hit `:` from visual mode, only operate on the range. + +- `:HeaderDecrease`: + + Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc. + + 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. + ## Credits The main contributors of vim-markdown are: