README.md

   1 # Markdown Vim Mode
   2
   3 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
   4
   5 ## Installation
   6
   7 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
   8
   9     Bundle 'plasticboy/vim-markdown'
  10
  11 And then run inside Vim:
  12
  13     :so ~/.vimrc
  14     :BundleInstall
  15
  16 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
  17
  18     $ cd ~/.vim/bundle
  19     $ git clone https://github.com/plasticboy/vim-markdown.git
  20
  21 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
  22
  23     $ git clone https://github.com/plasticboy/vim-markdown.git
  24     $ cd vim-markdown
  25     $ sudo make install
  26     $ vim-addon-manager install mkd
  27
  28 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
  29
  30     $ cd ~/.vim
  31     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
  32
  33 ## Options
  34
  35 **Disable Folding**
  36
  37 Add the following line to your `.vimrc` to disable folding.
  38
  39 ```vim
  40 let g:vim_markdown_folding_disabled=1
  41 ```
  42
  43 **Set Initial Foldlevel**
  44
  45 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.
  46
  47 ```vim
  48 let g:vim_markdown_initial_foldlevel=1
  49 ```
  50
  51 **Disable Default Key Mappings**
  52
  53 Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
  54
  55 ```vim
  56 let g:vim_markdown_no_default_key_mappings=1
  57 ```
  58
  59 ## Mappings
  60
  61 The following work on normal and visual modes:
  62
  63 - `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
  64 - `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
  65 - `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
  66 - `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
  67 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
  68 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
  69
  70 ## Commands
  71
  72 The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`).
  73
  74 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
  75
  76     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
  77
  78 - `:Toch`: Same as `:Toc` but in an horizontal window.
  79 - `:Toct`: Same as `:Toc` but in a new tab.
  80 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
  81
  82 ## Credits
  83
  84 The main contributors of vim-markdown are:
  85
  86 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
  87
  88 If you feel that your name should be on this list, please make a pull request listing your contributions.
  89
  90 ## License
  91
  92 The MIT License (MIT)
  93
  94 Copyright (c) 2012 Benjamin D. Williams
  95
  96 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:
  97
  98 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  99
 100 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.