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 configuration.
  53
  54 ```vim
  55 let g:vim_markdown_folding_disabled=1
  56 ```
  57
  58 This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
  59
  60 ```vim
  61 set [no]foldenable
  62 ```
  63
  64 ### Set Initial Foldlevel
  65
  66 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.
  67
  68 ```vim
  69 let g:vim_markdown_initial_foldlevel=1
  70 ```
  71
  72 ### Disable Default Key Mappings
  73
  74 Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
  75
  76 ```vim
  77 let g:vim_markdown_no_default_key_mappings=1
  78 ```
  79
  80 ### Syntax extensions
  81
  82 The following options control which syntax extensions will be turned on. They are off by default.
  83
  84 #### LaTeX math
  85
  86 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
  87
  88 ```vim
  89 let g:vim_markdown_math=1
  90 ```
  91
  92 #### YAML frontmatter
  93
  94 Highlight YAML frontmatter as used by Jekyll:
  95
  96 ```vim
  97 let g:vim_markdown_frontmatter=1
  98 ```
  99
 100 ## Mappings
 101
 102 The following work on normal and visual modes:
 103
 104 - `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
 105 - `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
 106 - `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
 107 - `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
 108 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
 109 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
 110
 111 ## Commands
 112
 113 - `:HeaderDecrease`:
 114
 115     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 116
 117     If range is given, only operate in the range.
 118
 119     If an `h1` would be decreased, abort.
 120
 121     For simplicity of implementation, Setex headers are converted to Atx.
 122
 123 - `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 124
 125 - `:SetexToAtx`:
 126
 127     Convert all Setex style headers in buffer to Atx.
 128
 129     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 130
 131 - `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
 132
 133     Requires [Tabular](https://github.com/godlygeek/tabular).
 134
 135     The input table *must* already have a separator line as the second line of the table.
 136     That line only needs to contain the correct pipes `|`, nothing else is required.
 137
 138 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 139
 140     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 141
 142 - `:Toch`: Same as `:Toc` but in an horizontal window.
 143
 144 - `:Toct`: Same as `:Toc` but in a new tab.
 145
 146 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 147
 148 ## Credits
 149
 150 The main contributors of vim-markdown are:
 151
 152 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 153
 154 If you feel that your name should be on this list, please make a pull request listing your contributions.
 155
 156 ## License
 157
 158 The MIT License (MIT)
 159
 160 Copyright (c) 2012 Benjamin D. Williams
 161
 162 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:
 163
 164 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 165
 166 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.