X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c1b9f4adadea1548b54373e951950ca2d6c7aa92..c6d7597da30f776206b64d6bbd98cdf914c090b2:/README.md?ds=sidebyside diff --git a/README.md b/README.md index f5cbaf9..0d03b34 100644 --- a/README.md +++ b/README.md @@ -134,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. @@ -147,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. @@ -225,6 +235,24 @@ vim-markdown automatically insert the indent. By default, the number of spaces o 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