X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/5da9db319c1c4382c8f9f55b3bf12917f001fbd7..a9f56e2ce0a97c79ed61cb536e141453c2f92975:/README.md diff --git a/README.md b/README.md index 18044db..93b0d98 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,49 @@ # Markdown Vim Mode +[![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown) + Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions. ## Installation 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 @@ -59,6 +71,15 @@ Add the following line to your `.vimrc` to disable default key mappings. You can let g:vim_markdown_no_default_key_mappings=1 ``` +**Syntax extensions** + +The following options control which syntax extensions will be turned on. + +LaTeX math: `$ $`, `$$ $$`, escapable as `\$ \$` and `\$\$ \$\$`: + +```vim +let g:vim_markdown_math=1 +``` ## Mappings The following work on normal and visual modes: