Fix folding with code block and level setting

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 8389667052bbc3c604c974e9eeaa556e450de843..1a6fd1d6ba4c6719465e22168db520084986a181 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`:
@@ -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:
@@ -52,7 +59,7 @@ tar --strip=1 -zxf vim-markdown-master.tar.gz
 Add the following line to your `.vimrc` to disable the folding configuration:
 
 ```vim
-let g:vim_markdown_folding_disabled=1
+let g:vim_markdown_folding_disabled = 1
 ```
 
 This option only controls Vim Markdown specific folding configuration.
@@ -63,12 +70,36 @@ 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
+```
+
+### Set header folding level
+
+Folding level is a number between 1 and 6. By default, if not specified, it is set to 1.
+
+```vim
+let g:vim_markdown_folding_level = 6
+```
+
+Tip: it can be changed on the fly with:
+
+```vim
+:let g:vim_markdown_folding_level = 1
+:edit
+```
+
 ### Disable Default Key Mappings
 
 Add the following line to your `.vimrc` to disable default key mappings:
 
 ```vim
-let g:vim_markdown_no_default_key_mappings=1
+let g:vim_markdown_no_default_key_mappings = 1
 ```
 
 You can also map them by yourself with `<Plug>` mappings.
@@ -82,7 +113,7 @@ The following options control which syntax extensions will be turned on. They ar
 Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 
 ```vim
-let g:vim_markdown_math=1
+let g:vim_markdown_math = 1
 ```
 
 #### YAML frontmatter
@@ -90,14 +121,15 @@ let g:vim_markdown_math=1
 Highlight YAML frontmatter as used by Jekyll:
 
 ```vim
-let g:vim_markdown_frontmatter=1
+let g:vim_markdown_frontmatter = 1
 ```
 
+
 ## Mappings
 
 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 +145,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
 
@@ -145,7 +185,7 @@ The following work on normal and visual modes:
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 
--   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-styleguide/#tables).
+-   `:TableFormat`: Format the table under the cursor [like this](http://www.cirosantilli.com/markdown-style-guide/#tables).
 
     Requires [Tabular](https://github.com/godlygeek/tabular).