README.md

   1 # Markdown Vim Mode
   2
   3 [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown)
   4
   5 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
   6
   7 ## Installation
   8
   9 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
  10
  11 ```vim
  12 Plugin 'godlygeek/tabular'
  13 Plugin 'plasticboy/vim-markdown'
  14 ```
  15
  16 The `tabular` plugin must come *before* `vim-markdown`.
  17
  18 Then run inside Vim:
  19
  20 ```vim
  21 :so ~/.vimrc
  22 :PluginInstall
  23 ```
  24
  25 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
  26
  27 ```sh
  28 cd ~/.vim/bundle
  29 git clone https://github.com/plasticboy/vim-markdown.git
  30 ```
  31
  32 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
  33
  34 ```sh
  35 git clone https://github.com/plasticboy/vim-markdown.git
  36 cd vim-markdown
  37 sudo make install
  38 vim-addon-manager install mkd
  39 ```
  40
  41 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
  42
  43 ```sh
  44 cd ~/.vim
  45 tar --strip=1 -zxf vim-markdown-master.tar.gz
  46 ```
  47
  48 ## Options
  49
  50 **Disable Folding**
  51
  52 Add the following line to your `.vimrc` to disable folding.
  53
  54 ```vim
  55 let g:vim_markdown_folding_disabled=1
  56 ```
  57
  58 **Set Initial Foldlevel**
  59
  60 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.
  61
  62 ```vim
  63 let g:vim_markdown_initial_foldlevel=1
  64 ```
  65
  66 **Disable Default Key Mappings**
  67
  68 Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
  69
  70 ```vim
  71 let g:vim_markdown_no_default_key_mappings=1
  72 ```
  73
  74 **Syntax extensions**
  75
  76 The following options control which syntax extensions will be turned on.
  77
  78 LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`:
  79
  80 ```vim
  81 let g:vim_markdown_math=1
  82 ```
  83 ## Mappings
  84
  85 The following work on normal and visual modes:
  86
  87 - `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
  88 - `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
  89 - `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
  90 - `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
  91 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
  92 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
  93
  94 ## Commands
  95
  96 - `:HeaderDecrease`:
  97
  98     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
  99
 100     If range is given, only operate in the range.
 101
 102     If an `h1` would be decreased, abort.
 103
 104     For simplicity of implementation, Setex headers are converted to Atx.
 105
 106 - `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 107
 108 - `:SetexToAtx`:
 109
 110     Convert all Setex style headers in buffer to Atx.
 111
 112     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 113
 114 - `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
 115
 116     Requires [Tabular](https://github.com/godlygeek/tabular).
 117
 118     The input table *must* already have a separator line as the second line of the table.
 119     That line only needs to contain the correct pipes `|`, nothing else is required.
 120
 121 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 122
 123     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 124
 125 - `:Toch`: Same as `:Toc` but in an horizontal window.
 126
 127 - `:Toct`: Same as `:Toc` but in a new tab.
 128
 129 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 130
 131 ## Credits
 132
 133 The main contributors of vim-markdown are:
 134
 135 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 136
 137 If you feel that your name should be on this list, please make a pull request listing your contributions.
 138
 139 ## License
 140
 141 The MIT License (MIT)
 142
 143 Copyright (c) 2012 Benjamin D. Williams
 144
 145 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:
 146
 147 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 148
 149 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.