]> 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:

adding VersionAwareNetrwBrowseX() function for doing right call to netrw browsex
[etc/vim.git] / README.md
index 8389667052bbc3c604c974e9eeaa556e450de843..a5bdbbec4e362148926e26b9348770635556b82f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,6 +4,13 @@
 
 Syntax highlighting, matching rules and mappings for [the original Markdown](http://daringfireball.net/projects/markdown/) and extensions.
 
+1. [Installation](#installation)
+1. [Options](#options)
+1. [Mappings](#mappings)
+1. [Commands](#commands)
+1. [Credits](#credits)
+1. [License](#license)
+
 ## Installation
 
 If you use [Vundle](https://github.com/gmarik/vundle), add the following line to your `~/.vimrc`:
@@ -97,7 +104,7 @@ let g:vim_markdown_frontmatter=1
 
 The following work on normal and visual modes:
 
--   `gx`: open the link under the cursor in the same browser as the standard `gx` command.
+-   `gx`: open the link under the cursor in the same browser as the standard `gx` command. `<Plug>Markdown_OpenUrlUnderCursor`
 
     The standard `gx` is extended by allowing you to put your cursor anywhere inside a link.
 
@@ -113,17 +120,25 @@ The following work on normal and visual modes:
 
     Known limitation: does not work for links that span multiple lines.
 
--   `]]`: go to next header. `<Plug>(Markdown_MoveToNextHeader)`
+-   `]]`: go to next header. `<Plug>Markdown_MoveToNextHeader`
+
+-   `[[`: go to previous header. Contrast with `]c`. `<Plug>Markdown_MoveToPreviousHeader`
+
+-   `][`: go to next sibling header if any. `<Plug>Markdown_MoveToNextSiblingHeader`
+
+-   `[]`: go to previous sibling header if any. `<Plug>Markdown_MoveToPreviousSiblingHeader`
+
+-   `]c`: go to Current header. `<Plug>Markdown_MoveToCurHeader`
 
--   `[[`: go to previous header. Contrast with `]c`. `<Plug>(Markdown_MoveToPreviousHeader)`
+-   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 
--   `][`: go to next sibling header if any. `<Plug>(Markdown_MoveToNextSiblingHeader)`
+This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:
 
--   `[]`: go to previous sibling header if any. `<Plug>(Markdown_MoveToPreviousSiblingHeader)`
+    map asdf <Plug>Markdown_MoveToParentHeader
 
--   `]c`: go to Current header. `<Plug>(Markdown_MoveToCurHeader)`
+To disable a map use:
 
--   `]u`: go to parent header (Up). `<Plug>(Markdown_MoveToParentHeader)`
+    map <Plug> <Plug>Markdown_MoveToParentHeader
 
 ## Commands