Update document for pythonic style folding

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

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 6e486deb6e35b976399b43ba9cf0930faaa70605..6af20d172951078bc495067cc4751706a15203f0 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -20,6 +20,7 @@ Contents ~
    2. YAML Front Matter                        |vim-markdown-yaml-front-matter|
    3. TOML Front Matter                        |vim-markdown-toml-front-matter|
    4. JSON Front Matter                        |vim-markdown-json-front-matter|
    2. YAML Front Matter                        |vim-markdown-yaml-front-matter|
    3. TOML Front Matter                        |vim-markdown-toml-front-matter|
    4. JSON Front Matter                        |vim-markdown-json-front-matter|

+  10. Adjust new list item indent    |vim-markdown-adjust-new-list-item-indent|

  4. Mappings                                            |vim-markdown-mappings|
  5. Commands                                            |vim-markdown-commands|
  6. Credits                                              |vim-markdown-credits|
  4. Mappings                                            |vim-markdown-mappings|
  5. Commands                                            |vim-markdown-commands|
  6. Credits                                              |vim-markdown-credits|


@@ -92,6 +93,9 @@ 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
 <

+Level 1 heading which is served as a document title is not folded.
+'g:vim_markdown_folding_level' setting is not active with this fold style.
+

 -------------------------------------------------------------------------------
                                         *vim-markdown-set-header-folding-level*
 Set header folding level ~
 -------------------------------------------------------------------------------
                                         *vim-markdown-set-header-folding-level*
 Set header folding level ~


@@ -213,6 +217,26 @@ JSON syntax highlight requires vim-json [9].
 >
   let g:vim_markdown_json_frontmatter = 1
 <
 >
   let g:vim_markdown_json_frontmatter = 1
 <

+-------------------------------------------------------------------------------
+                                     *vim-markdown-adjust-new-list-item-indent*
+Adjust new list item indent ~
+
+You can adjust a new list indent. For example, you insert a single line like
+below:
+>
+  * item1
+<
+Then if you type 'o' to insert new line in vim and type '* item2', the result
+will be:
+>
+  * item1
+      * item2
+<
+vim-markdown automatically insert the indent. By default, the number of spaces
+of indent is 4. If you'd like to change the number as 2, just write:
+>
+  let g:vim_markdown_new_list_item_indent = 2
+<

 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~