X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/366625f8c579ed668ecb079c74a32e39c811d6a1..9041a939364442c5ece81bde677a675fb9884429:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index c430eb8..714d3a9 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -10,9 +10,23 @@ Contents ~ 2. Change fold style |vim-markdown-change-fold-style| 3. Set header folding level |vim-markdown-set-header-folding-level| 4. Disable Default Key Mappings |vim-markdown-disable-default-key-mappings| - 5. Syntax extensions |vim-markdown-syntax-extensions| + 5. Enable TOC window auto-fit |vim-markdown-enable-toc-window-auto-fit| + 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. Follow named anchors |vim-markdown-follow-named-anchors| + 10. Syntax extensions |vim-markdown-syntax-extensions| 1. LaTeX math |vim-markdown-latex-math| - 2. YAML frontmatter |vim-markdown-yaml-frontmatter| + 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| + 11. Adjust new list item indent |vim-markdown-adjust-new-list-item-indent| + 12. Do not require .md extensions for Markdown links + |vim-markdown-do-not-require-.md-extensions-for-markdown-links| + 13. Auto-write when following link + |vim-markdown-auto-write-when-following-link| + 14. Change default file extension |vim-markdown-auto-extension-ext| 4. Mappings |vim-markdown-mappings| 5. Commands |vim-markdown-commands| 6. Credits |vim-markdown-credits| @@ -85,6 +99,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 ~ @@ -109,6 +130,98 @@ Add the following line to your '.vimrc' to disable default key mappings: < You can also map them by yourself with '' mappings. +------------------------------------------------------------------------------- + *vim-markdown-enable-toc-window-auto-fit* +Enable TOC window auto-fit ~ + +Allow for the TOC window to auto-fit when it's possible for it to shrink. It +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'. 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. +> + set conceallevel=2 +< +To disable conceal regardless of 'conceallevel' setting, add the following to +your '.vimrc': +> + 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 ~ + +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-follow-named-anchors* +Follow named anchors ~ + +This feature allows ge to follow named anchors in links of the form +'file#anchor' or just '#anchor', where file may omit the '.md' extension as +usual. Two variables control its operation: +> + let g:vim_markdown_follow_anchor = 1 +< +This tells vim-markdown whether to attempt to follow a named anchor in a link +or not. When it is 1, and only if a link can be split in two parts by the +pattern '#', then the first part is interpreted as the file and the second one +as the named anchor. This also includes urls of the form '#anchor', for which +the first part is considered empty, meaning that the target file is the current +one. After the file is opened, the anchor will be searched. + +Default is '0'. +> + let g:vim_markdown_anchorexpr = "'<<'.v:anchor.'>>'" +< +This expression will be evaluated substituting 'v:anchor' with a quoted string +that contains the anchor to visit. The result of the evaluation will become the +real anchor to search in the target file. This is useful in order to convert +anchors of the form, say, 'my-section-title' to searches of the form 'My +Section Title' or '<>'. + +Default is "''". + ------------------------------------------------------------------------------- *vim-markdown-syntax-extensions* Syntax extensions ~ @@ -125,20 +238,94 @@ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. let g:vim_markdown_math = 1 < ------------------------------------------------------------------------------- - *vim-markdown-yaml-frontmatter* -YAML frontmatter ~ + *vim-markdown-yaml-front-matter* +YAML Front Matter ~ -Highlight YAML frontmatter as used by Jekyll: +Highlight YAML front matter as used by Jekyll or Hugo [7]. > let g:vim_markdown_frontmatter = 1 < +------------------------------------------------------------------------------- + *vim-markdown-toml-front-matter* +TOML Front Matter ~ + +Highlight TOML front matter as used by Hugo [7]. + +TOML syntax highlight requires vim-toml [8]. +> + let g:vim_markdown_toml_frontmatter = 1 +< +------------------------------------------------------------------------------- + *vim-markdown-json-front-matter* +JSON Front Matter ~ + +Highlight JSON front matter as used by Hugo [7]. + +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-auto-extension-ext* +Change default file extension ~ + +If you would like to use a file extension other than '.md' you may do so using +the 'vim_markdown_auto_extension_ext' variable: +> + let g:vim_markdown_auto_extension_ext = 'txt' +< =============================================================================== *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' @@ -157,25 +344,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 @@ -191,6 +384,8 @@ To disable a map use: *vim-markdown-commands* Commands ~ +The following requires ':filetype plugin on'. + *:HeaderDecrease* - ':HeaderDecrease': @@ -215,9 +410,9 @@ Commands ~ range. *:TableFormat* -- ':TableFormat': Format the table under the cursor like this [7]. +- ':TableFormat': Format the table under the cursor like this [10]. - Requires Tabular [8]. + Requires Tabular [11]. The input table _must_ already have a separator line as the second line of the table. That line only needs to contain the correct pipes '|', nothing @@ -237,7 +432,7 @@ Commands ~ - ':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* @@ -246,7 +441,7 @@ Credits ~ The main contributors of vim-markdown are: - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim- - markdown. Homepage [9]. + markdown. Homepage [12]. If you feel that your name should be on this list, please make a pull request listing your contributions. @@ -287,8 +482,11 @@ References ~ [4] http://packages.qa.debian.org/v/vim-addon-manager.html [5] https://github.com/plasticboy/vim-markdown/archive/master.tar.gz [6] https://github.com/klen/python-mode -[7] http://www.cirosantilli.com/markdown-style-guide/#tables -[8] https://github.com/godlygeek/tabular -[9] http://plasticboy.com/ +[7] https://gohugo.io/content/front-matter/ +[8] https://github.com/cespare/vim-toml +[9] https://github.com/elzr/vim-json +[10] http://www.cirosantilli.com/markdown-style-guide/#tables +[11] https://github.com/godlygeek/tabular +[12] http://plasticboy.com/ vim: ft=help