-# Markdown Vim Mode
+# Vim Markdown
+
+[](https://travis-ci.org/plasticboy/vim-markdown)
Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
+1. [Installation](#installation)
+1. [Options](#options)
+1. [Mappings](#mappings)
+1. [Commands](#commands)
+1. [Credits](#credits)
+1. [License](#license)
+
## Installation
If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
- Bundle 'plasticboy/vim-markdown'
+```vim
+Plugin 'godlygeek/tabular'
+Plugin 'plasticboy/vim-markdown'
+```
-And then run inside Vim:
+The `tabular` plugin must come *before* `vim-markdown`.
- :so ~/.vimrc
- :BundleInstall
+Then run inside Vim:
+
+```vim
+:so ~/.vimrc
+:PluginInstall
+```
If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
- $ cd ~/.vim/bundle
- $ git clone https://github.com/plasticboy/vim-markdown.git
+```sh
+cd ~/.vim/bundle
+git clone https://github.com/plasticboy/vim-markdown.git
+```
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
+```sh
+git clone https://github.com/plasticboy/vim-markdown.git
+cd vim-markdown
+sudo make install
+vim-addon-manager install markdown
+```
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
+```sh
+cd ~/.vim
+tar --strip=1 -zxf vim-markdown-master.tar.gz
+```
## Options
-**Disable Folding**
+### Disable Folding
-Add the following line to your `.vimrc` to disable folding.
+Add the following line to your `.vimrc` to disable the folding configuration:
```vim
-let g:vim_markdown_folding_disabled=1
+let g:vim_markdown_folding_disabled = 1
```
-**Set Initial Foldlevel**
+This option only controls Vim Markdown specific folding configuration.
-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.
+To enable/disable folding use Vim's standard folding configuration.
```vim
-let g:vim_markdown_initial_foldlevel=1
+set [no]foldenable
```
+### Change fold style
+
+To fold in a style like [python-mode](https://github.com/klen/python-mode), add
+the following to your `.vimrc`:
+
+```vim
+let g:vim_markdown_folding_style_pythonic = 1
+```
+
+### Set header folding level
+
+Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
+
+```vim
+let g:vim_markdown_folding_level = 6
+```
+
+Tip: it can be changed on the fly with:
+
+```vim
+:let g:vim_markdown_folding_level = 1
+:edit
+```
+
+### Disable Default Key Mappings
+
+Add the following line to your `.vimrc` to disable default key mappings:
+
+```vim
+let g:vim_markdown_no_default_key_mappings = 1
+```
+
+You can also map them by yourself with `<Plug>` mappings.
+
+### Enable TOC window auto-fit
+
+Allow for the TOC window to auto-fit when it's possible for it to shrink.
+It never increases its default size (half screen), it only shrinks.
+
+```vim
+let g:vim_markdown_toc_autofit = 1
+```
+
+### Syntax extensions
+
+The following options control which syntax extensions will be turned on. They are off by default.
+
+#### LaTeX math
+
+Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
+
+```vim
+let g:vim_markdown_math = 1
+```
+
+#### YAML frontmatter
+
+Highlight YAML frontmatter as used by Jekyll:
+
+```vim
+let g:vim_markdown_frontmatter = 1
+```
+
+
## Mappings
The following work on normal and visual modes:
-- `]]`: go to next header.
-- `[[`: go to previous header. Contrast with `]c`.
-- `][`: 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).
+- `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
+
+ The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
+
+ For example, all the following cursor positions will work:
+
+ [Example](http://example.com)
+ ^ ^ ^^ ^ ^
+ 1 2 34 5 6
+
+ <http://example.com>
+ ^ ^ ^
+ 1 2 3
+
+ Known limitation: does not work for links that span multiple lines.
+
+- `]]`: 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`
+
+This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
+
+ map asdf <Plug>Markdown_MoveToParentHeader
+
+To disable a map use:
+
+ map <Plug> <Plug>Markdown_MoveToParentHeader
+
+## Commands
+
+- `: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.
+
+- `: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.
+
+- `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
+
+ Requires [Tabular](https://github.com/godlygeek/tabular).
+
+ The input table *must* already have a separator line as the second line of the table.
+ That line only needs to contain the correct pipes `|`, nothing else is required.
+
+- `: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`.
## Credits
The main contributors of vim-markdown are:
-- **Ben Williams** (A.K.A. **platicboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
+- **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
If you feel that your name should be on this list, please make a pull request listing your contributions.
projects / etc / vim.git / blobdiff