From: Hiroshi Shirosaki Date: Thu, 16 Mar 2017 00:39:28 +0000 (+0900) Subject: Update doc for `ge` X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/ab8ecf0bc73a792c60ad7a8a303290ccf89aa4e5?ds=inline;hp=-c Update doc for `ge` --- ab8ecf0bc73a792c60ad7a8a303290ccf89aa4e5 diff --git a/README.md b/README.md index c626e0a..3f0e8d8 100644 --- a/README.md +++ b/README.md @@ -230,7 +230,7 @@ let g:vim_markdown_new_list_item_indent = 2 ### 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: +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: ```vim let g:vim_markdown_no_extensions_in_markdown = 1 @@ -241,7 +241,7 @@ Normal behaviour would be that vim-markup required you to do this `[link text](l ### 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: +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: ```vim let g:vim_markdown_autowrite = 1 diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 3ee30e6..2601da1 100644 --- 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| + 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| @@ -96,10 +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. -To prevent foldtext from being overridden, add the following to your '.vimrc': - +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 ~ @@ -149,10 +153,10 @@ 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. +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. > @@ -244,6 +248,31 @@ 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-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 ~