X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/63aabf4b47fc944afc210b974574d158eb7a08d0..2e524e474d37fe4da0960043d0a46192b297837c:/README.md diff --git a/README.md b/README.md index 1a6fd1d..6780572 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,27 @@ let g:vim_markdown_no_default_key_mappings = 1 You can also map them by yourself with `` 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. @@ -116,14 +137,33 @@ Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. 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 ``` +#### 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 @@ -167,6 +207,8 @@ To disable a map use: ## Commands +The following requires `:filetype plugin on`. + - `:HeaderDecrease`: Decrease level of all headers in buffer: `h2` to `h1`, `h3` to `h2`, etc.