X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8b54e061e105fba060d6c24c0a05679c2f951810..6f9e18335e17bca5fbf05974b4ccbe1759e66891:/README.md?ds=sidebyside diff --git a/README.md b/README.md index b3681a5..9c6665e 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,15 @@ set [no]foldenable ### Change fold style -To fold in a style like [python-mode](https://github.com/klen/python-mode), add -the following to your `.vimrc`: +To fold in a style like [python-mode](https://github.com/klen/python-mode), add the following to your `.vimrc`: ```vim 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. + ### Set header folding level Folding level is a number between 1 and 6. By default, if not specified, it is set to 1. @@ -127,12 +129,35 @@ Concealing is set for some syntax. For example, conceal `[link text](link url)` as just `link text`. -To disable conceal, add the following to your '.vimrc': +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. @@ -173,6 +198,28 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json). 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: @@ -193,6 +240,10 @@ The following work on normal and visual modes: Known limitation: does not work for links that span multiple lines. +- `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. + - `]]`: go to next header. `Markdown_MoveToNextHeader` - `[[`: go to previous header. Contrast with `]c`. `Markdown_MoveToPreviousHeader`