X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/26cfc8ef05385a8b5f526c4d461d982a82b119b2..d57a363718a4469233b543f359b072831c467476:/README.md diff --git a/README.md b/README.md index a11299b..175d3a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Markdown Vim Mode -Syntax highlighting and matching rules for [Markdown](http://daringfireball.net/projects/markdown/). +Syntax highlighting, matching rules and mappings for [Markdown](http://daringfireball.net/projects/markdown/). ## Installation @@ -16,6 +16,37 @@ To install without Pathogen, download the [tarball](https://github.com/plasticbo [Homepage](http://plasticboy.com/markdown-vim-mode/) +## Options + +**Disable Folding** + +Add the following line to your `.vimrc` to disable folding. + +```vim +let g:vim_markdown_folding_disabled=1 +``` + +**Set Initial Foldlevel** + +Add the following line to your `.vimrc` to set the initial foldlevel. This +option defaults to 0 (i.e. all folds are closed) and is ignored if folding +is disabled. + +```vim +let g:vim_markdown_initial_foldlevel=1 +``` + +## Mappings + +the following work on normal and visual modes: + +- `]]`: go to next header +- `[[`: go to previous header +- `][`: 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) + ## License The MIT License (MIT)