Merge pull request #257 from alexconst/fix/url_regex

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 60203812abf04678aa82d06e704bf169f9a0d99b..6c043db87a5f58b79ee3498991fd5abc4bd50678 100644 (file)
--- a/README.md
+++ b/README.md
@@ -113,6 +113,26 @@ It never increases its default size (half screen), it only shrinks.
 let g:vim_markdown_toc_autofit = 1
 ```
 
 let g:vim_markdown_toc_autofit = 1
 ```
 

+### Text emphasis restriction to single-lines
+
+By default text emphasis works across multiple lines until a closing token is found. However, it's possible to restrict text emphasis to a single line (ie, for it to be applied a closing token must be found on the same line). To do so:
+
+```vim
+let g:vim_markdown_emphasis_multiline = 0
+```
+
+### 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.


@@ -125,14 +145,33 @@ Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`.
 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
 let g:vim_markdown_frontmatter = 1
 ```
 
 
 ```vim
 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
 


@@ -211,7 +250,7 @@ The following requires `:filetype plugin on`.
 
 -   `:Toct`: Same as `:Toc` but in a new tab.
 
 
 -   `:Toct`: Same as `:Toc` but in a new tab.
 

--   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
+-   `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`.

 
 ## Credits
 
 
 ## Credits