X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/46c859c8a10b9f420cc73087182f0c9a6b272f71..3eb82a968fa932ab85d84544e958ecee22640468:/README.md diff --git a/README.md b/README.md index 8389667..925fd67 100644 --- 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`: @@ -35,7 +42,7 @@ To install without Pathogen using the Debian [vim-addon-manager](http://packages git clone https://github.com/plasticboy/vim-markdown.git cd vim-markdown sudo make install -vim-addon-manager install mkd +vim-addon-manager install markdown ``` If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this: @@ -63,6 +70,15 @@ To enable/disable folding use Vim's standard folding configuration. set [no]foldenable ``` +### Change fold style + +To fold in a style like [python-mode](https://github.com/klen/python-mode), add +the following to your `.vimrc`: + +```vim +let g:vim_markdown_folding_style_pythonic = 1 +``` + ### Disable Default Key Mappings Add the following line to your `.vimrc` to disable default key mappings: @@ -97,7 +113,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. `Markdown_OpenUrlUnderCursor` The standard `gx` is extended by allowing you to put your cursor anywhere inside a link. @@ -113,17 +129,25 @@ The following work on normal and visual modes: Known limitation: does not work for links that span multiple lines. -- `]]`: go to next header. `(Markdown_MoveToNextHeader)` +- `]]`: go to next header. `Markdown_MoveToNextHeader` + +- `[[`: go to previous header. Contrast with `]c`. `Markdown_MoveToPreviousHeader` + +- `][`: go to next sibling header if any. `Markdown_MoveToNextSiblingHeader` + +- `[]`: go to previous sibling header if any. `Markdown_MoveToPreviousSiblingHeader` + +- `]c`: go to Current header. `Markdown_MoveToCurHeader` -- `[[`: go to previous header. Contrast with `]c`. `(Markdown_MoveToPreviousHeader)` +- `]u`: go to parent header (Up). `Markdown_MoveToParentHeader` -- `][`: go to next sibling header if any. `(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. `(Markdown_MoveToPreviousSiblingHeader)` + map asdf Markdown_MoveToParentHeader -- `]c`: go to Current header. `(Markdown_MoveToCurHeader)` +To disable a map use: -- `]u`: go to parent header (Up). `(Markdown_MoveToParentHeader)` + map Markdown_MoveToParentHeader ## Commands