X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/3309ad4d293d2431008d7ec56faadfdcf334d5b9..ff4fc395a7787957f8b940f4fd7189d910d4169e:/README.md diff --git a/README.md b/README.md index a11299b..e6f1824 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,61 @@ # 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 -If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this: +If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`: + + Bundle 'plasticboy/vim-markdown' + +And then run inside Vim: + + :so ~/.vimrc + :BundleInstall + +If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this: $ cd ~/.vim/bundle $ git clone https://github.com/plasticboy/vim-markdown.git -To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: +If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: $ 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). + ## License The MIT License (MIT)