X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/5c38e8609f3782e27bc5c3dd8349d2b88b55996f..3b7499f4cf49a9009d70ab6fac447d258f0097ec:/README.md diff --git a/README.md b/README.md index 871ed65..9d66cb4 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,35 @@ # Markdown Vim Mode -Syntax highlighting, matching rules and mappings for [Markdown](http://daringfireball.net/projects/markdown/). +Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions. ## 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: +To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this: + + $ git clone https://github.com/plasticboy/vim-markdown.git + $ cd vim-markdown + $ sudo make install + $ vim-addon-manager install mkd + +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** @@ -26,13 +40,32 @@ Add the following line to your `.vimrc` to disable folding. 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 -- `nn ]]`: go to next header -- `nn ][`: go to next sibling header if any -- `nn ]u`: go to parent header (Up) -- `nn [[`: go to previous header -- `nn []`: go to previous sibling header if any +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