All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
3 [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown)
5 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
7 1. [Installation](#installation)
8 1. [Basic usage](#basic-usage)
10 1. [Mappings](#mappings)
11 1. [Commands](#commands)
12 1. [Credits](#credits)
13 1. [License](#license)
17 If you use [Vundle](https://github.com/gmarik/vundle), add the following lines to your `~/.vimrc`:
20 Plugin 'godlygeek/tabular'
21 Plugin 'plasticboy/vim-markdown'
24 The `tabular` plugin must come *before* `vim-markdown`.
33 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
37 git clone https://github.com/plasticboy/vim-markdown.git
40 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
43 git clone https://github.com/plasticboy/vim-markdown.git
46 vim-addon-manager install markdown
49 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
53 tar --strip=1 -zxf vim-markdown-master.tar.gz
60 Folding is enabled for headers by default.
62 The following commands are useful to open and close folds:
64 - `zr`: reduces fold level throughout the buffer
65 - `zR`: opens all folds
66 - `zm`: increases fold level throughout the buffer
67 - `zM`: folds everything all the way
68 - `za`: open a fold your cursor is on
69 - `zA`: open a fold your cursor is on recursively
70 - `zc`: close a fold your cursor is on
71 - `zC`: close a fold your cursor is on recursively
73 [Options](#options) are available to disable folding or change folding style.
75 Try `:help fold-expr` and `:help fold-commands` for details.
79 Concealing is set for some syntax such as bold, italic, code block and link.
81 Concealing lets you conceal text with other text. The actual source text is not modified. If you put your cursor on the concealed line, the conceal goes away.
83 [Options](#options) are available to disable or change concealing.
85 Try `:help concealcursor` and `:help conceallevel` for details.
91 - `g:vim_markdown_folding_disabled`
93 Add the following line to your `.vimrc` to disable the folding configuration:
95 let g:vim_markdown_folding_disabled = 1
97 This option only controls Vim Markdown specific folding configuration.
99 To enable/disable folding use Vim's standard folding configuration.
103 ### Change fold style
105 - `g:vim_markdown_folding_style_pythonic`
107 To fold in a style like [python-mode](https://github.com/klen/python-mode), add the following to your `.vimrc`:
109 let g:vim_markdown_folding_style_pythonic = 1
111 `g:vim_markdown_folding_level` setting (default 1) is set to `foldlevel`.
112 Thus level 1 heading which is served as a document title is expanded by default.
114 - `g:vim_markdown_override_foldtext`
116 To prevent foldtext from being set add the following to your `.vimrc`:
118 let g:vim_markdown_override_foldtext = 0
120 ### Set header folding level
122 - `g:vim_markdown_folding_level`
124 Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
126 let g:vim_markdown_folding_level = 6
128 Tip: it can be changed on the fly with:
130 :let g:vim_markdown_folding_level = 1
133 ### Disable Default Key Mappings
135 - `g:vim_markdown_no_default_key_mappings`
137 Add the following line to your `.vimrc` to disable default key mappings:
139 let g:vim_markdown_no_default_key_mappings = 1
141 You can also map them by yourself with `<Plug>` mappings.
143 ### Enable TOC window auto-fit
145 - `g:vim_markdown_toc_autofit`
147 Allow for the TOC window to auto-fit when it's possible for it to shrink.
148 It never increases its default size (half screen), it only shrinks.
150 let g:vim_markdown_toc_autofit = 1
152 ### Text emphasis restriction to single-lines
154 - `g:vim_markdown_emphasis_multiline`
156 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 (i.e., for it to be applied a closing token must be found on the same line). To do so:
158 let g:vim_markdown_emphasis_multiline = 0
160 ### Syntax Concealing
162 - `g:vim_markdown_conceal`
164 Concealing is set for some syntax.
166 For example, conceal `[link text](link url)` as just `link text`.
167 Also, `_italic_` and `*italic*` will conceal to just _italic_.
168 Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***`
169 will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively.
171 To enable conceal use Vim's standard conceal configuration.
175 To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`:
177 let g:vim_markdown_conceal = 0
179 To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`:
181 let g:tex_conceal = ""
182 let g:vim_markdown_math = 1
184 - `g:vim_markdown_conceal_code_blocks`
186 Disabling conceal for code fences requires an additional setting:
188 let g:vim_markdown_conceal_code_blocks = 0
190 ### Fenced code block languages
192 - `g:vim_markdown_fenced_languages`
194 You can use filetype name as fenced code block languages for syntax highlighting.
195 If you want to use different name from filetype, you can add it in your `.vimrc` like so:
197 let g:vim_markdown_fenced_languages = ['csharp=cs']
199 This will cause the following to be highlighted using the `cs` filetype syntax.
205 Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`.
207 ### Follow named anchors
209 - `g:vim_markdown_follow_anchor`
211 This feature allows the `ge` command to follow named anchors in links of the form
212 `file#anchor` or just `#anchor`, where file may omit the `.md` extension as
213 usual. Two variables control its operation:
215 let g:vim_markdown_follow_anchor = 1
217 This tells vim-markdown whether to attempt to follow a named anchor in a link or
218 not. When it is 1, and only if a link can be split in two parts by the pattern
219 '#', then the first part is interpreted as the file and the second one as the
220 named anchor. This also includes urls of the form `#anchor`, for which the first
221 part is considered empty, meaning that the target file is the current one. After
222 the file is opened, the anchor will be searched.
226 - `g:vim_markdown_anchorexpr`
228 let g:vim_markdown_anchorexpr = "'<<'.v:anchor.'>>'"
230 This expression will be evaluated substituting `v:anchor` with a quoted string
231 that contains the anchor to visit. The result of the evaluation will become the
232 real anchor to search in the target file. This is useful in order to convert
233 anchors of the form, say, `my-section-title` to searches of the form `My Section
234 Title` or `<<my-section-title>>`.
238 ### Syntax extensions
240 The following options control which syntax extensions will be turned on. They are off by default.
244 - `g:vim_markdown_math`
246 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
248 let g:vim_markdown_math = 1
250 #### YAML Front Matter
252 - `g:vim_markdown_frontmatter`
254 Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).
256 let g:vim_markdown_frontmatter = 1
258 #### TOML Front Matter
260 - `g:vim_markdown_toml_frontmatter`
262 Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
264 TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
266 let g:vim_markdown_toml_frontmatter = 1
268 #### JSON Front Matter
270 - `g:vim_markdown_json_frontmatter`
272 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
274 JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
276 let g:vim_markdown_json_frontmatter = 1
280 - `g:vim_markdown_strikethrough`
282 Strikethrough uses two tildes. `~~Scratch this.~~`
284 let g:vim_markdown_strikethrough = 1
286 ### Adjust new list item indent
288 - `g:vim_markdown_new_list_item_indent`
290 You can adjust a new list indent. For example, you insert a single line like below:
294 Then if you type `o` to insert new line in vim and type `* item2`, the result will be:
299 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:
301 let g:vim_markdown_new_list_item_indent = 2
303 ### Do not require .md extensions for Markdown links
305 - `g:vim_markdown_no_extensions_in_markdown`
307 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:
309 let g:vim_markdown_no_extensions_in_markdown = 1
311 This is super useful for GitLab and GitHub wiki repositories.
313 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.
315 ### Auto-write when following link
317 - `g:vim_markdown_autowrite`
319 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:
321 let g:vim_markdown_autowrite = 1
323 ### Change default file extension
325 - `g:vim_markdown_auto_extension_ext`
327 If you would like to use a file extension other than `.md` you may do so using the `vim_markdown_auto_extension_ext` variable:
329 let g:vim_markdown_auto_extension_ext = 'txt'
331 ### Do not automatically insert bulletpoints
333 - `g:vim_markdown_auto_insert_bullets`
335 Automatically inserting bulletpoints can lead to problems when wrapping text
336 (see issue #232 for details), so it can be disabled:
338 let g:vim_markdown_auto_insert_bullets = 0
340 In that case, you probably also want to set the new list item indent to 0 as
341 well, or you will have to remove an indent each time you add a new list item:
343 let g:vim_markdown_new_list_item_indent = 0
345 ### Change how to open new files
347 - `g:vim_markdown_edit_url_in`
349 By default when following a link the target file will be opened in your current buffer. This behavior can change if you prefer using splits or tabs by using the `vim_markdown_edit_url_in` variable. Possible values are `tab`, `vsplit`, `hsplit`, `current` opening in a new tab, vertical split, horizontal split, and current buffer respectively. Defaults to current buffer if not set:
351 let g:vim_markdown_edit_url_in = 'tab'
355 The following work on normal and visual modes:
357 - `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
359 The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
361 For example, all the following cursor positions will work:
363 [Example](http://example.com)
371 Known limitation: does not work for links that span multiple lines.
373 - `ge`: open the link under the cursor in Vim for editing. Useful for relative markdown links. `<Plug>Markdown_EditUrlUnderCursor`
375 The rules for the cursor position are the same as the `gx` command.
377 - `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
379 - `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
381 - `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
383 - `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
385 - `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
387 - `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
389 This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
391 map asdf <Plug>Markdown_MoveToParentHeader
393 To disable a map use:
395 map <Plug> <Plug>Markdown_MoveToParentHeader
399 The following requires `:filetype plugin on`.
403 Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
405 If range is given, only operate in the range.
407 If an `h1` would be decreased, abort.
409 For simplicity of implementation, Setex headers are converted to Atx.
411 - `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
415 Convert all Setex style headers in buffer to Atx.
417 If a range is given, e.g. hit `:` from visual mode, only operate on the range.
419 - `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
421 Requires [Tabular](https://github.com/godlygeek/tabular).
423 The input table *must* already have a separator line as the second line of the table.
424 That line only needs to contain the correct pipes `|`, nothing else is required.
426 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
428 Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
430 - `:Toch`: Same as `:Toc` but in an horizontal window.
432 - `:Toct`: Same as `:Toc` but in a new tab.
434 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.
438 The main contributors of vim-markdown are:
440 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
442 If you feel that your name should be on this list, please make a pull request listing your contributions.
446 The MIT License (MIT)
448 Copyright (c) 2012 Benjamin D. Williams
450 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:
452 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
454 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.