X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/ff4fc395a7787957f8b940f4fd7189d910d4169e..0f5326f868c9e7ec6f0207d072ba34986daf6cc0:/README.md?ds=sidebyside diff --git a/README.md b/README.md index e6f1824..9d66cb4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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 @@ -18,13 +18,18 @@ 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 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** @@ -37,9 +42,7 @@ let g:vim_markdown_folding_disabled=1 **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 @@ -56,6 +59,14 @@ The following work on normal and visual modes: - `]c`: go to Current header. - `]u`: go to parent header (Up). +## Credits + +The main contributors of vim-markdown are: + +- **Ben Williams** (A.K.A. **platicboy**). 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. + ## License The MIT License (MIT)