]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

added mappings list to readme
[etc/vim.git] / README.md
index a11299bc9e8bb94b8d3ff5b7b1b0591bdad6b3f8..871ed6594766afd4cfe0508b417f907d82842693 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 [Markdown](http://daringfireball.net/projects/markdown/).
 
 ## Installation
 
@@ -16,6 +16,24 @@ 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
+```
+
+## Mappings
+
+- `nn ]]`: go to next header
+- `nn ][`: go to next sibling header if any
+- `nn ]u`: go to parent header (Up)
+- `nn [[`: go to previous header
+- `nn []`: go to previous sibling header if any
+
 ## License
 
 The MIT License (MIT)