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 ### Text emphasis restriction to single-lines
 117
 118 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:
 119 ```vim
 120 let g:vim_markdown_emphasis_multiline = 0
 121 ```
 122
 123 ### Syntax Concealing
 124
 125 Concealing is set for some syntax.
 126
 127 For example, conceal `[link text](link url)` as just `link text`.
 128
 129 To enable/disable conceal use Vim's standard conceal configuration.
 130
 131 ```vim
 132 set conceallevel=2
 133 ```
 134
 135 ### Syntax extensions
 136
 137 The following options control which syntax extensions will be turned on. They are off by default.
 138
 139 #### LaTeX math
 140
 141 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 142
 143 ```vim
 144 let g:vim_markdown_math = 1
 145 ```
 146
 147 #### YAML Front Matter
 148
 149 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
 150
 151 ```vim
 152 let g:vim_markdown_frontmatter = 1
 153 ```
 154
 155 #### TOML Front Matter
 156
 157 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 158
 159 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
 160
 161 ```vim
 162 let g:vim_markdown_toml_frontmatter = 1
 163 ```
 164
 165 #### JSON Front Matter
 166
 167 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
 168
 169 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 170
 171 ```vim
 172 let g:vim_markdown_json_frontmatter = 1
 173 ```
 174
 175 ## Mappings
 176
 177 The following work on normal and visual modes:
 178
 179 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 180
 181     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 182
 183     For example, all the following cursor positions will work:
 184
 185         [Example](http://example.com)
 186         ^  ^    ^^   ^       ^
 187         1  2    34   5       6
 188
 189         <http://example.com>
 190         ^  ^               ^
 191         1  2               3
 192
 193     Known limitation: does not work for links that span multiple lines.
 194
 195 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 196
 197 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 198
 199 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
 200
 201 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
 202
 203 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 204
 205 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 206
 207 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 208
 209     map asdf <Plug>Markdown_MoveToParentHeader
 210
 211 To disable a map use:
 212
 213     map <Plug> <Plug>Markdown_MoveToParentHeader
 214
 215 ## Commands
 216
 217 The following requires `:filetype plugin on`.
 218
 219 -   `:HeaderDecrease`:
 220
 221     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 222
 223     If range is given, only operate in the range.
 224
 225     If an `h1` would be decreased, abort.
 226
 227     For simplicity of implementation, Setex headers are converted to Atx.
 228
 229 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 230
 231 -   `:SetexToAtx`:
 232
 233     Convert all Setex style headers in buffer to Atx.
 234
 235     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 236
 237 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
 238
 239     Requires [Tabular](https://github.com/godlygeek/tabular).
 240
 241     The input table *must* already have a separator line as the second line of the table.
 242     That line only needs to contain the correct pipes `|`, nothing else is required.
 243
 244 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 245
 246     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 247
 248 -   `:Toch`: Same as `:Toc` but in an horizontal window.
 249
 250 -   `:Toct`: Same as `:Toc` but in a new tab.
 251
 252 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 253
 254 ## Credits
 255
 256 The main contributors of vim-markdown are:
 257
 258 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 259
 260 If you feel that your name should be on this list, please make a pull request listing your contributions.
 261
 262 ## License
 263
 264 The MIT License (MIT)
 265
 266 Copyright (c) 2012 Benjamin D. Williams
 267
 268 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:
 269
 270 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 271
 272 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.