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