Add a test for mkdLink #319

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 17c97b9f901bbec0b959388b4aa5a2b62112fe02..c626e0a7eab3cbb969f461e01d6c242af78e521c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -228,6 +228,24 @@ vim-markdown automatically insert the indent. By default, the number of spaces o
 let g:vim_markdown_new_list_item_indent = 2
 ```
 
 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
 
 
 ## Mappings