X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/6541268076c6e7d59737e48558e76dd2b4d9aa12..04d0260f8e5e59ecce970692488a38e30c01526d:/README.md diff --git a/README.md b/README.md index 9583a43..84ca1fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Markdown Vim Mode +# Vim Markdown [![Build Status](https://travis-ci.org/plasticboy/vim-markdown.svg)](https://travis-ci.org/plasticboy/vim-markdown) @@ -8,32 +8,42 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt 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 @@ -51,14 +61,6 @@ This option only controls vim_markdown's folding configuration. To enable/disabl 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. - -```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 `` mappings.