jaredcrean / vim-markdown

Markdown Vim Mode

Vim Markdown

Syntax highlighting, matching rules and mappings for the original Markdown and extensions.

1. Installation
2. Options
3. Mappings
4. Commands
5. Credits
6. License

Installation

If you use Vundle, add the following line to your ~/.vimrc:

Plugin 'godlygeek/tabular'
Plugin 'plasticboy/vim-markdown'

The tabular plugin must come before vim-markdown.

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 mkd

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

Options

Disable Folding

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.

set [no]foldenable

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 <Plug> mappings.

Syntax extensions

The following options control which syntax extensions will be turned on. They are off by default.

LaTeX math

Used as $x^2$, $$x^2$$, escapable as \$x\$ and \$\$x\$\$.

let g:vim_markdown_math=1

YAML frontmatter

Highlight YAML frontmatter as used by Jekyll:

let g:vim_markdown_frontmatter=1

Mappings

The following work on normal and visual modes:

• gx: open the link under the cursor in the same browser as the standard gx command. <Plug>Markdown_OpenUrlUnderCursor

  The standard gx is 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. <Plug>Markdown_MoveToNextHeader

• [[: go to previous header. Contrast with ]c. <Plug>Markdown_MoveToPreviousHeader

• ][: go to next sibling header if any. <Plug>Markdown_MoveToNextSiblingHeader

• []: go to previous sibling header if any. <Plug>Markdown_MoveToPreviousSiblingHeader

• ]c: go to Current header. <Plug>Markdown_MoveToCurHeader

• ]u: go to parent header (Up). <Plug>Markdown_MoveToParentHeader

This plugin follows the recommended Vim plugin mapping interface, so to change the map ]u to asdf, add to your .vimrc:

map asdf <Plug>Markdown_MoveToParentHeader

To disable a map use:

map <Plug> <Plug>Markdown_MoveToParentHeader

Commands

• :HeaderDecrease:

  Decrease level of all headers in buffer: h2 to h1, h3 to h2, etc.

  If range is given, only operate in the range.

  If an h1 would be decreased, abort.

  For simplicity of implementation, Setex headers are converted to Atx.

• :HeaderIncrease: Analogous to :HeaderDecrease, but increase levels instead.

• :SetexToAtx:

  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.

  Requires Tabular.

  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.

  Hit <Enter> on a line to jump to the corresponding line of the markdown file.

• :Toch: Same as :Toc but in an horizontal window.

• :Toct: Same as :Toc but in a new tab.

• :Tocv: Same as :Toc for symmetry with :Toch and Tocv.

Credits

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.

License

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.