X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/9eba84a2efd76cf209391cf47c2ebaab5a369efc..0e153a2d2bbec90e383dcea8cbcf3d3449ec08fa:/README.md diff --git a/README.md b/README.md index 014c54e..c626e0a 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,21 @@ 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. + +To prevent foldtext from being set add the following to your `.vimrc`: + +```vim +let g:vim_markdown_override_foldtext = 0 +``` + ### Set header folding level Folding level is a number between 1 and 6. By default, if not specified, it is set to 1. @@ -126,6 +134,9 @@ let g:vim_markdown_emphasis_multiline = 0 Concealing is set for some syntax. For example, conceal `[link text](link url)` as just `link text`. +Also, `_italic_` and `*italic*` will conceal to just _italic_. +Similarly `__bold__`, `**bold**`, `___italic bold___`, and `***italic bold***` +will conceal to just __bold__, **bold**, ___italic bold___, and ***italic bold*** respectively. To enable conceal use Vim's standard conceal configuration. @@ -133,12 +144,29 @@ 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': +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. @@ -179,6 +207,46 @@ 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 +``` + +### 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 editing in vim using the "ge" command, but have it open the file "link-url.md" instead of the file "link-url", then use this option: + +```vim +let g:vim_markdown_no_extensions_in_markdown = 1 +``` +This is super useful for GitLab and GitHub wiki repositories. + +Normal behaviour would be that vim-markup required you to do this `[link text](link-url.md)`, but this is not how the Gitlab and GitHub wiki repositories work. So this option adds some consistency between the two. + +### Auto-write when following link + +If you follow a link like this `[link text](link-url)` using the "ge" shortcut, this option will automatically save any edits you made before moving you: + +```vim +let g:vim_markdown_autowrite = 1 +``` + ## Mappings The following work on normal and visual modes: @@ -199,6 +267,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`