X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/119eee9dd01cc28f0c49576ad1845d68761a0003..7cb6bd72ae0d906395e41e75b193407c76ac3dd5:/doc/vim-markdown.txt?ds=inline diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 6ec4480..2601da1 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -11,12 +11,20 @@ Contents ~ 3. Set header folding level |vim-markdown-set-header-folding-level| 4. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings| 5. Enable TOC window auto-fit |vim-markdown-enable-toc-window-auto-fit| - 6. Syntax Concealing |vim-markdown-syntax-concealing| - 7. Syntax extensions |vim-markdown-syntax-extensions| + 6. Text emphasis restriction to single-lines + |vim-markdown-text-emphasis-restriction-to-single-lines| + 7. Syntax Concealing |vim-markdown-syntax-concealing| + 8. Fenced code block languages |vim-markdown-fenced-code-block-languages| + 9. Syntax extensions |vim-markdown-syntax-extensions| 1. LaTeX math |vim-markdown-latex-math| 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| + 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| @@ -89,6 +97,13 @@ 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. + +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 ~ @@ -122,18 +137,54 @@ never increases its default size (half screen), it only shrinks. > let g:vim_markdown_toc_autofit = 1 < +------------------------------------------------------------------------------- + *vim-markdown-text-emphasis-restriction-to-single-lines* +Text emphasis restriction to single-lines ~ + +By default text emphasis works across multiple lines until a closing token is +found. However, it's possible to restrict text emphasis to a single line (ie, +for it to be applied a closing token must be found on the same line). To do so: +> + let g:vim_markdown_emphasis_multiline = 0 +< ------------------------------------------------------------------------------- *vim-markdown-syntax-concealing* Syntax Concealing ~ 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/disable conceal use Vim's standard conceal configuration. +To enable conceal use Vim's standard conceal configuration. > set conceallevel=2 < +To disable conceal regardless of 'conceallevel' setting, add the following to +your '.vimrc': +> + let g:vim_markdown_conceal = 0 +< +------------------------------------------------------------------------------- + *vim-markdown-fenced-code-block-languages* +Fenced code block languages ~ + +You can use filetype name as fenced code block languages for syntax +highlighting. If you want to use different name from filetype, you can add it +in your '.vimrc' like so: +> + let g:vim_markdown_fenced_languages = ['csharp=cs'] +< +This will cause the following to be highlighted using the 'cs' filetype syntax. +> + ```csharp + ... + ``` +< +Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']". + ------------------------------------------------------------------------------- *vim-markdown-syntax-extensions* Syntax extensions ~ @@ -177,13 +228,58 @@ JSON syntax highlight requires vim-json [9]. > 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-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: - *gx* + *vim-markdown-gx* - 'gx': open the link under the cursor in the same browser as the standard 'gx' command. 'Markdown_OpenUrlUnderCursor' @@ -202,25 +298,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. 'Markdown_EditUrlUnderCursor' + + The rules for the cursor position are the same as the 'gx' command. + + *vim-markdown-]]* - ']]': go to next header. 'Markdown_MoveToNextHeader' - *[[* + *vim-markdown-[[* - '[[': go to previous header. Contrast with ']c'. 'Markdown_MoveToPreviousHeader' - *][* + *vim-markdown-][* - '][': go to next sibling header if any. 'Markdown_MoveToNextSiblingHeader' - *[]* + *vim-markdown-[]* - '[]': go to previous sibling header if any. 'Markdown_MoveToPreviousSiblingHeader' - *]c* + *vim-markdown-]c* - ']c': go to Current header. 'Markdown_MoveToCurHeader' - *]u* + *vim-markdown-]u* - ']u': go to parent header (Up). 'Markdown_MoveToParentHeader' This plugin follows the recommended Vim plugin mapping interface, so to change @@ -284,7 +386,7 @@ The following requires ':filetype plugin on'. - ':Toct': Same as ':Toc' but in a new tab. *:Tocv* -- ':Tocv': Same as ':Toc' for symmetry with ':Toch' and 'Tocv'. +- ':Tocv': Same as ':Toc' for symmetry with ':Toch' and ':Tocv'. =============================================================================== *vim-markdown-credits*