Fix YAML frontmatter recognised as level-2 heading

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 770c625c3d8d59889d4f667869b2e687624d0817..60203812abf04678aa82d06e704bf169f9a0d99b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,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
 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:
 ```
 
 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:


@@ -59,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
 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.
 ```
 
 This option only controls Vim Markdown specific folding configuration.


@@ -70,16 +70,49 @@ To enable/disable folding use Vim's standard folding configuration.
 set [no]foldenable
 ```
 
 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
 ### 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.
 
 ```
 
 You can also map them by yourself with `<Plug>` mappings.
 

+### Enable TOC window auto-fit
+
+Allow for the TOC window to auto-fit when it's possible for it to shrink.
+It never increases its default size (half screen), it only shrinks.
+
+```vim
+let g:vim_markdown_toc_autofit = 1
+```
+

 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.
 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.


@@ -89,7 +122,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
 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
 ```
 
 #### YAML frontmatter


@@ -97,9 +130,10 @@ let g:vim_markdown_math=1
 Highlight YAML frontmatter as used by Jekyll:
 
 ```vim
 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:
 ## Mappings
 
 The following work on normal and visual modes:


@@ -132,16 +166,18 @@ The following work on normal and visual modes:
 
 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 
 
 -   `]u`: go to parent header (Up). `<Plug>Markdown_MoveToParentHeader`
 

-This plugging follows the recommended Vim plugin mapping interface, so if you want to change the map `]u` to `asdf`, add to your `.vimrc`:
+This plugin follows the recommended Vim plugin mapping interface, so to change the map `]u` to `asdf`, add to your `.vimrc`:

 
     map asdf <Plug>Markdown_MoveToParentHeader
 
 
     map asdf <Plug>Markdown_MoveToParentHeader
 

-To disable a map, use:
+To disable a map use:

 
     map <Plug> <Plug>Markdown_MoveToParentHeader
 
 ## Commands
 
 
     map <Plug> <Plug>Markdown_MoveToParentHeader
 
 ## Commands
 

+The following requires `:filetype plugin on`.
+

 -   `:HeaderDecrease`:
 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.
 -   `:HeaderDecrease`:
 
     Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.


@@ -160,7 +196,7 @@ To disable a map, use:
 
     If a range is given, e.g. hit `:` from visual mode, only operate on the range.
 
 
     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).
 
 
     Requires [Tabular](https://github.com/godlygeek/tabular).