feat: render wiki style links in yaml

## Details

Request: #496

Adds ability to render wiki style links in yaml, primarily for people that
use `obsidian` style metadata via `frontmatter`. Still requires user to
install `yaml` parser so we can query nodes. Currently only supports the
style that is enclosed in double quotes and double square brackets.

Values used for rendering are currently pulled from the same
configuration as `markdown` wiki link rendering, i.e. `link.wiki`.

The logic to do the rendering is pulled directly from the `markdown`
implementation, by refactoring a little both code points call the same
core logic to perform rendering. The inputs store slightly different
information so a bit more parsing is done on the text to compute various
offsets and text bounds, but seems to all work well!

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 15
+*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 17
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/handler/yaml.lua

@@ -12,11 +12,15 @@ function M.parse(ctx)
         'yaml',
         [[
             (block_sequence_item) @bullet
+
+            ((double_quote_scalar) @link
+                (#lua-match? @link "^\"%[%[.+%]%]\"$"))
         ]]
     )
     ---@type table<string, render.md.Render>
     local renders = {
         bullet = require('render-markdown.render.yaml.bullet'),
+        link = require('render-markdown.render.common.wiki'),
     }
     local context = Context.get(ctx.buf)
     if context:skip(context.config.yaml) then

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.7.4'
+M.version = '8.7.5'
 
 function M.check()
     M.start('versions')

lua/render-markdown/render/common/wiki.lua

@@ -0,0 +1,89 @@
+local Base = require('render-markdown.render.base')
+local str = require('render-markdown.lib.str')
+
+---@class render.md.render.common.Wiki: render.md.Render
+---@field private config render.md.link.wiki.Config
+local Render = setmetatable({}, Base)
+Render.__index = Render
+
+---@protected
+---@return boolean
+function Render:setup()
+    local config = self.context.config.link
+    if self.context:skip(config) then
+        return false
+    end
+    self.config = config.wiki
+    return true
+end
+
+---@protected
+function Render:run()
+    local _, _, pre, text, post = self.node.text:find('^(.-%[+)(.-)(%]+.-)$')
+    if not pre or not text or not post then
+        return -- not inside square brackets
+    end
+    if #pre ~= #post then
+        return -- pre and post are not balanced
+    end
+
+    local row = self.node.start_row
+    local start_col = self.node.start_col + #pre
+    local end_col = self.node.end_col - #pre
+    local destination, alias = unpack(str.split(text, '|', true))
+
+    -- hide opening & closing brackets
+    self:hide(start_col - 2, 2)
+    self:hide(end_col, 2)
+
+    ---@type render.md.mark.Text
+    local icon = { self.config.icon, self.config.highlight }
+    self.context.config:set_link_text(destination, icon)
+    local body = self.config.body({
+        buf = self.context.buf,
+        row = row,
+        start_col = start_col - 2,
+        end_col = end_col + 2,
+        destination = destination,
+        alias = alias,
+    })
+    if not body then
+        -- add icon
+        self.marks:add('link', row, start_col, {
+            hl_mode = 'combine',
+            virt_text = { icon },
+            virt_text_pos = 'inline',
+        })
+        -- hide destination if there is an alias
+        if alias then
+            self:hide(start_col, #destination + 1)
+        end
+    else
+        if type(body) == 'string' then
+            icon[1] = icon[1] .. body
+        else
+            icon[1] = icon[1] .. body[1]
+            icon[2] = body[2]
+        end
+        -- inline icon & body, hide original text
+        self.marks:add('link', row, start_col, {
+            end_col = end_col,
+            hl_mode = 'combine',
+            virt_text = { icon },
+            virt_text_pos = 'inline',
+            conceal = '',
+        })
+    end
+end
+
+---@private
+---@param col integer
+---@param length integer
+function Render:hide(col, length)
+    self.marks:add(true, self.node.start_row, col, {
+        end_col = col + length,
+        conceal = '',
+    })
+end
+
+return Render

lua/render-markdown/render/inline/shortcut.lua

@@ -1,6 +1,6 @@
 local Base = require('render-markdown.render.base')
+local Wiki = require('render-markdown.render.common.wiki')
 local converter = require('render-markdown.lib.converter')
-local str = require('render-markdown.lib.str')
 
 ---@class render.md.render.inline.Shortcut: render.md.Render
 ---@field private config render.md.link.Config
@@ -34,7 +34,7 @@ function Render:run()
     local _, line = self.node:line('first', 0)
     local wiki_pattern = '[' .. self.node.text .. ']'
     if line and line:find(wiki_pattern, 1, true) then
-        self:wiki_link()
+        Wiki:execute(self.context, self.marks, self.node)
         return
     end
     local _, _, text = self.node.text:find('^%[%^(.+)%]$')
@@ -44,64 +44,6 @@ function Render:run()
     end
 end
 
----@private
-function Render:wiki_link()
-    local config = self.config.wiki
-    local sections = str.split(self.node.text:sub(2, -2), '|', true)
-    ---@type render.md.link.Context
-    local ctx = {
-        buf = self.context.buf,
-        row = self.node.start_row,
-        start_col = self.node.start_col - 1,
-        end_col = self.node.end_col + 1,
-        destination = sections[1],
-        alias = sections[2],
-    }
-    -- hide opening & closing outer brackets
-    self:hide(ctx.start_col, 1)
-    self:hide(ctx.end_col - 1, 1)
-    ---@type render.md.mark.Text
-    local icon = { config.icon, config.highlight }
-    self.context.config:set_link_text(ctx.destination, icon)
-    local body = config.body(ctx)
-    if not body then
-        -- add icon
-        self.marks:start('link', self.node, {
-            hl_mode = 'combine',
-            virt_text = { icon },
-            virt_text_pos = 'inline',
-        })
-        -- hide destination if there is an alias
-        if #sections > 1 then
-            self:hide(ctx.start_col + 2, #ctx.destination + 1)
-        end
-    else
-        if type(body) == 'string' then
-            icon[1] = icon[1] .. body
-        else
-            icon[1] = icon[1] .. body[1]
-            icon[2] = body[2]
-        end
-        -- inline icon & body, hide original text
-        self.marks:over('link', self.node, {
-            hl_mode = 'combine',
-            virt_text = { icon },
-            virt_text_pos = 'inline',
-            conceal = '',
-        }, { 0, 1, 0, -1 })
-    end
-end
-
----@private
----@param col integer
----@param length integer
-function Render:hide(col, length)
-    self.marks:add(true, self.node.start_row, col, {
-        end_col = col + length,
-        conceal = '',
-    })
-end
-
 ---@private
 ---@param text string
 function Render:footnote(text)

tests/ad_hoc_spec.lua

@@ -50,28 +50,28 @@ describe('ad hoc', function()
     it('wikilink', function()
         util.setup.text({ '[[Basic One]] Then normal text' })
         local marks = util.marks()
-        marks:add({ 0, 0 }, { 0, 1 }, util.conceal())
-        marks:add(0, 1, util.link('wiki'))
-        marks:add({ 0, 0 }, { 12, 13 }, util.conceal())
+        marks:add({ 0, 0 }, { 0, 2 }, util.conceal())
+        marks:add(0, 2, util.link('wiki'))
+        marks:add({ 0, 0 }, { 11, 13 }, util.conceal())
         util.assert_view(marks, { '󱗖 Basic One Then normal text' })
     end)
 
     it('wikilink with alias', function()
         util.setup.text({ '[[Nickname|With Alias]] Something important' })
         local marks = util.marks()
-        marks:add({ 0, 0 }, { 0, 1 }, util.conceal())
-        marks:add(0, 1, util.link('wiki'))
+        marks:add({ 0, 0 }, { 0, 2 }, util.conceal())
+        marks:add(0, 2, util.link('wiki'))
         marks:add({ 0, 0 }, { 2, 11 }, util.conceal())
-        marks:add({ 0, 0 }, { 22, 23 }, util.conceal())
+        marks:add({ 0, 0 }, { 21, 23 }, util.conceal())
         util.assert_view(marks, { '󱗖 With Alias Something important' })
     end)
 
     it('wikilink media', function()
         util.setup.text({ '![[test.png]]' })
         local marks = util.marks()
-        marks:add({ 0, 0 }, { 1, 2 }, util.conceal())
-        marks:add(0, 2, util.link('wiki'))
-        marks:add({ 0, 0 }, { 12, 13 }, util.conceal())
+        marks:add({ 0, 0 }, { 1, 3 }, util.conceal())
+        marks:add(0, 3, util.link('wiki'))
+        marks:add({ 0, 0 }, { 11, 13 }, util.conceal())
         util.assert_view(marks, { '󱗖 test.png' })
     end)