Merge pull request #52 from cirosantilli/mappings

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 2aa9dcab2f16a9485909d61347de5f36aa2e3573..d95bc2c389f4bf21949c1da4a90153b61bd29d2f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # 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 [Markdown](http://daringfireball.net/projects/markdown/).

 
 ## Installation
 
 
 ## Installation
 


@@ -12,10 +12,41 @@ If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and
 To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 
     $ cd ~/.vim
 To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 
     $ cd ~/.vim

-    $ tar -zxf vim-markdown-master.tgz
+    $ tar --strip=1 -zxf vim-markdown-master.tar.gz

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

+## Options
+
+**Disable Folding**
+
+Add the following line to your `.vimrc` to disable folding.
+
+```vim
+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.
+
+```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).
+

 ## License
 
 The MIT License (MIT)
 ## License
 
 The MIT License (MIT)