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 Also, `_italic_` and `*italic*` will conceal to just _italic_.
 138 Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***`
 139 will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively.
 140
 141 To enable conceal use Vim's standard conceal configuration.
 142
 143 ```vim
 144 set conceallevel=2
 145 ```
 146
 147 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
 148
 149 ```vim
 150 let g:vim_markdown_conceal = 0
 151 ```
 152
 153 ### Fenced code block languages
 154
 155 You can use filetype name as fenced code block languages for syntax highlighting.
 156 If you want to use different name from filetype, you can add it in your `.vimrc` like so:
 157
 158 ```vim
 159 let g:vim_markdown_fenced_languages = ['csharp=cs']
 160 ```
 161
 162 This will cause the following to be highlighted using the `cs` filetype syntax.
 163
 164     ```csharp
 165     ...
 166     ```
 167
 168 Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
 169
 170 ### Syntax extensions
 171
 172 The following options control which syntax extensions will be turned on. They are off by default.
 173
 174 #### LaTeX math
 175
 176 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 177
 178 ```vim
 179 let g:vim_markdown_math = 1
 180 ```
 181
 182 #### YAML Front Matter
 183
 184 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
 185
 186 ```vim
 187 let g:vim_markdown_frontmatter = 1
 188 ```
 189
 190 #### TOML Front Matter
 191
 192 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 193
 194 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
 195
 196 ```vim
 197 let g:vim_markdown_toml_frontmatter = 1
 198 ```
 199
 200 #### JSON Front Matter
 201
 202 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 203
 204 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 205
 206 ```vim
 207 let g:vim_markdown_json_frontmatter = 1
 208 ```
 209
 210 ### Adjust new list item indent
 211
 212 You can adjust a new list indent. For example, you insert a single line like below:
 213
 214 ```
 215 * item1
 216 ```
 217
 218 Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
 219
 220 ```
 221 * item1
 222     * item2
 223 ```
 224
 225 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:
 226
 227 ```vim
 228 let g:vim_markdown_new_list_item_indent = 2
 229 ```
 230
 231 ### Do not require .md extensions for Markdown links
 232
 233 If you want to have a link like this `[link text](link-url)` and follow it for editing in vim using the `ge` command, but have it open the file "link-url.md" instead of the file "link-url", then use this option:
 234
 235 ```vim
 236 let g:vim_markdown_no_extensions_in_markdown = 1
 237 ```
 238 This is super useful for GitLab and GitHub wiki repositories.
 239
 240 Normal behaviour would be that vim-markup required you to do this `[link text](link-url.md)`, but this is not how the Gitlab and GitHub wiki repositories work. So this option adds some consistency between the two.
 241
 242 ### Auto-write when following link
 243
 244 If you follow a link like this `[link text](link-url)` using the `ge` shortcut, this option will automatically save any edits you made before moving you:
 245
 246 ```vim
 247 let g:vim_markdown_autowrite = 1
 248 ```
 249
 250 ## Mappings
 251
 252 The following work on normal and visual modes:
 253
 254 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 255
 256     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 257
 258     For example, all the following cursor positions will work:
 259
 260         [Example](http://example.com)
 261         ^  ^    ^^   ^       ^
 262         1  2    34   5       6
 263
 264         <http://example.com>
 265         ^  ^               ^
 266         1  2               3
 267
 268     Known limitation: does not work for links that span multiple lines.
 269
 270 -   `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
 271
 272     The rules for the cursor position are the same as the `gx` command.
 273
 274 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 275
 276 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 277
 278 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
 279
 280 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
 281
 282 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 283
 284 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 285
 286 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 287
 288     map asdf <Plug>Markdown_MoveToParentHeader
 289
 290 To disable a map use:
 291
 292     map <Plug> <Plug>Markdown_MoveToParentHeader
 293
 294 ## Commands
 295
 296 The following requires `:filetype plugin on`.
 297
 298 -   `:HeaderDecrease`:
 299
 300     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 301
 302     If range is given, only operate in the range.
 303
 304     If an `h1` would be decreased, abort.
 305
 306     For simplicity of implementation, Setex headers are converted to Atx.
 307
 308 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 309
 310 -   `:SetexToAtx`:
 311
 312     Convert all Setex style headers in buffer to Atx.
 313
 314     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 315
 316 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
 317
 318     Requires [Tabular](https://github.com/godlygeek/tabular).
 319
 320     The input table *must* already have a separator line as the second line of the table.
 321     That line only needs to contain the correct pipes `|`, nothing else is required.
 322
 323 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 324
 325     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 326
 327 -   `:Toch`: Same as `:Toc` but in an horizontal window.
 328
 329 -   `:Toct`: Same as `:Toc` but in a new tab.
 330
 331 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.
 332
 333 ## Credits
 334
 335 The main contributors of vim-markdown are:
 336
 337 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 338
 339 If you feel that your name should be on this list, please make a pull request listing your contributions.
 340
 341 ## License
 342
 343 The MIT License (MIT)
 344
 345 Copyright (c) 2012 Benjamin D. Williams
 346
 347 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:
 348
 349 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 350
 351 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.