Syntax highlighting, matching rules and mappings for the original Markdown and extensions.
If you use Vundle, add the following line to your
Plugin 'godlygeek/tabular' Plugin 'plasticboy/vim-markdown'
tabular plugin must come before
Then run inside Vim:
:so ~/.vimrc :PluginInstall
If you use Pathogen, do this:
cd ~/.vim/bundle git clone https://github.com/plasticboy/vim-markdown.git
To install without Pathogen using the Debian vim-addon-manager, do this:
git clone https://github.com/plasticboy/vim-markdown.git cd vim-markdown sudo make install vim-addon-manager install markdown
If you are not using any package manager, download the tarball and do this:
cd ~/.vim tar --strip=1 -zxf vim-markdown-master.tar.gz
Add the following line to your
.vimrc to disable the folding configuration:
let g:vim_markdown_folding_disabled = 1
This option only controls Vim Markdown specific folding configuration.
To enable/disable folding use Vim's standard folding configuration.
Change fold style
To fold in a style like python-mode, add
the following to your
let g:vim_markdown_folding_style_pythonic = 1
Set header folding level
Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
let g:vim_markdown_folding_level = 6
Tip: it can be changed on the fly with:
:let g:vim_markdown_folding_level = 1 :edit
Disable Default Key Mappings
Add the following line to your
.vimrc to disable default key mappings:
let g:vim_markdown_no_default_key_mappings = 1
You can also map them by yourself with
Enable TOC window auto-fit
Allow for the TOC window to auto-fit when it's possible for it to shrink. It never increases its default size (half screen), it only shrinks.
let g:vim_markdown_toc_autofit = 1
Text emphasis restriction to single-lines
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:
let g:vim_markdown_emphasis_multiline = 0
Concealing is set for some syntax.
For example, conceal
[link text](link url) as just
To enable/disable conceal use Vim's standard conceal configuration.
The following options control which syntax extensions will be turned on. They are off by default.
$$x^2$$, escapable as
let g:vim_markdown_math = 1
YAML Front Matter
Highlight YAML front matter as used by Jekyll or Hugo.
let g:vim_markdown_frontmatter = 1
TOML Front Matter
Highlight TOML front matter as used by Hugo.
TOML syntax highlight requires vim-toml.
let g:vim_markdown_toml_frontmatter = 1
JSON Front Matter
Highlight JSON front matter as used by Hugo.
JSON syntax highlight requires vim-json.
let g:vim_markdown_json_frontmatter = 1
The following work on normal and visual modes:
gx: open the link under the cursor in the same browser as the standard
gxis extended by allowing you to put your cursor anywhere inside a link.
For example, all the following cursor positions will work:
[Example](http://example.com) ^ ^ ^^ ^ ^ 1 2 34 5 6 <http://example.com> ^ ^ ^ 1 2 3
Known limitation: does not work for links that span multiple lines.
]]: go to next header.
[[: go to previous header. Contrast with
][: go to next sibling header if any.
: go to previous sibling header if any.
]c: go to Current header.
]u: go to parent header (Up).
This plugin follows the recommended Vim plugin mapping interface, so to change the map
asdf, add to your
map asdf <Plug>Markdown_MoveToParentHeader
To disable a map use:
map <Plug> <Plug>Markdown_MoveToParentHeader
The following requires
:filetype plugin on.
Decrease level of all headers in buffer:
If range is given, only operate in the range.
h1would be decreased, abort.
For simplicity of implementation, Setex headers are converted to Atx.
:HeaderIncrease: Analogous to
:HeaderDecrease, but increase levels instead.
Convert all Setex style headers in buffer to Atx.
If a range is given, e.g. hit
:from visual mode, only operate on the range.
:TableFormat: Format the table under the cursor like this.
The input table must already have a separator line as the second line of the table. That line only needs to contain the correct pipes
|, nothing else is required.
:Toc: create a quickfix vertical window navigable table of contents with the headers.
<Enter>on a line to jump to the corresponding line of the markdown file.
:Toch: Same as
:Tocbut in an horizontal window.
:Toct: Same as
:Tocbut in a new tab.
:Tocv: Same as
:Tocfor symmetry with
The main contributors of vim-markdown are:
- Ben Williams (A.K.A. plasticboy). The original developer of vim-markdown. Homepage.
If you feel that your name should be on this list, please make a pull request listing your contributions.
The MIT License (MIT)
Copyright (c) 2012 Benjamin D. Williams
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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
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.