X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/d607e138df7c559d907723b8ab4955fa63c7a362..f4d217c14cef4d8ae7d8930d0e1a8c8fc3d0e727:/README.md diff --git a/README.md b/README.md index a11299b..95db711 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 @@ -14,7 +14,44 @@ To install without Pathogen, download the [tarball](https://github.com/plasticbo $ cd ~/.vim $ tar --strip=1 -zxf vim-markdown-master.tar.gz -[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. 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). + +## Credits + +The main contributors of vim-markdown are: + +- **Ben Williams** (A.K.A. **platicboy**). 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. ## License