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 the following to your `.vimrc`:
  76
  77 ```vim
  78 let g:vim_markdown_folding_style_pythonic = 1
  79 ```
  80
  81 Level 1 heading which is served as a document title is not folded.
  82 `g:vim_markdown_folding_level` setting is not active with this fold style.
  83
  84 ### Set header folding level
  85
  86 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
  87
  88 ```vim
  89 let g:vim_markdown_folding_level = 6
  90 ```
  91
  92 Tip: it can be changed on the fly with:
  93
  94 ```vim
  95 :let g:vim_markdown_folding_level = 1
  96 :edit
  97 ```
  98
  99 ### Disable Default Key Mappings
 100
 101 Add the following line to your `.vimrc` to disable default key mappings:
 102
 103 ```vim
 104 let g:vim_markdown_no_default_key_mappings = 1
 105 ```
 106
 107 You can also map them by yourself with `<Plug>` mappings.
 108
 109 ### Enable TOC window auto-fit
 110
 111 Allow for the TOC window to auto-fit when it's possible for it to shrink.
 112 It never increases its default size (half screen), it only shrinks.
 113
 114 ```vim
 115 let g:vim_markdown_toc_autofit = 1
 116 ```
 117
 118 ### Text emphasis restriction to single-lines
 119
 120 By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (ie, for it to be applied a closing token must be found on the same line). To do so:
 121
 122 ```vim
 123 let g:vim_markdown_emphasis_multiline = 0
 124 ```
 125
 126 ### Syntax Concealing
 127
 128 Concealing is set for some syntax.
 129
 130 For example, conceal `[link text](link url)` as just `link text`.
 131 Also, `_italic_` and `*italic*` will conceal to just _italic_.
 132 Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***`
 133 will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively.
 134
 135 To enable conceal use Vim's standard conceal configuration.
 136
 137 ```vim
 138 set conceallevel=2
 139 ```
 140
 141 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
 142
 143 ```vim
 144 let g:vim_markdown_conceal = 0
 145 ```
 146
 147 ### Fenced code block languages
 148
 149 You can use filetype name as fenced code block languages for syntax highlighting.
 150 If you want to use different name from filetype, you can add it in your `.vimrc` like so:
 151
 152 ```vim
 153 let g:vim_markdown_fenced_languages = ['csharp=cs']
 154 ```
 155
 156 This will cause the following to be highlighted using the `cs` filetype syntax.
 157
 158     ```csharp
 159     ...
 160     ```
 161
 162 Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
 163
 164 ### Syntax extensions
 165
 166 The following options control which syntax extensions will be turned on. They are off by default.
 167
 168 #### LaTeX math
 169
 170 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 171
 172 ```vim
 173 let g:vim_markdown_math = 1
 174 ```
 175
 176 #### YAML Front Matter
 177
 178 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
 179
 180 ```vim
 181 let g:vim_markdown_frontmatter = 1
 182 ```
 183
 184 #### TOML Front Matter
 185
 186 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 187
 188 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
 189
 190 ```vim
 191 let g:vim_markdown_toml_frontmatter = 1
 192 ```
 193
 194 #### JSON Front Matter
 195
 196 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 197
 198 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 199
 200 ```vim
 201 let g:vim_markdown_json_frontmatter = 1
 202 ```
 203
 204 ### Adjust new list item indent
 205
 206 You can adjust a new list indent. For example, you insert a single line like below:
 207
 208 ```
 209 * item1
 210 ```
 211
 212 Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
 213
 214 ```
 215 * item1
 216     * item2
 217 ```
 218
 219 vim-markdown automatically insert the indent. By default, the number of spaces of indent is 4. If you'd like to change the number as 2, just write:
 220
 221 ```vim
 222 let g:vim_markdown_new_list_item_indent = 2
 223 ```
 224
 225
 226 ## Mappings
 227
 228 The following work on normal and visual modes:
 229
 230 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 231
 232     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 233
 234     For example, all the following cursor positions will work:
 235
 236         [Example](http://example.com)
 237         ^  ^    ^^   ^       ^
 238         1  2    34   5       6
 239
 240         <http://example.com>
 241         ^  ^               ^
 242         1  2               3
 243
 244     Known limitation: does not work for links that span multiple lines.
 245
 246 -   `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
 247
 248     The rules for the cursor position are the same as the `gx` command.
 249
 250 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 251
 252 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 253
 254 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
 255
 256 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
 257
 258 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 259
 260 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 261
 262 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 263
 264     map asdf <Plug>Markdown_MoveToParentHeader
 265
 266 To disable a map use:
 267
 268     map <Plug> <Plug>Markdown_MoveToParentHeader
 269
 270 ## Commands
 271
 272 The following requires `:filetype plugin on`.
 273
 274 -   `:HeaderDecrease`:
 275
 276     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 277
 278     If range is given, only operate in the range.
 279
 280     If an `h1` would be decreased, abort.
 281
 282     For simplicity of implementation, Setex headers are converted to Atx.
 283
 284 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 285
 286 -   `:SetexToAtx`:
 287
 288     Convert all Setex style headers in buffer to Atx.
 289
 290     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 291
 292 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
 293
 294     Requires [Tabular](https://github.com/godlygeek/tabular).
 295
 296     The input table *must* already have a separator line as the second line of the table.
 297     That line only needs to contain the correct pipes `|`, nothing else is required.
 298
 299 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 300
 301     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 302
 303 -   `:Toch`: Same as `:Toc` but in an horizontal window.
 304
 305 -   `:Toct`: Same as `:Toc` but in a new tab.
 306
 307 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.
 308
 309 ## Credits
 310
 311 The main contributors of vim-markdown are:
 312
 313 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 314
 315 If you feel that your name should be on this list, please make a pull request listing your contributions.
 316
 317 ## License
 318
 319 The MIT License (MIT)
 320
 321 Copyright (c) 2012 Benjamin D. Williams
 322
 323 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:
 324
 325 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 326
 327 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.