X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/002a169bdbb4831885e027b37679f25b117b7fe8..1bdd9c799b74a6443c0c3875dedcd5f33d25772c:/doc/vim-markdown.txt diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt index 033a966..6e486de 100644 --- a/doc/vim-markdown.txt +++ b/doc/vim-markdown.txt @@ -11,8 +11,11 @@ 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| @@ -122,6 +125,16 @@ 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 ~ @@ -130,10 +143,33 @@ Concealing is set for some syntax. For example, conceal '[link text](link url)' as just 'link text'. -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 ~ @@ -172,6 +208,8 @@ TOML syntax highlight requires vim-toml [8]. 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 < @@ -260,9 +298,9 @@ The following requires ':filetype plugin on'. range. *:TableFormat* -- ':TableFormat': Format the table under the cursor like this [9]. +- ':TableFormat': Format the table under the cursor like this [10]. - Requires Tabular [10]. + 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 @@ -282,7 +320,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* @@ -291,7 +329,7 @@ Credits ~ The main contributors of vim-markdown are: - **Ben Williams** (A.K.A. **plasticboy**). The original developer of vim- - markdown. Homepage [11]. + markdown. Homepage [12]. If you feel that your name should be on this list, please make a pull request listing your contributions. @@ -334,8 +372,9 @@ References ~ [6] https://github.com/klen/python-mode [7] https://gohugo.io/content/front-matter/ [8] https://github.com/cespare/vim-toml -[9] http://www.cirosantilli.com/markdown-style-guide/#tables -[10] https://github.com/godlygeek/tabular -[11] http://plasticboy.com/ +[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