X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0aef7317dc7a2c32b5d99a9bcc418ec62b47379f..46f2a724aee3b81b2c8463f4e3b08e5b8055bfb5:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index edd177b..e01ccc3 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.
@@ -161,6 +167,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 `<<my-section-title>>`.
+
+Default is `''`.
+
 ### Syntax extensions
 
 The following options control which syntax extensions will be turned on. They are off by default.
@@ -222,6 +259,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