X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/ba1fa3ceb9d4a93ac3009b9d1d8d0fae28fdb3ea..46bfed06fd0e8a9bff1ff2b1f948428fc41275d3:/README.md?ds=sidebyside diff --git a/README.md b/README.md index e9fac38..6c043db 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,21 @@ the following to your `.vimrc`: 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: @@ -89,6 +104,35 @@ 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 +``` + +### 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. @@ -101,14 +145,34 @@ 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 The following work on normal and visual modes: @@ -151,6 +215,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. @@ -184,7 +250,7 @@ To disable a map use: - `: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