README.md

   1 # Markdown Vim Mode
   2
   3 Syntax highlighting, matching rules and mappings for [Markdown](http://daringfireball.net/projects/markdown/).
   4
   5 ## Installation
   6
   7 If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this:
   8
   9     $ cd ~/.vim/bundle
  10     $ git clone https://github.com/plasticboy/vim-markdown.git
  11
  12 To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
  13
  14     $ cd ~/.vim
  15     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
  16
  17 [Homepage](http://plasticboy.com/markdown-vim-mode/)
  18
  19 ## Options
  20
  21 **Disable Folding**
  22
  23 Add the following line to your `.vimrc` to disable folding.
  24
  25 ```vim
  26 let g:vim_markdown_folding_disabled=1
  27 ```
  28
  29 ## Mappings
  30
  31 - `nn ]]`: go to next header
  32 - `nn ][`: go to next sibling header if any
  33 - `nn ]u`: go to parent header (Up)
  34 - `nn [[`: go to previous header
  35 - `nn []`: go to previous sibling header if any
  36
  37 ## License
  38
  39 The MIT License (MIT)
  40
  41 Copyright (c) 2012 Benjamin D. Williams
  42
  43 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  44
  45 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  46
  47 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.