From 46f2a724aee3b81b2c8463f4e3b08e5b8055bfb5 Mon Sep 17 00:00:00 2001 From: memeplex Date: Wed, 27 Sep 2017 22:51:01 -0300 Subject: [PATCH] Add some documentation --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index c626e0a..e01ccc3 100644 --- a/README.md +++ b/README.md @@ -167,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 `<>`. + +Default is `''`. + ### Syntax extensions The following options control which syntax extensions will be turned on. They are off by default. -- 2.39.5