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