X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/46f2a724aee3b81b2c8463f4e3b08e5b8055bfb5..27fc5d94b1dce92c4ec48a390592c7f4f302070d:/README.md?ds=sidebyside diff --git a/README.md b/README.md index e01ccc3..bb26e05 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ 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: +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 (i.e., 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 @@ -150,6 +150,13 @@ To disable conceal regardless of `conceallevel` setting, add the following to yo let g:vim_markdown_conceal = 0 ``` +To disable math conceal with LaTeX math syntax enabled, add the following to your `.vimrc`: + +```vim +let g:tex_conceal = "" +let g:vim_markdown_math = 1 +``` + ### Fenced code block languages You can use filetype name as fenced code block languages for syntax highlighting. @@ -169,7 +176,7 @@ Default is `['c++=cpp', 'viml=vim', 'bash=sh', 'ini=dosini']`. ### Follow named anchors -This feature allows ge to follow named anchors in links of the form +This feature allows the `ge` command to follow named anchors in links of the form `file#anchor` or just `#anchor`, where file may omit the `.md` extension as usual. Two variables control its operation: @@ -261,7 +268,7 @@ 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: +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 @@ -272,12 +279,44 @@ Normal behaviour would be that vim-markup required you to do this `[link text](l ### 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: +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 ``` +### Change default file extension + +If you would like to use a file extension other than `.md` you may do so using the `vim_markdown_auto_extension_ext` variable: + +```vim +let g:vim_markdown_auto_extension_ext = 'txt' +``` + +### Do not automatically insert bulletpoints + +Automatically inserting bulletpoints can lead to problems when wrapping text +(see issue #232 for details), so it can be disabled: + +```vim +let g:vim_markdown_auto_insert_bullets = 0 +``` + +In that case, you probably also want to set the new list item indent to 0 as +well, or you will have to remove an indent each time you add a new list item: + +```vim +let g:vim_markdown_new_list_item_indent = 0 +``` + +### Change how to open new files + +By default when following a link the target file will be opened in your current buffer. This behavior can change if you prefer using splits or tabs by using the `vim_markdown_edit_url_in` variable. Possible values are `tab`, `vsplit`, `hsplit`, `current` opening in a new tab, vertical split, horizontal split, and current buffer respectively. Defaults to current buffer if not set: + +```vim +let g:vim_markdown_edit_url_in = 'tab' +``` + ## Mappings The following work on normal and visual modes: