Merge pull request #243 from alexconst/feat/toc_autofit

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

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 1fcec7bd2d669740c38524ee08bede1c23104fc2..c430eb80bb0bf799be178bbacc2fcf16ca6c3575 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -8,8 +8,9 @@ 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. 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 +69,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 +83,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,7 +105,7 @@ 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.
 
@@ -107,7 +122,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 +130,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*
@@ -272,7 +287,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/