feat: configurable footnote prefix & suffix

## Details

Request: #241

Rather than surrounding footnotes in parenthesis by default the prefix
and suffix are now configurable properties. The default behavior has
changed in that nothing is added by default. To get the previous behavior
users can set the following:

```lua
require('render-markdown').setup({
    link = {
        footnote = { prefix = '(', suffix = ')' },
    },
})
```

Author: MeanderingProgrammer

README.md

@@ -511,6 +511,10 @@ require('render-markdown').setup({
         footnote = {
             -- Replace value with superscript equivalent
             superscript = true,
+            -- Added before link content when converting to superscript
+            prefix = '',
+            -- Added after link content when converting to superscript
+            suffix = '',
         },
         -- Inlined with 'image' elements
         image = '󰥶 ',
@@ -1059,6 +1063,10 @@ require('render-markdown').setup({
         footnote = {
             -- Replace value with superscript equivalent
             superscript = true,
+            -- Added before link content when converting to superscript
+            prefix = '',
+            -- Added after link content when converting to superscript
+            suffix = '',
         },
         -- Inlined with 'image' elements
         image = '󰥶 ',

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0         Last change: 2024 November 27
+*render-markdown.txt*         For 0.10.0         Last change: 2024 November 30
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -558,6 +558,10 @@ Default Configuration ~
             footnote = {
                 -- Replace value with superscript equivalent
                 superscript = true,
+                -- Added before link content when converting to superscript
+                prefix = '',
+                -- Added after link content when converting to superscript
+                suffix = '',
             },
             -- Inlined with 'image' elements
             image = '󰥶 ',
@@ -1086,6 +1090,10 @@ Link Configuration ~
             footnote = {
                 -- Replace value with superscript equivalent
                 superscript = true,
+                -- Added before link content when converting to superscript
+                prefix = '',
+                -- Added after link content when converting to superscript
+                suffix = '',
             },
             -- Inlined with 'image' elements
             image = '󰥶 ',

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.6.2'
+M.version = '7.6.3'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -56,6 +56,8 @@ local M = {}
 
 ---@class (exact) render.md.UserFootnote
 ---@field public superscript? boolean
+---@field public prefix? string
+---@field public suffix? string
 
 ---@class (exact) render.md.UserLink
 ---@field public enabled? boolean
@@ -633,6 +635,10 @@ M.default_config = {
         footnote = {
             -- Replace value with superscript equivalent
             superscript = true,
+            -- Added before link content when converting to superscript
+            prefix = '',
+            -- Added after link content when converting to superscript
+            suffix = '',
         },
         -- Inlined with 'image' elements
         image = '󰥶 ',

lua/render-markdown/render/shortcut.lua

@@ -115,11 +115,12 @@ end
 ---@private
 ---@param text string
 function Render:footnote(text)
-    if not self.link.enabled or not self.link.footnote.superscript then
+    local footnote = self.link.footnote
+    if not self.link.enabled or not footnote.superscript then
         return
     end
 
-    local value = Converter.to_superscript('(' .. text .. ')')
+    local value = Converter.to_superscript(footnote.prefix .. text .. footnote.suffix)
     if value == nil then
         return
     end

lua/render-markdown/state.lua

@@ -235,7 +235,7 @@ function M.validate()
                 link:type('enabled', 'boolean')
                     :type({ 'image', 'email', 'hyperlink', 'highlight' }, 'string')
                     :nested('footnote', function(footnote)
-                        footnote:type('superscript', 'boolean'):check()
+                        footnote:type('superscript', 'boolean'):type({ 'prefix', 'suffix' }, 'string'):check()
                     end)
                     :nested('wiki', function(wiki)
                         wiki:type({ 'icon', 'highlight' }, 'string'):check()

lua/render-markdown/types.lua

@@ -43,6 +43,8 @@
 
 ---@class (exact) render.md.Footnote
 ---@field public superscript boolean
+---@field public prefix string
+---@field public suffix string
 
 ---@class (exact) render.md.Link
 ---@field public enabled boolean

tests/ad_hoc_spec.lua

@@ -87,8 +87,8 @@ describe('ad_hoc.md', function()
 
         vim.list_extend(expected, {
             util.bullet(row:increment(), 0, 1),
-            link(row:get(), 16, 25, '⁽¹ ᴵⁿᶠᵒ⁾', 'Link', ''),
-            link(row:increment(2), 0, 9, '⁽¹ ᴵⁿᶠᵒ⁾', 'Link', ''),
+            link(row:get(), 16, 25, '¹ ᴵⁿᶠᵒ', 'Link', ''),
+            link(row:increment(2), 0, 9, '¹ ᴵⁿᶠᵒ', 'Link', ''),
         })
 
         util.assert_view(expected, {
@@ -103,9 +103,9 @@ describe('ad_hoc.md', function()
             '    9 ● 󱗖 With Alias Something important',
             '   10 ● 󰀓 [email protected] Email',
             '   11 ●  Youtube Link',
-            '   12 ● Footnote Link ⁽¹ ᴵⁿᶠᵒ⁾',
+            '   12 ● Footnote Link ¹ ᴵⁿᶠᵒ',
             '   13',
-            '   14 ⁽¹ ᴵⁿᶠᵒ⁾: Some Info',
+            '   14 ¹ ᴵⁿᶠᵒ: Some Info',
         })
     end)
 end)