X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e7f9c8699d72f22cb873c3666c8ef84e9462c787..32343f0a2b4b30921002f271712619b6d79afea0:/README.md diff --git a/README.md b/README.md index 0be1957..843405f 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,13 @@ 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 @@ -52,11 +59,23 @@ 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. **platicboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/). +- **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.