]> git.madduck.net Git - etc/vim.git/blobdiff - doc/vim-markdown.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge pull request #335 from spearman/horiz-rule-syntax
[etc/vim.git] / doc / vim-markdown.txt
diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 6af20d172951078bc495067cc4751706a15203f0..c6d579e7cc07b9354149411a4ce388d64e2593bf 100644 (file)
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -21,6 +21,10 @@ Contents ~
    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|
    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|
+  11. Do not require .md extensions for Markdown links
+                |vim-markdown-do-not-require-.md-extensions-for-markdown-links|
+  12. Auto-write when following link
+                                  |vim-markdown-auto-write-when-following-link|
  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|
@@ -96,6 +100,10 @@ To fold in a style like python-mode [6], add the following to your '.vimrc':
 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.
 
 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.
 
+To prevent foldtext from being set add the following to your '.vimrc':
+>
+  let g:vim_markdown_override_foldtext = 0
+<
 -------------------------------------------------------------------------------
                                         *vim-markdown-set-header-folding-level*
 Set header folding level ~
 -------------------------------------------------------------------------------
                                         *vim-markdown-set-header-folding-level*
 Set header folding level ~
@@ -145,7 +153,10 @@ Syntax Concealing ~
 
 Concealing is set for some syntax.
 
 
 Concealing is set for some syntax.
 
-For example, conceal '[link text](link url)' as just 'link text'.
+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 just
+**bold**, **bold**, **_italic bold_**, and **_italic bold_** respectively.
 
 To enable conceal use Vim's standard conceal configuration.
 >
 
 To enable conceal use Vim's standard conceal configuration.
 >
@@ -156,6 +167,12 @@ your '.vimrc':
 >
   let g:vim_markdown_conceal = 0
 <
 >
   let g:vim_markdown_conceal = 0
 <
+To disable math conceal with LaTeX math syntax enabled, add the following to
+your '.vimrc':
+>
+  let g:tex_conceal = ""
+  let g:vim_markdown_math = 1
+<
 -------------------------------------------------------------------------------
                                      *vim-markdown-fenced-code-block-languages*
 Fenced code block languages ~
 -------------------------------------------------------------------------------
                                      *vim-markdown-fenced-code-block-languages*
 Fenced code block languages ~
@@ -237,13 +254,38 @@ 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
 <
 >
   let g:vim_markdown_new_list_item_indent = 2
 <
+-------------------------------------------------------------------------------
+                *vim-markdown-do-not-require-.md-extensions-for-markdown-links*
+Do not require .md extensions for Markdown links ~
+
+If you want to have a link like this '[link text](link-url)' and follow it for
+editing in vim using the 'ge' command, but have it open the file "link-url.md"
+instead of the file "link-url", then use this option:
+>
+  let g:vim_markdown_no_extensions_in_markdown = 1
+<
+This is super useful for GitLab and GitHub wiki repositories.
+
+Normal behaviour would be that vim-markup required you to do this '[link text
+](link-url.md)', but this is not how the Gitlab and GitHub wiki repositories
+work. So this option adds some consistency between the two.
+
+-------------------------------------------------------------------------------
+                                  *vim-markdown-auto-write-when-following-link*
+Auto-write when following link ~
+
+If you follow a link like this '[link text](link-url)' using the 'ge' shortcut,
+this option will automatically save any edits you made before moving you:
+>
+  let g:vim_markdown_autowrite = 1
+<
 ===============================================================================
                                                         *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'
 
@@ -262,25 +304,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
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.