If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
- Plugin 'godlygeek/tabular'
- Plugin 'plasticboy/vim-markdown'
+```vim
+Plugin 'godlygeek/tabular'
+Plugin 'plasticboy/vim-markdown'
+```
-The `tabular` plugin come *before* `vim-markdown`.
+The `tabular` plugin must come *before* `vim-markdown`.
Then run inside Vim:
- :so ~/.vimrc
- :PluginInstall
+```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 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
+```sh
+cd ~/.vim
+tar --strip=1 -zxf vim-markdown-master.tar.gz
+```
## Options
### Disable Folding
-Add the following line to your `.vimrc` to disable folding.
+Add the following line to your `.vimrc` to disable folding configuration.
```vim
let g:vim_markdown_folding_disabled=1
```
+This option only controls vim_markdown's folding configuration. To enable/disable folding use Vim's folding configuration.
+
+```vim
+set [no]foldenable
+```
+
### 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.
let g:vim_markdown_initial_foldlevel=0
endif
let &l:foldlevel=g:vim_markdown_initial_foldlevel
-
- "---------- everything after this is optional -----------------------
- " change the following fold options to your liking
- " see ':help fold-options' for more
- setlocal foldenable
- setlocal foldcolumn=0
- set foldmethod=expr
- set foldopen-=search
endif
" Language: Markdown
" Maintainer: Ben Williams <benw@plasticboy.com>
" URL: http://plasticboy.com/markdown-vim-mode/
-" Version: 9
-" Last Change: 2009 May 18
" Remark: Uses HTML syntax file
" TODO: Handle stuff contained within stuff (e.g. headings within blockquotes)
-Given mkd (bold);
-**bold** not bold
+Given mkd;
+a **b** c
-Execute (SyntaxOf(pattern)):
+Execute (bold):
+ AssertNotEqual SyntaxOf('a'), 'htmlBold'
AssertEqual SyntaxOf('b'), 'htmlBold'
+ AssertNotEqual SyntaxOf('c'), 'htmlBold'
-Given mkd (italic);
-*italic*
+Given mkd;
+a *b* c
-Execute (SyntaxOf(pattern)):
- AssertEqual SyntaxOf('i'), 'htmlItalic'
+Execute (italic):
+ AssertNotEqual SyntaxOf('a'), 'htmlItalic'
+ AssertEqual SyntaxOf('b'), 'htmlItalic'
+ AssertNotEqual SyntaxOf('c'), 'htmlItalic'
# Links