Merge pull request #60 from cirosantilli/contributing-guidelines

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index a11299bc9e8bb94b8d3ff5b7b1b0591bdad6b3f8..b72e6aeed11f877b717042ac5e39612185b84a52 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # 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
 
@@ -16,6 +16,35 @@ To install without Pathogen, download the [tarball](https://github.com/plasticbo
 
 [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)