X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/04e060dc062ee981f5c9bcc8f3b700f803da285f..9f4d1c8db08cca85c46de7f3f0b944ce3cafe35c:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 6e486de..95f8f40 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -5,7 +5,10 @@ Contents ~ 1. Introduction |vim-markdown-introduction| 2. Installation |vim-markdown-installation| - 3. Options |vim-markdown-options| + 3. Basic usage |vim-markdown-basic-usage| + 1. Folding |vim-markdown-folding| + 2. Concealing |vim-markdown-concealing| + 4. Options |vim-markdown-options| 1. Disable Folding |vim-markdown-disable-folding| 2. Change fold style |vim-markdown-change-fold-style| 3. Set header folding level |vim-markdown-set-header-folding-level| @@ -15,16 +18,28 @@ Contents ~ |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| + 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 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| - 4. Mappings |vim-markdown-mappings| - 5. Commands |vim-markdown-commands| - 6. Credits |vim-markdown-credits| - 7. License |vim-markdown-license| - 8. References |vim-markdown-references| + 5. Strikethrough |vim-markdown-strikethrough| + 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-change-default-file-extension| + 15. Do not automatically insert bulletpoints + |vim-markdown-do-not-automatically-insert-bulletpoints| + 16. Change how to open new files |vim-markdown-change-how-to-open-new-files| + 5. Mappings |vim-markdown-mappings| + 6. Commands |vim-markdown-commands| + 7. Credits |vim-markdown-credits| + 8. License |vim-markdown-license| + 9. References |vim-markdown-references| =============================================================================== *vim-markdown-introduction* @@ -37,7 +52,7 @@ and extensions. *vim-markdown-installation* Installation ~ -If you use Vundle [2], add the following line to your '~/.vimrc': +If you use Vundle [2], add the following lines to your '~/.vimrc': > Plugin 'godlygeek/tabular' Plugin 'plasticboy/vim-markdown' @@ -66,6 +81,52 @@ If you are not using any package manager, download the tarball [5] and do this: cd ~/.vim tar --strip=1 -zxf vim-markdown-master.tar.gz < +=============================================================================== + *vim-markdown-basic-usage* +Basic usage ~ + +------------------------------------------------------------------------------- + *vim-markdown-folding* +Folding ~ + +Folding is enabled for headers by default. + +The following commands are useful to open and close folds: + + *vim-markdown-zr* +- 'zr': reduces fold level throughout the buffer + *vim-markdown-zR* +- 'zR': opens all folds + *vim-markdown-zm* +- 'zm': increases fold level throughout the buffer + *vim-markdown-zM* +- 'zM': folds everything all the way + *vim-markdown-za* +- 'za': open a fold your cursor is on + *vim-markdown-zA* +- 'zA': open a fold your cursor is on recursively + *vim-markdown-zc* +- 'zc': close a fold your cursor is on + *vim-markdown-zC* +- 'zC': close a fold your cursor is on recursively + +Options are available to disable folding or change folding style. + +Try ':help fold-expr' and ':help fold-commands' for details. + +------------------------------------------------------------------------------- + *vim-markdown-concealing* +Concealing ~ + +Concealing is set for some syntax such as bold, italic, code block and link. + +Concealing lets you conceal text with other text. The actual source text is not +modified. If you put your cursor on the concealed line, the conceal goes away. + +Options are available to disable or change concealing. + +Try ':help concealcursor' and ':help conceallevel' for details. + =============================================================================== *vim-markdown-options* Options ~ @@ -74,13 +135,17 @@ Options ~ *vim-markdown-disable-folding* Disable Folding ~ -Add the following line to your '.vimrc' to disable the folding configuration: + *g:vim_markdown_folding_disabled* +- 'g:vim_markdown_folding_disabled' + + Add the following line to your '.vimrc' to disable the folding + configuration: > let g:vim_markdown_folding_disabled = 1 < -This option only controls Vim Markdown specific folding configuration. + This option only controls Vim Markdown specific folding configuration. -To enable/disable folding use Vim's standard folding configuration. + To enable/disable folding use Vim's standard folding configuration. > set [no]foldenable < @@ -88,20 +153,37 @@ To enable/disable folding use Vim's standard folding configuration. *vim-markdown-change-fold-style* Change fold style ~ -To fold in a style like python-mode [6], add the following to your '.vimrc': + *g:vim_markdown_folding_style_pythonic* +- 'g:vim_markdown_folding_style_pythonic' + + 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. + + *g:vim_markdown_override_foldtext* +- 'g:vim_markdown_override_foldtext' + + 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 ~ -Folding level is a number between 1 and 6. By default, if not specified, it is -set to 1. + *g:vim_markdown_folding_level* +- 'g:vim_markdown_folding_level' + + Folding level is a number between 1 and 6. By default, if not specified, it + is set to 1. > let g:vim_markdown_folding_level = 6 < -Tip: it can be changed on the fly with: + Tip: it can be changed on the fly with: > :let g:vim_markdown_folding_level = 1 :edit @@ -110,18 +192,24 @@ Tip: it can be changed on the fly with: *vim-markdown-disable-default-key-mappings* Disable Default Key Mappings ~ -Add the following line to your '.vimrc' to disable default key mappings: + *g:vim_markdown_no_default_key_mappings* +- 'g:vim_markdown_no_default_key_mappings' + + Add the following line to your '.vimrc' to disable default key mappings: > let g:vim_markdown_no_default_key_mappings = 1 < -You can also map them by yourself with '' 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. + *g:vim_markdown_toc_autofit* +- 'g:vim_markdown_toc_autofit' + + 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 < @@ -129,9 +217,13 @@ never increases its default size (half screen), it only shrinks. *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: + *g:vim_markdown_emphasis_multiline* +- 'g:vim_markdown_emphasis_multiline' + + 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 + (i.e., 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 < @@ -139,36 +231,96 @@ for it to be applied a closing token must be found on the same line). To do so: *vim-markdown-syntax-concealing* Syntax Concealing ~ -Concealing is set for some syntax. + *g:vim_markdown_conceal* +- 'g:vim_markdown_conceal' + + 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. > set conceallevel=2 < -To disable conceal regardless of 'conceallevel' setting, add the following to -your '.vimrc': + 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 +< + *g:vim_markdown_conceal_code_blocks* +- 'g:vim_markdown_conceal_code_blocks' + + Disabling conceal for code fences requires an additional setting: +> + let g:vim_markdown_conceal_code_blocks = 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: + *g:vim_markdown_fenced_languages* +- 'g:vim_markdown_fenced_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. + This will cause the following to be highlighted using the 'cs' filetype + syntax. > ```csharp ... ``` < -Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']". + Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']". + +------------------------------------------------------------------------------- + *vim-markdown-follow-named-anchors* +Follow named anchors ~ + + *g:vim_markdown_follow_anchor* +- 'g:vim_markdown_follow_anchor' + + This feature allows the 'ge' command 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'. + + *g:vim_markdown_anchorexpr* +- 'g:vim_markdown_anchorexpr' +> + 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* @@ -181,7 +333,10 @@ are off by default. *vim-markdown-latex-math* LaTeX math ~ -Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. + *g:vim_markdown_math* +- 'g:vim_markdown_math' + + Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. > let g:vim_markdown_math = 1 < @@ -189,7 +344,10 @@ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. *vim-markdown-yaml-front-matter* YAML Front Matter ~ -Highlight YAML front matter as used by Jekyll or Hugo [7]. + *g:vim_markdown_frontmatter* +- 'g:vim_markdown_frontmatter' + + Highlight YAML front matter as used by Jekyll or Hugo [7]. > let g:vim_markdown_frontmatter = 1 < @@ -197,9 +355,12 @@ Highlight YAML front matter as used by Jekyll or Hugo [7]. *vim-markdown-toml-front-matter* TOML Front Matter ~ -Highlight TOML front matter as used by Hugo [7]. + *g:vim_markdown_toml_frontmatter* +- 'g:vim_markdown_toml_frontmatter' + + Highlight TOML front matter as used by Hugo [7]. -TOML syntax highlight requires vim-toml [8]. + TOML syntax highlight requires vim-toml [8]. > let g:vim_markdown_toml_frontmatter = 1 < @@ -207,19 +368,134 @@ TOML syntax highlight requires vim-toml [8]. *vim-markdown-json-front-matter* JSON Front Matter ~ -Highlight JSON front matter as used by Hugo [7]. + *g:vim_markdown_json_frontmatter* +- 'g:vim_markdown_json_frontmatter' -JSON syntax highlight requires vim-json [9]. + 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-strikethrough* +Strikethrough ~ + + *g:vim_markdown_strikethrough* +- 'g:vim_markdown_strikethrough' + + Strikethrough uses two tildes. '~~Scratch this.~~' +> + let g:vim_markdown_strikethrough = 1 +< +------------------------------------------------------------------------------- + *vim-markdown-adjust-new-list-item-indent* +Adjust new list item indent ~ + + *g:vim_markdown_new_list_item_indent* +- 'g:vim_markdown_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 ~ + + *g:vim_markdown_no_extensions_in_markdown* +- 'g:vim_markdown_no_extensions_in_markdown' + + 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 ~ + + *g:vim_markdown_autowrite* +- 'g:vim_markdown_autowrite' + + 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-change-default-file-extension* +Change default file extension ~ + + *g:vim_markdown_auto_extension_ext* +- 'g:vim_markdown_auto_extension_ext' + + 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-do-not-automatically-insert-bulletpoints* +Do not automatically insert bulletpoints ~ + + *g:vim_markdown_auto_insert_bullets* +- 'g:vim_markdown_auto_insert_bullets' + + Automatically inserting bulletpoints can lead to problems when wrapping + text (see issue #232 for details), so it can be disabled: +> + let g:vim_markdown_auto_insert_bullets = 0 +< + In that case, you probably also want to set the new list item indent to 0 + as well, or you will have to remove an indent each time you add a new list + item: +> + let g:vim_markdown_new_list_item_indent = 0 +< +------------------------------------------------------------------------------- + *vim-markdown-change-how-to-open-new-files* +Change how to open new files ~ + + *g:vim_markdown_edit_url_in* +- 'g:vim_markdown_edit_url_in' + + By default when following a link the target file will be opened in your + current buffer. This behavior can change if you prefer using splits or tabs + by using the 'vim_markdown_edit_url_in' variable. Possible values are + 'tab', 'vsplit', 'hsplit', 'current' opening in a new tab, vertical split, + horizontal split, and current buffer respectively. Defaults to current + buffer if not set: +> + let g:vim_markdown_edit_url_in = 'tab' +< =============================================================================== *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' @@ -238,25 +514,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