X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c4773a9b8e0ac823009bb342b2642f780de33cdc..3522dd502b500365afe4462241921216f1d3ec1d:/README.md diff --git a/README.md b/README.md index da77a07..1243577 100644 --- 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 -let g:vim_markdown_folding_disabled=1 +let g:vim_markdown_folding_disabled = 1 ``` This option only controls Vim Markdown specific folding configuration. @@ -76,7 +76,22 @@ To fold in a style like [python-mode](https://github.com/klen/python-mode), add 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 + +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 @@ -84,47 +99,52 @@ let g:vim_markdown_folding_style_pythonic=1 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 `` mappings. -### Syntax extensions - -The following options control which syntax extensions will be turned on. They are off by default. +### Enable TOC window auto-fit -#### LaTeX math - -Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. +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_math=1 +let g:vim_markdown_toc_autofit = 1 ``` -#### YAML frontmatter +### Syntax Concealing -Highlight YAML frontmatter as used by Jekyll: +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 -let g:vim_markdown_frontmatter=1 +set conceallevel=2 ``` -#### Folding level +### Syntax extensions + +The following options control which syntax extensions will be turned on. They are off by default. -Folding level is a number between 1 and 6. By default, if not specified, it is set to 1. +#### LaTeX math + +Used as `$x^2$`, `$$x^2$$`, escapable as `\$x\$` and `\$\$x\$\$`. ```vim -let g:vim_markdown_folding_level = 6 +let g:vim_markdown_math = 1 ``` -Tip: it can be changed on the fly with: +#### YAML frontmatter + +Highlight YAML frontmatter as used by Jekyll: ```vim -:let g:vim_markdown_folding_level = 1 -:edit +let g:vim_markdown_frontmatter = 1 ``` - ## Mappings The following work on normal and visual modes: @@ -167,6 +187,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.