Merge pull request #88 from cirosantilli/change-header-level

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b004bbc539744d9efb0f3ecb514fbed6666d1dac..7d75420f30e4edcda9df0cedb2b782d7e3f7757b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,10 +50,10 @@ let g:vim_markdown_initial_foldlevel=1
 
 **Disable Default Key Mappings**
 
-Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings
+Add the following line to your `.vimrc` to disable default key mappings. You can map them by yourself with `<Plug>` mappings.
 
 ```vim
-let g:markdown_no_default_key_mappings=1
+let g:vim_markdown_no_default_key_mappings=1
 ```
 
 ## Mappings
@@ -69,8 +69,6 @@ The following work on normal and visual modes:
 
 ## Commands
 
-The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`).
-
 - `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
 
     Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
@@ -79,6 +77,24 @@ The following commands currently only work for atx style headers (`#`). Pull req
 - `:Toct`: Same as `:Toc` but in a new tab.
 - `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
 
+- `:SetexToAtx`:
+
+    Convert all Setex style headers in buffer to Atx.
+
+    If a range is given, e.g. hit `:` from visual mode, only operate on the range.
+
+- `:HeaderDecrease`:
+
+    Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
+
+    If range is given, only operate in the range.
+
+    If an `h1` would be decreased, abort.
+
+    For simplicity of implementation, Setex headers are converted to Atx.
+
+- `:HeaderIncrease`: Analogous to `:HeaderDecrease`, but increase levels instead.
+
 ## Credits
 
 The main contributors of vim-markdown are: