Add option to disable setting foldtext

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

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 6e486deb6e35b976399b43ba9cf0930faaa70605..eb616539a98a1e533877eee9177872238de8fcd9 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,13 +217,33 @@ 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 ~
 
 The following work on normal and visual modes:
 
 ===============================================================================
                                                         *vim-markdown-mappings*
 Mappings ~
 
 The following work on normal and visual modes:
 

-                                                                           *gx*
+                                                              *vim-markdown-gx*

 - 'gx': open the link under the cursor in the same browser as the standard
   'gx' command. '<Plug>Markdown_OpenUrlUnderCursor'
 
 - 'gx': open the link under the cursor in the same browser as the standard
   'gx' command. '<Plug>Markdown_OpenUrlUnderCursor'
 


@@ -238,25 +262,31 @@ The following work on normal and visual modes:
 <
   Known limitation: does not work for links that span multiple lines.
 
 <
   Known limitation: does not work for links that span multiple lines.
 

-                                                                           *]]*
+                                                              *vim-markdown-ge*
+- 'ge': open the link under the cursor in Vim for editing. Useful for
+  relative markdown links. '<Plug>Markdown_EditUrlUnderCursor'
+
+  The rules for the cursor position are the same as the 'gx' command.
+
+                                                              *vim-markdown-]]*

 - ']]': go to next header. '<Plug>Markdown_MoveToNextHeader'
 
 - ']]': go to next header. '<Plug>Markdown_MoveToNextHeader'
 

-                                                                           *[[*
+                                                              *vim-markdown-[[*

 - '[[': go to previous header. Contrast with ']c'.
   '<Plug>Markdown_MoveToPreviousHeader'
 
 - '[[': go to previous header. Contrast with ']c'.
   '<Plug>Markdown_MoveToPreviousHeader'
 

-                                                                           *][*
+                                                              *vim-markdown-][*

 - '][': go to next sibling header if any.
   '<Plug>Markdown_MoveToNextSiblingHeader'
 
 - '][': go to next sibling header if any.
   '<Plug>Markdown_MoveToNextSiblingHeader'
 

-                                                                           *[]*
+                                                              *vim-markdown-[]*

 - '[]': go to previous sibling header if any.
   '<Plug>Markdown_MoveToPreviousSiblingHeader'
 
 - '[]': go to previous sibling header if any.
   '<Plug>Markdown_MoveToPreviousSiblingHeader'
 

-                                                                           *]c*
+                                                              *vim-markdown-]c*

 - ']c': go to Current header. '<Plug>Markdown_MoveToCurHeader'
 
 - ']c': go to Current header. '<Plug>Markdown_MoveToCurHeader'
 

-                                                                           *]u*
+                                                              *vim-markdown-]u*

 - ']u': go to parent header (Up). '<Plug>Markdown_MoveToParentHeader'
 
 This plugin follows the recommended Vim plugin mapping interface, so to change
 - ']u': go to parent header (Up). '<Plug>Markdown_MoveToParentHeader'
 
 This plugin follows the recommended Vim plugin mapping interface, so to change