feat: latex position below

## Details

Request: #347

Adds `position` option to `latex` configuration which supports 2 values,
`above` or `below`. The default value is set to `above` and results in
no change in behavior from before.

Setting it `below` will instead render the virtual lines below the block
but otherwise they are rendered in the same way.

```lua
require('render-markdown').setup({
    latex = { position = 'below' },
})
```

Author: MeanderingProgrammer

CHANGELOG.md

@@ -8,6 +8,8 @@
   [5c2440d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/5c2440d932a4ba96840e5ce5a7bd40f0624bdaa2)
 - allow html tags to be replaced with icons [#336](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/336)
   [6d446de](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/6d446de33937633bc2104f45c943f4fae632b822)
+- `autocommand` events and wiki link `body` customization [#228](https://github.com/MeanderingProgrammer/render-markdown.nvim/discussions/228)
+  [#345](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/345) [0df6719](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0df6719abc3b547bc5b7111a750d8d7e035a7234)
 - use default `render_modes = true` (all) for LSP docs [#326](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/326)
   [17a7746](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/17a77463f945c4b9e4f371c752efd90e3e1bf604)
 - update troubleshooting doc [f6c9e18](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/f6c9e1841cf644a258eb037dae587e3cf407d696)
@@ -21,6 +23,7 @@
 ### Collaborator Shoutouts
 
 - @dsully
+- @mcDevnagh
 
 ## 8.0.0 (2025-02-06)
 

README.md

@@ -246,6 +246,10 @@ require('render-markdown').setup({
         converter = 'latex2text',
         -- Highlight for LaTeX blocks
         highlight = 'RenderMarkdownMath',
+        -- Determines where latex formula is rendered relative to block:
+        --  above: above latex block
+        --  below: below latex block
+        position = 'above',
         -- Amount of empty lines above LaTeX blocks
         top_pad = 0,
         -- Amount of empty lines below LaTeX blocks

doc/render-markdown.txt

@@ -307,6 +307,10 @@ Default Configuration ~
             converter = 'latex2text',
             -- Highlight for LaTeX blocks
             highlight = 'RenderMarkdownMath',
+            -- Determines where latex formula is rendered relative to block:
+            --  above: above latex block
+            --  below: below latex block
+            position = 'above',
             -- Amount of empty lines above LaTeX blocks
             top_pad = 0,
             -- Amount of empty lines below LaTeX blocks

lua/render-markdown/handler/latex.lua

@@ -52,10 +52,13 @@ function M.parse(ctx)
         return { { expression, latex.highlight } }
     end)
 
+    local above = latex.position == 'above'
+    local row = above and node.start_row or node.end_row
+
     local marks = List.new_marks(ctx.buf, true)
-    marks:add_over(false, node, {
+    marks:add(false, row, 0, {
         virt_lines = latex_lines,
-        virt_lines_above = true,
+        virt_lines_above = above,
     })
     return marks:get()
 end

lua/render-markdown/health.lua

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

lua/render-markdown/init.lua

@@ -49,9 +49,12 @@ local M = {}
 ---@field public comment? render.md.UserHtmlComment
 ---@field public tag? table<string, render.md.HtmlTag>
 
+---@alias render.md.latex.Position 'above'|'below'
+
 ---@class (exact) render.md.UserLatex: render.md.UserBaseComponent
 ---@field public converter? string
 ---@field public highlight? string
+---@field public position? render.md.latex.Position
 ---@field public top_pad? integer
 ---@field public bottom_pad? integer
 
@@ -377,6 +380,10 @@ M.default_config = {
         converter = 'latex2text',
         -- Highlight for LaTeX blocks
         highlight = 'RenderMarkdownMath',
+        -- Determines where latex formula is rendered relative to block:
+        --  above: above latex block
+        --  below: below latex block
+        position = 'above',
         -- Amount of empty lines above LaTeX blocks
         top_pad = 0,
         -- Amount of empty lines below LaTeX blocks

lua/render-markdown/state.lua

@@ -291,6 +291,7 @@ function M.validate()
                 component_rules(latex)
                     :type({ 'top_pad', 'bottom_pad' }, 'number')
                     :type({ 'converter', 'highlight' }, 'string')
+                    :one_of('position', { 'above', 'below' })
                     :check()
             end)
             :nested('html', function(html)

lua/render-markdown/types.lua

@@ -28,6 +28,7 @@
 ---@class (exact) render.md.Latex: render.md.BaseComponent
 ---@field public converter string
 ---@field public highlight string
+---@field public position render.md.latex.Position
 ---@field public top_pad integer
 ---@field public bottom_pad integer
 

tests/latex_spec.lua

@@ -3,51 +3,67 @@
 local stub = require('luassert.stub')
 local util = require('tests.util')
 
----@param start_row integer
----@param end_row integer
----@param col integer
+---@param converter string
+---@param responses table<string, string>
+local function set_responses(converter, responses)
+    stub.new(vim.fn, 'executable', function(expr)
+        assert.are.same(converter, expr)
+        return 1
+    end)
+    stub.new(vim.fn, 'system', function(cmd, input)
+        assert.are.same(converter, cmd)
+        local result = responses[input]
+        assert.truthy(result, 'No output for: ' .. input)
+        return result
+    end)
+end
+
+---@param row integer
 ---@param lines string[]
 ---@return render.md.MarkInfo
-local function latex(start_row, end_row, col, lines)
+local function latex(row, lines)
     local virt_lines = vim.iter(lines)
         :map(function(line)
             return { { line, util.hl('Math') } }
         end)
         :totable()
     ---@type render.md.MarkInfo
     return {
-        row = { start_row, end_row },
-        col = { 0, col },
+        row = { row },
+        col = { 0 },
         virt_lines = virt_lines,
         virt_lines_above = true,
     }
 end
 
----@param converter string
----@param responses table<string, string>
-local function set_responses(converter, responses)
-    stub.new(vim.fn, 'executable', function(expr)
-        assert.are.same(converter, expr)
-        return 1
-    end)
-    stub.new(vim.fn, 'system', function(cmd, input)
-        assert.are.same(converter, cmd)
-        local result = responses[input]
-        assert.truthy(result, 'No output for: ' .. input)
-        return result
-    end)
+---@param lines string[]
+---@param prefix string
+---@param suffix string
+---@return string
+local function text(lines, prefix, suffix)
+    return prefix .. table.concat(lines, '\n') .. suffix
 end
 
 describe('latex.md', function()
     it('default', function()
-        local in_inline = '$\\sqrt{3x-1}+(1+x)^2$'
-        local out_inline = '√(3x-1)+(1+x)^2'
-        local in_block = { 'f(x,y) = x + \\sqrt{y}', 'f(x,y) = \\sqrt{y} + \\frac{x^2}{4y}' }
-        local out_block = { '    f(x,y) = x + √(y)', '    f(x,y) = √(y) + x^2/4y' }
+        local inline = {
+            raw = { '$\\sqrt{3x-1}+(1+x)^2$' },
+            out = { '√(3x-1)+(1+x)^2' },
+        }
+        local block = {
+            raw = {
+                'f(x,y) = x + \\sqrt{y}',
+                'f(x,y) = \\sqrt{y} + \\frac{x^2}{4y}',
+            },
+            out = {
+                '    f(x,y) = x + √(y)',
+                '    f(x,y) = √(y) + x^2/4y',
+            },
+        }
 
         set_responses('latex2text', {
-            [in_inline] = out_inline .. '\n',
-            ['$$\n' .. table.concat(in_block, '\n') .. '\n$$'] = '\n' .. table.concat(out_block, '\n') .. '\n\n',
+            [text(inline.raw, '', '')] = text(inline.out, '', '\n'),
+            [text(block.raw, '$$\n', '\n$$')] = text(block.out, '\n', '\n\n'),
         })
         util.setup('demo/latex.md')
 
@@ -56,21 +72,21 @@ describe('latex.md', function()
         vim.list_extend(expected, util.heading(row:get(), 1))
 
         vim.list_extend(expected, {
-            latex(row:increment(2), 2, 21, { out_inline }),
-            latex(row:increment(2), 7, 2, out_block),
+            latex(row:increment(2), inline.out),
+            latex(row:increment(2), block.out),
         })
 
         util.assert_view(expected, {
             '󰫎   1 󰲡 LaTeX',
             '    2',
-            '      ' .. out_inline,
-            '    3 ' .. in_inline,
+            '      ' .. inline.out[1],
+            '    3 ' .. inline.raw[1],
             '    4',
-            '      ' .. out_block[1],
-            '      ' .. out_block[2],
+            '      ' .. block.out[1],
+            '      ' .. block.out[2],
             '    5 $$',
-            '    6 ' .. in_block[1],
-            '    7 ' .. in_block[2],
+            '    6 ' .. block.raw[1],
+            '    7 ' .. block.raw[2],
             '    8 $$',
         })
     end)