X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e786f1a4b62fa10d748f38e03b706117feab63f1..1121250a35f56f42ede4ce3547fe20afead86dd8:/README.md diff --git a/README.md b/README.md index 8318f7d..ca7eef2 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,12 @@ 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. @@ -128,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. @@ -141,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. @@ -158,6 +174,37 @@ This will cause the following to be highlighted using the `cs` filetype syntax. 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 +`file#anchor` or just `#anchor`, where file may omit the `.md` extension as +usual. Two variables control its operation: + +```vim +let g:vim_markdown_follow_anchor = 1 +``` + +This tells vim-markdown whether to attempt to follow a named anchor in a link or +not. When it is 1, and only if a link can be split in two parts by the pattern +'#', then the first part is interpreted as the file and the second one as the +named anchor. This also includes urls of the form `#anchor`, for which the first +part is considered empty, meaning that the target file is the current one. After +the file is opened, the anchor will be searched. + +Default is `0`. + +```vim +let g:vim_markdown_anchorexpr = "'<<'.v:anchor.'>>'" +``` + +This expression will be evaluated substituting `v:anchor` with a quoted string +that contains the anchor to visit. The result of the evaluation will become the +real anchor to search in the target file. This is useful in order to convert +anchors of the form, say, `my-section-title` to searches of the form `My Section +Title` or `<>`. + +Default is `''`. + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. @@ -221,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 @@ -232,7 +279,7 @@ 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