# Markdown Vim Mode
-Syntax highlighting, matching rules and mappings for [Markdown](http://daringfireball.net/projects/markdown/).
+Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
## Installation
-If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this:
+If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
+
+ Bundle 'plasticboy/vim-markdown'
+
+And then run inside Vim:
+
+ :so ~/.vimrc
+ :BundleInstall
+
+If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
$ cd ~/.vim/bundle
$ git clone https://github.com/plasticboy/vim-markdown.git
-To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
+To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), 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](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
$ cd ~/.vim
$ tar --strip=1 -zxf vim-markdown-master.tar.gz
-[Homepage](http://plasticboy.com/markdown-vim-mode/)
-
## Options
**Disable Folding**
**Set Initial Foldlevel**
-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.
+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.
```vim
let g:vim_markdown_initial_foldlevel=1
```
+**Disable Default Key Mappings**
+
+Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
+
+```vim
+let g:vim_markdown_no_default_key_mappings=1
+```
+
## Mappings
-the following work on normal and visual modes:
+The following work on normal and visual modes:
+
+- `]]`: 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)`
+
+## Commands
+
+- `: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`.
+
+- `: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.
+
+- `: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.
+
+## Credits
+
+The main contributors of vim-markdown are:
+
+- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
-- `]]`: go to next header
-- `[[`: go to previous header
-- `][`: go to next sibling header if any
-- `[]`: go to previous sibling header if any
-- `]c`: go to Current header
-- `]u`: go to parent header (Up)
+If you feel that your name should be on this list, please make a pull request listing your contributions.
## License
projects / etc / vim.git / blobdiff