Fix YAML frontmatter recognised as level-2 heading

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 6fd8a383f1b2832d4d822fbca06e3e07e20481cd..60203812abf04678aa82d06e704bf169f9a0d99b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.


@@ -76,7 +76,7 @@ To fold in a style like [python-mode](https://github.com/klen/python-mode), add
 the following to your `.vimrc`:
 
 ```vim
 the following to your `.vimrc`:
 
 ```vim

-let g:vim_markdown_folding_style_pythonic=1
+let g:vim_markdown_folding_style_pythonic = 1

 ```
 
 ### Set header folding level
 ```
 
 ### Set header folding level


@@ -99,11 +99,20 @@ Tip: it can be changed on the fly with:
 Add the following line to your `.vimrc` to disable default key mappings:
 
 ```vim
 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.


@@ -113,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


@@ -121,7 +130,7 @@ 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

 ```
 
 
 ```
 
 


@@ -167,6 +176,8 @@ To disable a map use:
 
 ## Commands
 
 
 ## 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.