X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/27fc5d94b1dce92c4ec48a390592c7f4f302070d..4b688b12ccbbde3ee7b71f2cc8445a3106957394:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 8a4d536..1e81ea2 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,6 +24,7 @@ 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| @@ -31,11 +35,11 @@ Contents ~ 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| - 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. 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* @@ -77,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 ~ @@ -269,6 +319,14 @@ JSON syntax highlight requires vim-json [9]. > let g:vim_markdown_json_frontmatter = 1 < +------------------------------------------------------------------------------- + *vim-markdown-strikethrough* +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 ~