X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/a3f273839d1b45fe73b3bc48e1d7a8c6d1422187..e07c336bca7861790e8bbc496bb7a47f489e0907:/README.md?ds=inline diff --git a/README.md b/README.md index 60c58ec..83e4847 100644 --- a/README.md +++ b/README.md @@ -113,18 +113,49 @@ It never increases its default size (half screen), it only shrinks. let g:vim_markdown_toc_autofit = 1 ``` +### 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: + +```vim +let g:vim_markdown_emphasis_multiline = 0 +``` + ### Syntax Concealing 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. ```vim set conceallevel=2 ``` +To disable conceal regardless of `conceallevel` setting, add the following to your `.vimrc`: + +```vim +let g:vim_markdown_conceal = 0 +``` + +### 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: + +```vim +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']`. + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. @@ -159,10 +190,34 @@ let g:vim_markdown_toml_frontmatter = 1 Highlight JSON front matter as used by [Hugo](https://gohugo.io/content/front-matter/). +JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json). + ```vim let g:vim_markdown_json_frontmatter = 1 ``` +### 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: + +```vim +let g:vim_markdown_new_list_item_indent = 2 +``` + + ## Mappings The following work on normal and visual modes: @@ -240,7 +295,7 @@ The following requires `:filetype plugin on`. - `:Toct`: Same as `:Toc` but in a new tab. -- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`. +- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `:Tocv`. ## Credits