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.
  43
  44 ```vim
  45 let g:vim_markdown_folding_disabled=1
  46 ```
  47
  48 ### Set Initial Foldlevel
  49
  50 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.
  51
  52 ```vim
  53 let g:vim_markdown_initial_foldlevel=1
  54 ```
  55
  56 ### Disable Default Key Mappings
  57
  58 Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
  59
  60 ```vim
  61 let g:vim_markdown_no_default_key_mappings=1
  62 ```
  63
  64 ### Syntax extensions
  65
  66 The following options control which syntax extensions will be turned on. They are off by default.
  67
  68 #### LaTeX math
  69
  70 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
  71
  72 ```vim
  73 let g:vim_markdown_math=1
  74 ```
  75
  76 #### YAML frontmatter
  77
  78 Highlight YAML frontmatter as used by Jekyll:
  79
  80 ```vim
  81 let g:vim_markdown_frontmatter=1
  82 ```
  83
  84 ## Mappings
  85
  86 The following work on normal and visual modes:
  87
  88 - `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
  89 - `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
  90 - `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
  91 - `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
  92 - `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
  93 - `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
  94
  95 ## Commands
  96
  97 - `:HeaderDecrease`:
  98
  99     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 100
 101     If range is given, only operate in the range.
 102
 103     If an `h1` would be decreased, abort.
 104
 105     For simplicity of implementation, Setex headers are converted to Atx.
 106
 107 - `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
 108
 109 - `:SetexToAtx`:
 110
 111     Convert all Setex style headers in buffer to Atx.
 112
 113     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 114
 115 - `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
 116
 117     Requires [Tabular](https://github.com/godlygeek/tabular).
 118
 119     The input table *must* already have a separator line as the second line of the table.
 120     That line only needs to contain the correct pipes `|`, nothing else is required.
 121
 122 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 123
 124     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
 125
 126 - `:Toch`: Same as `:Toc` but in an horizontal window.
 127
 128 - `:Toct`: Same as `:Toc` but in a new tab.
 129
 130 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 131
 132 ## Credits
 133
 134 The main contributors of vim-markdown are:
 135
 136 - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
 137
 138 If you feel that your name should be on this list, please make a pull request listing your contributions.
 139
 140 ## License
 141
 142 The MIT License (MIT)
 143
 144 Copyright (c) 2012 Benjamin D. Williams
 145
 146 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:
 147
 148 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 149
 150 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.