X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/861e84fc0bc97be8387e92ac2fc180599dc2b5a3..fef4c7a4a0a4ca4ea0fb9b67c69425c32ac63aa7:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 714d3a9..4e1c487 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| @@ -21,17 +24,22 @@ Contents ~ 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| + 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-auto-extension-ext| - 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| + 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* @@ -73,12 +81,59 @@ 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 ~ ------------------------------------------------------------------------------- *vim-markdown-disable-folding* + *g:vim_markdown_folding_disabled* Disable Folding ~ Add the following line to your '.vimrc' to disable the folding configuration: @@ -93,6 +148,8 @@ To enable/disable folding use Vim's standard folding configuration. < ------------------------------------------------------------------------------- *vim-markdown-change-fold-style* + *g:vim_markdown_folding_style_pythonic* + *g:vim_markdown_override_foldtext* Change fold style ~ To fold in a style like python-mode [6], add the following to your '.vimrc': @@ -108,6 +165,7 @@ To prevent foldtext from being set add the following to your '.vimrc': < ------------------------------------------------------------------------------- *vim-markdown-set-header-folding-level* + *g:vim_markdown_folding_level* Set header folding level ~ Folding level is a number between 1 and 6. By default, if not specified, it is @@ -122,6 +180,7 @@ Tip: it can be changed on the fly with: < ------------------------------------------------------------------------------- *vim-markdown-disable-default-key-mappings* + *g:vim_markdown_no_default_key_mappings* Disable Default Key Mappings ~ Add the following line to your '.vimrc' to disable default key mappings: @@ -132,6 +191,7 @@ You can also map them by yourself with '' mappings. ------------------------------------------------------------------------------- *vim-markdown-enable-toc-window-auto-fit* + *g:vim_markdown_toc_autofit* Enable TOC window auto-fit ~ Allow for the TOC window to auto-fit when it's possible for it to shrink. It @@ -141,16 +201,18 @@ never increases its default size (half screen), it only shrinks. < ------------------------------------------------------------------------------- *vim-markdown-text-emphasis-restriction-to-single-lines* + *g:vim_markdown_emphasis_multiline* 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, +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 < ------------------------------------------------------------------------------- *vim-markdown-syntax-concealing* + *g:vim_markdown_conceal* Syntax Concealing ~ Concealing is set for some syntax. @@ -177,6 +239,7 @@ your '.vimrc': < ------------------------------------------------------------------------------- *vim-markdown-fenced-code-block-languages* + *g:vim_markdown_fenced_languages* Fenced code block languages ~ You can use filetype name as fenced code block languages for syntax @@ -195,11 +258,13 @@ Default is "['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']". ------------------------------------------------------------------------------- *vim-markdown-follow-named-anchors* + *g:vim_markdown_follow_anchor* + *g:vim_markdown_anchorexpr* 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: +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 < @@ -231,6 +296,7 @@ are off by default. ------------------------------------------------------------------------------- *vim-markdown-latex-math* + *g:vim_markdown_math* LaTeX math ~ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. @@ -239,6 +305,7 @@ Used as '$x^2$', '$$x^2$$', escapable as '\$x\$' and '\$\$x\$\$'. < ------------------------------------------------------------------------------- *vim-markdown-yaml-front-matter* + *g:vim_markdown_frontmatter* YAML Front Matter ~ Highlight YAML front matter as used by Jekyll or Hugo [7]. @@ -247,6 +314,7 @@ Highlight YAML front matter as used by Jekyll or Hugo [7]. < ------------------------------------------------------------------------------- *vim-markdown-toml-front-matter* + *g:vim_markdown_toml_frontmatter* TOML Front Matter ~ Highlight TOML front matter as used by Hugo [7]. @@ -257,6 +325,7 @@ TOML syntax highlight requires vim-toml [8]. < ------------------------------------------------------------------------------- *vim-markdown-json-front-matter* + *g:vim_markdown_json_frontmatter* JSON Front Matter ~ Highlight JSON front matter as used by Hugo [7]. @@ -265,8 +334,18 @@ JSON syntax highlight requires vim-json [9]. > let g:vim_markdown_json_frontmatter = 1 < +------------------------------------------------------------------------------- + *vim-markdown-strikethrough* + *g:vim_markdown_strikethrough* +Strikethrough ~ + +Strikethrough uses two tildes. '~~Scratch this.~~' +> + let g:vim_markdown_strikethrough = 1 +< ------------------------------------------------------------------------------- *vim-markdown-adjust-new-list-item-indent* + *g:vim_markdown_new_list_item_indent* Adjust new list item indent ~ You can adjust a new list indent. For example, you insert a single line like @@ -287,6 +366,7 @@ of indent is 4. If you'd like to change the number as 2, just write: < ------------------------------------------------------------------------------- *vim-markdown-do-not-require-.md-extensions-for-markdown-links* + *g:vim_markdown_no_extensions_in_markdown* 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 @@ -303,6 +383,7 @@ work. So this option adds some consistency between the two. ------------------------------------------------------------------------------- *vim-markdown-auto-write-when-following-link* + *g:vim_markdown_autowrite* Auto-write when following link ~ If you follow a link like this '[link text](link-url)' using the 'ge' shortcut, @@ -311,7 +392,8 @@ this option will automatically save any edits you made before moving you: let g:vim_markdown_autowrite = 1 < ------------------------------------------------------------------------------- - *vim-markdown-auto-extension-ext* + *vim-markdown-change-default-file-extension* + *g: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 @@ -319,6 +401,34 @@ the 'vim_markdown_auto_extension_ext' variable: > let g:vim_markdown_auto_extension_ext = 'txt' < +------------------------------------------------------------------------------- + *vim-markdown-do-not-automatically-insert-bulletpoints* + *g:vim_markdown_auto_insert_bullets* +Do not automatically insert bulletpoints ~ + +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* + *g:vim_markdown_edit_url_in* +Change how to open new files ~ + +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 ~