Improve regexp performance of italic

[etc/vim.git] / doc / vim-markdown.txt

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index f88ae2549d26bd8a8d16398db495fe658bb32031..74b9748416d9fd7cb28bbfebf43a0d7f93e1f638 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -8,8 +8,10 @@ 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 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 +70,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 +84,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 +106,19 @@ 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 '<Plug>' 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-extensions*
 Syntax extensions ~
@@ -107,7 +132,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 +140,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 +201,8 @@ To disable a map use:
                                                         *vim-markdown-commands*
 Commands ~
 
+The following requires ':filetype plugin on'.
+
                                                               *:HeaderDecrease*
 - ':HeaderDecrease':