Escaped pre and code should not be code block

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 925fd67a700d8acad6bf26a7646336a360abdd79..6780572aa11fd1b4d572fbdfb07c3d8752c1a010 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.


@@ -79,16 +79,52 @@ the following to your `.vimrc`:
 let g:vim_markdown_folding_style_pythonic = 1
 ```
 
 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 Concealing
+
+Concealing is set for some syntax.
+
+For example, conceal `[link text](link url)` as just `link text`.
+
+To enable/disable conceal use Vim's standard conceal configuration.
+
+```vim
+set conceallevel=2
+```
+

 ### 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.


@@ -98,15 +134,35 @@ 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 Front Matter

 
 

-Highlight YAML frontmatter as used by Jekyll:
+Highlight YAML front matter as used by Jekyll or [Hugo](https://gohugo.io/content/front-matter/).

 
 ```vim
 
 ```vim

-let g:vim_markdown_frontmatter=1
+let g:vim_markdown_frontmatter = 1
+```
+
+#### TOML Front Matter
+
+Highlight TOML front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
+
+TOML syntax highlight requires [vim-toml](https://github.com/cespare/vim-toml).
+
+```vim
+let g:vim_markdown_toml_frontmatter = 1
+```
+
+#### JSON Front Matter
+
+Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/).
+
+JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
+
+```vim
+let g:vim_markdown_json_frontmatter = 1

 ```
 
 ## Mappings
 ```
 
 ## Mappings


@@ -151,6 +207,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.


@@ -169,7 +227,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).