README.md

   1 # Vim Markdown
   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 1. [Installation](#installation)
   8 1. [Options](#options)
   9 1. [Mappings](#mappings)
  10 1. [Commands](#commands)
  11 1. [Credits](#credits)
  12 1. [License](#license)
  13
  14 ## Installation
  15
  16 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
  17
  18 ```vim
  19 Plugin 'godlygeek/tabular'
  20 Plugin 'plasticboy/vim-markdown'
  21 ```
  22
  23 The `tabular` plugin must come *before* `vim-markdown`.
  24
  25 Then run inside Vim:
  26
  27 ```vim
  28 :so ~/.vimrc
  29 :PluginInstall
  30 ```
  31
  32 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
  33
  34 ```sh
  35 cd ~/.vim/bundle
  36 git clone https://github.com/plasticboy/vim-markdown.git
  37 ```
  38
  39 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
  40
  41 ```sh
  42 git clone https://github.com/plasticboy/vim-markdown.git
  43 cd vim-markdown
  44 sudo make install
  45 vim-addon-manager install markdown
  46 ```
  47
  48 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
  49
  50 ```sh
  51 cd ~/.vim
  52 tar --strip=1 -zxf vim-markdown-master.tar.gz
  53 ```
  54
  55 ## Options
  56
  57 ### Disable Folding
  58
  59 Add the following line to your `.vimrc` to disable the folding configuration:
  60
  61 ```vim
  62 let g:vim_markdown_folding_disabled = 1
  63 ```
  64
  65 This option only controls Vim Markdown specific folding configuration.
  66
  67 To enable/disable folding use Vim's standard folding configuration.
  68
  69 ```vim
  70 set [no]foldenable
  71 ```
  72
  73 ### Change fold style
  74
  75 To fold in a style like [python-mode](https://github.com/klen/python-mode), add
  76 the following to your `.vimrc`:
  77
  78 ```vim
  79 let g:vim_markdown_folding_style_pythonic = 1
  80 ```
  81
  82 ### Set header folding level
  83
  84 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
  85
  86 ```vim
  87 let g:vim_markdown_folding_level = 6
  88 ```
  89
  90 Tip: it can be changed on the fly with:
  91
  92 ```vim
  93 :let g:vim_markdown_folding_level = 1
  94 :edit
  95 ```
  96
  97 ### Disable Default Key Mappings
  98
  99 Add the following line to your `.vimrc` to disable default key mappings:
 100
 101 ```vim
 102 let g:vim_markdown_no_default_key_mappings = 1
 103 ```
 104
 105 You can also map them by yourself with `<Plug>` mappings.
 106
 107 ### Enable TOC window auto-fit
 108
 109 Allow for the TOC window to auto-fit when it's possible for it to shrink.
 110 It never increases its default size (half screen), it only shrinks.
 111
 112 ```vim
 113 let g:vim_markdown_toc_autofit = 1
 114 ```
 115
 116 ### Syntax Concealing
 117
 118 Concealing is set for some syntax.
 119
 120 For example, conceal `[link text](link url)` as just `link text`.
 121
 122 To enable/disable conceal use Vim's standard conceal configuration.
 123
 124 ```vim
 125 set conceallevel = 2
 126 ```
 127
 128 ### Syntax extensions
 129
 130 The following options control which syntax extensions will be turned on. They are off by default.
 131
 132 #### LaTeX math
 133
 134 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 135
 136 ```vim
 137 let g:vim_markdown_math = 1
 138 ```
 139
 140 #### YAML frontmatter
 141
 142 Highlight YAML frontmatter as used by Jekyll:
 143
 144 ```vim
 145 let g:vim_markdown_frontmatter = 1
 146 ```
 147
 148
 149 ## Mappings
 150
 151 The following work on normal and visual modes:
 152
 153 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 154
 155     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 156
 157     For example, all the following cursor positions will work:
 158
 159         [Example](http://example.com)
 160         ^  ^    ^^   ^       ^
 161         1  2    34   5       6
 162
 163         <http://example.com>
 164         ^  ^               ^
 165         1  2               3
 166
 167     Known limitation: does not work for links that span multiple lines.
 168
 169 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 170
 171 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 172
 173 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
 174
 175 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
 176
 177 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 178
 179 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 180
 181 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 182
 183     map asdf <Plug>Markdown_MoveToParentHeader
 184
 185 To disable a map use:
 186
 187     map <Plug> <Plug>Markdown_MoveToParentHeader
 188
 189 ## Commands
 190
 191 The following requires `:filetype plugin on`.
 192
 193 -   `:HeaderDecrease`:
 194
 195     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 196
 197     If range is given, only operate in the range.
 198
 199     If an `h1` would be decreased, abort.
 200
 201     For simplicity of implementation, Setex headers are converted to Atx.
 202
 203 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 204
 205 -   `:SetexToAtx`:
 206
 207     Convert all Setex style headers in buffer to Atx.
 208
 209     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 210
 211 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
 212
 213     Requires [Tabular](https://github.com/godlygeek/tabular).
 214
 215     The input table *must* already have a separator line as the second line of the table.
 216     That line only needs to contain the correct pipes `|`, nothing else is required.
 217
 218 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 219
 220     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 221
 222 -   `:Toch`: Same as `:Toc` but in an horizontal window.
 223
 224 -   `:Toct`: Same as `:Toc` but in a new tab.
 225
 226 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 227
 228 ## Credits
 229
 230 The main contributors of vim-markdown are:
 231
 232 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 233
 234 If you feel that your name should be on this list, please make a pull request listing your contributions.
 235
 236 ## License
 237
 238 The MIT License (MIT)
 239
 240 Copyright (c) 2012 Benjamin D. Williams
 241
 242 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:
 243
 244 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 245
 246 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.