X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/886ba1b89a55ec6495f9a4c10206aa950e712211..32343f0a2b4b30921002f271712619b6d79afea0:/README.md diff --git a/README.md b/README.md index b72e6ae..843405f 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,32 @@ Syntax highlighting, matching rules and mappings for [the original Markdown](htt ## 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: +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** @@ -45,6 +59,26 @@ The following work on normal and visual modes: - `]c`: go to Current header. - `]u`: go to parent header (Up). +## Commands + +The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`). + +- `:Toc`: create a quickfix vertical window navigable table of contents with the headers. + + Hit `` on a line to jump to the corresponding line of the markdown file. + +- `:Toch`: Same as `:Toc` but in an horizontal window. +- `:Toct`: Same as `:Toc` but in a new tab. +- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`. + +## Credits + +The main contributors of vim-markdown are: + +- **Ben Williams** (A.K.A. **plasticboy**). 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)