From: Ciro Santilli Date: Thu, 6 Feb 2014 09:16:06 +0000 (+0100) Subject: Merge pull request #62 from cirosantilli/readme-add-credits-section X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/e7f9c8699d72f22cb873c3666c8ef84e9462c787?hp=-c Merge pull request #62 from cirosantilli/readme-add-credits-section Created credits section, remove link to the outdated homepage. --- e7f9c8699d72f22cb873c3666c8ef84e9462c787 diff --combined README.md index 41f606f,95db711..0be1957 --- a/README.md +++ b/README.md @@@ -1,30 -1,19 +1,28 @@@ # 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 -If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this: +If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`: + + Bundle 'plasticboy/vim-markdown' + +And then run inside Vim: + + :so ~/.vimrc + :BundleInstall + +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, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: +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,7 -26,9 +35,7 @@@ let g:vim_markdown_folding_disabled= **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 @@@ -54,6 -45,14 +52,14 @@@ The following work on normal and visua - `]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)