Add Toc commands.

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 4c9fcdfed01cf3fcb3f0432911cac4ea8daa868a..843405f0035e32819a0656151ae0746e58406191 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,21 +1,35 @@
 # Markdown Vim Mode
 
 # Markdown Vim Mode
 

-Syntax highlighting and matching rules 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
 
 
 ## 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
 
 
     $ 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
 
 
     $ cd ~/.vim
     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
 

-[Homepage](http://plasticboy.com/markdown-vim-mode/)
-

 ## Options
 
 **Disable Folding**
 ## Options
 
 **Disable Folding**


@@ -28,14 +42,43 @@ let g:vim_markdown_folding_disabled=1
 
 **Set Initial Foldlevel**
 
 
 **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
 ```
 
 
 ```vim
 let g:vim_markdown_initial_foldlevel=1
 ```
 

+## Mappings
+
+The following work on normal and visual modes:
+
+- `]]`: go to next header.
+- `[[`: go to previous header. Contrast with `]c`.
+- `][`: go to next sibling header if any.
+- `[]`: go to previous sibling header if any.
+- `]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 `<Enter>` 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)
 ## License
 
 The MIT License (MIT)