Add documentation

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

diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 4e9fbf0bfc925919391667db367357357b2282a1..0d12a1d96e394a521cbc34c641384c8e00b0e93f 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -93,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
 <
+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 ~
@@ -143,6 +146,9 @@ Syntax Concealing ~
 Concealing is set for some syntax.
 
 For example, conceal '[link text](link url)' as just 'link text'.
+Also, '_italic_' and '*italic*' will conceal to just 'italic'.
+Similarly '__bold__', '**bold**', '___italic bold___', and '***italic bold***'
+will conceal to 'bold', 'bold', 'italic bold', and 'italic bold' respectively.
 
 To enable conceal use Vim's standard conceal configuration.
 >
@@ -240,7 +246,7 @@ 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'
 
@@ -259,25 +265,31 @@ The following work on normal and visual modes:
 <
   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'
 
-                                                                           *[[*
+                                                              *vim-markdown-[[*
 - '[[': go to previous header. Contrast with ']c'.
   '<Plug>Markdown_MoveToPreviousHeader'
 
-                                                                           *][*
+                                                              *vim-markdown-][*
 - '][': go to next sibling header if any.
   '<Plug>Markdown_MoveToNextSiblingHeader'
 
-                                                                           *[]*
+                                                              *vim-markdown-[]*
 - '[]': go to previous sibling header if any.
   '<Plug>Markdown_MoveToPreviousSiblingHeader'
 
-                                                                           *]c*
+                                                              *vim-markdown-]c*
 - ']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