README.md

   1 # Markdown Vim Mode
   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 ## Installation
   8
   9 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
  10
  11     Plugin 'godlygeek/tabular'
  12     Plugin 'plasticboy/vim-markdown'
  13
  14 The `tabular` plugin come *before* `vim-markdown`.
  15
  16 Then run inside Vim:
  17
  18     :so ~/.vimrc
  19     :PluginInstall
  20
  21 If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
  22
  23     $ cd ~/.vim/bundle
  24     $ git clone https://github.com/plasticboy/vim-markdown.git
  25
  26 To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
  27
  28     $ git clone https://github.com/plasticboy/vim-markdown.git
  29     $ cd vim-markdown
  30     $ sudo make install
  31     $ vim-addon-manager install mkd
  32
  33 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
  34
  35     $ cd ~/.vim
  36     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
  37
  38 ## Options
  39
  40 ### Disable Folding
  41
  42 Add the following line to your `.vimrc` to disable folding configuration.
  43
  44 ```vim
  45 let g:vim_markdown_folding_disabled=1
  46 ```
  47
  48 This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
  49
  50 ```vim
  51 set [no]foldenable
  52 ```
  53
  54 ### Set Initial Foldlevel
  55
  56 Add the following line to your `.vimrc` to set the initial foldlevel. This option defaults to 0 (i.e. all folds are closed) and is ignored if folding is disabled.
  57
  58 ```vim
  59 let g:vim_markdown_initial_foldlevel=1
  60 ```
  61
  62 ### Disable Default Key Mappings
  63
  64 Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
  65
  66 ```vim
  67 let g:vim_markdown_no_default_key_mappings=1
  68 ```
  69
  70 ### Syntax extensions
  71
  72 The following options control which syntax extensions will be turned on. They are off by default.
  73
  74 #### LaTeX math
  75
  76 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
  77
  78 ```vim
  79 let g:vim_markdown_math=1
  80 ```
  81
  82 #### YAML frontmatter
  83
  84 Highlight YAML frontmatter as used by Jekyll:
  85
  86 ```vim
  87 let g:vim_markdown_frontmatter=1
  88 ```
  89
  90 ## Mappings
  91
  92 The following work on normal and visual modes:
  93
  94 - `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
  95 - `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
  96 - `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
  97 - `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
  98 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
  99 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
 100
 101 ## Commands
 102
 103 - `:HeaderDecrease`:
 104
 105     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 106
 107     If range is given, only operate in the range.
 108
 109     If an `h1` would be decreased, abort.
 110
 111     For simplicity of implementation, Setex headers are converted to Atx.
 112
 113 - `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 114
 115 - `:SetexToAtx`:
 116
 117     Convert all Setex style headers in buffer to Atx.
 118
 119     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 120
 121 - `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
 122
 123     Requires [Tabular](https://github.com/godlygeek/tabular).
 124
 125     The input table *must* already have a separator line as the second line of the table.
 126     That line only needs to contain the correct pipes `|`, nothing else is required.
 127
 128 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 129
 130     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 131
 132 - `:Toch`: Same as `:Toc` but in an horizontal window.
 133
 134 - `:Toct`: Same as `:Toc` but in a new tab.
 135
 136 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 137
 138 ## Credits
 139
 140 The main contributors of vim-markdown are:
 141
 142 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 143
 144 If you feel that your name should be on this list, please make a pull request listing your contributions.
 145
 146 ## License
 147
 148 The MIT License (MIT)
 149
 150 Copyright (c) 2012 Benjamin D. Williams
 151
 152 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:
 153
 154 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 155
 156 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.