README.md

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