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 mkd
  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 ### Disable Default Key Mappings
  74
  75 Add the following line to your `.vimrc` to disable default key mappings:
  76
  77 ```vim
  78 let g:vim_markdown_no_default_key_mappings=1
  79 ```
  80
  81 You can also map them by yourself with `<Plug>` mappings.
  82
  83 ### Syntax extensions
  84
  85 The following options control which syntax extensions will be turned on. They are off by default.
  86
  87 #### LaTeX math
  88
  89 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
  90
  91 ```vim
  92 let g:vim_markdown_math=1
  93 ```
  94
  95 #### YAML frontmatter
  96
  97 Highlight YAML frontmatter as used by Jekyll:
  98
  99 ```vim
 100 let g:vim_markdown_frontmatter=1
 101 ```
 102
 103 ## Mappings
 104
 105 The following work on normal and visual modes:
 106
 107 -   `gx`: open the link under the cursor in the same browser as the standard `gx` command.
 108
 109     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 110
 111     For example, all the following cursor positions will work:
 112
 113         [Example](http://example.com)
 114         ^  ^    ^^   ^       ^
 115         1  2    34   5       6
 116
 117         <http://example.com>
 118         ^  ^               ^
 119         1  2               3
 120
 121     Known limitation: does not work for links that span multiple lines.
 122
 123 -   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
 124
 125 -   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
 126
 127 -   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
 128
 129 -   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
 130
 131 -   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 132
 133 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 134
 135 This plugging follows the recommended Vim plugin mapping interface, so if you want to change the map `]u` to `asdf`, add to your `.vimrc`:
 136
 137     map asdf <Plug>Markdown_MoveToParentHeader
 138
 139 To disable a map, use:
 140
 141     map <Plug> <Plug>Markdown_MoveToParentHeader
 142
 143 ## Commands
 144
 145 -   `:HeaderDecrease`:
 146
 147     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 148
 149     If range is given, only operate in the range.
 150
 151     If an `h1` would be decreased, abort.
 152
 153     For simplicity of implementation, Setex headers are converted to Atx.
 154
 155 -   `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 156
 157 -   `:SetexToAtx`:
 158
 159     Convert all Setex style headers in buffer to Atx.
 160
 161     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 162
 163 -   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
 164
 165     Requires [Tabular](https://github.com/godlygeek/tabular).
 166
 167     The input table *must* already have a separator line as the second line of the table.
 168     That line only needs to contain the correct pipes `|`, nothing else is required.
 169
 170 -   `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 171
 172     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 173
 174 -   `:Toch`: Same as `:Toc` but in an horizontal window.
 175
 176 -   `:Toct`: Same as `:Toc` but in a new tab.
 177
 178 -   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 179
 180 ## Credits
 181
 182 The main contributors of vim-markdown are:
 183
 184 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 185
 186 If you feel that your name should be on this list, please make a pull request listing your contributions.
 187
 188 ## License
 189
 190 The MIT License (MIT)
 191
 192 Copyright (c) 2012 Benjamin D. Williams
 193
 194 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:
 195
 196 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 197
 198 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.