X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/dfd237a98e3c4ce1f7494efa50b90ccb921a704a..1b37c6c879c6fcdd5f96ef12b95eeda2e0b416e7:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 1fcec7b..12ce7c8 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -8,8 +8,11 @@ Contents ~ 3. Options |vim-markdown-options| 1. Disable Folding |vim-markdown-disable-folding| 2. Change fold style |vim-markdown-change-fold-style| - 3. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings| - 4. Syntax extensions |vim-markdown-syntax-extensions| + 3. Set header folding level |vim-markdown-set-header-folding-level| + 4. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings| + 5. Enable TOC window auto-fit |vim-markdown-enable-toc-window-auto-fit| + 6. Syntax Concealing |vim-markdown-syntax-concealing| + 7. Syntax extensions |vim-markdown-syntax-extensions| 1. LaTeX math |vim-markdown-latex-math| 2. YAML frontmatter |vim-markdown-yaml-frontmatter| 4. Mappings |vim-markdown-mappings| @@ -68,7 +71,7 @@ Disable Folding ~ Add the following line to your '.vimrc' to disable the folding configuration: > - let g:vim_markdown_folding_disabled=1 + let g:vim_markdown_folding_disabled = 1 < This option only controls Vim Markdown specific folding configuration. @@ -82,7 +85,21 @@ Change fold style ~ To fold in a style like python-mode [6], add the following to your '.vimrc': > - let g:vim_markdown_folding_style_pythonic=1 + let g:vim_markdown_folding_style_pythonic = 1 +< +------------------------------------------------------------------------------- + *vim-markdown-set-header-folding-level* +Set header folding level ~ + +Folding level is a number between 1 and 6. By default, if not specified, it is +set to 1. +> + let g:vim_markdown_folding_level = 6 +< +Tip: it can be changed on the fly with: +> + :let g:vim_markdown_folding_level = 1 + :edit < ------------------------------------------------------------------------------- *vim-markdown-disable-default-key-mappings* @@ -90,10 +107,31 @@ Disable Default Key Mappings ~ Add the following line to your '.vimrc' to disable default key mappings: > - 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. +------------------------------------------------------------------------------- + *vim-markdown-enable-toc-window-auto-fit* +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. +> + let g:vim_markdown_toc_autofit = 1 +< +------------------------------------------------------------------------------- + *vim-markdown-syntax-concealing* +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. +> + set conceallevel = 2 +< ------------------------------------------------------------------------------- *vim-markdown-syntax-extensions* Syntax extensions ~ @@ -107,7 +145,7 @@ LaTeX math ~ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. > - let g:vim_markdown_math=1 + let g:vim_markdown_math = 1 < ------------------------------------------------------------------------------- *vim-markdown-yaml-frontmatter* @@ -115,7 +153,7 @@ YAML frontmatter ~ Highlight YAML frontmatter as used by Jekyll: > - let g:vim_markdown_frontmatter=1 + let g:vim_markdown_frontmatter = 1 < =============================================================================== *vim-markdown-mappings* @@ -176,6 +214,8 @@ To disable a map use: *vim-markdown-commands* Commands ~ +The following requires ':filetype plugin on'. + *:HeaderDecrease* - ':HeaderDecrease': @@ -272,7 +312,7 @@ References ~ [4] http://packages.qa.debian.org/v/vim-addon-manager.html [5] https://github.com/plasticboy/vim-markdown/archive/master.tar.gz [6] https://github.com/klen/python-mode -[7] http://www.cirosantilli.com/markdown-styleguide/#tables +[7] http://www.cirosantilli.com/markdown-style-guide/#tables [8] https://github.com/godlygeek/tabular [9] http://plasticboy.com/