Neorg latex-support

[nolbap]

Hi, I'm trying to add latex-rendering to neorg, rewriting the neorg branch from the same name using this plugin, I was able to render the images but as I'm not too familiar with the plugin I have a few questions I hope you could answer :)

core/integrations/image/module.lua

local neorg = require("neorg.core")
local module = neorg.modules.create("core.integrations.image")

module.load = function()
	local success, image = pcall(require, "image")

	assert(success, "Unable to loade image.nvim module")

	module.private.image = image
end

module.private = {
	image = nil,
}

module.public = {
	render = function(buffernr, png_path, position)
        local geometry =
        {
            x = position.column_start + vim.opt.numberwidth:get(),
            y = position.row_start+1,
            width = position.column_end - position.column_start,
            height = 1,
        }
		local image = require("image").from_file(png_path, {
			buffer = buffernr,
            with_virtual_padding = true,
		})
		image:render(geometry) --geometry)
	end,
}

return module
-- local renderer = neorg.modules.get_module(module.core.integrations.image)

core/latex/renderer/module.lua

local neorg = require("neorg.core")
local module = neorg.modules.create("core.latex.renderer")

module.setup = function()
    return {
        requires = { "core.integrations.treesitter" },
    }
end

module.load = function()
    vim.api.nvim_create_autocmd("BufWinEnter", {
        pattern = "*.norg",
        callback = function(event)
            module.required["core.integrations.treesitter"].execute_query(
                [[
                (
                    (inline_math) @latex
                    (#offset! @latex 0 1 0 -1)
                )

                ; NOTE: We don't look for `@code` blocks here because those should be just that - code blocks, not rendered latex markup.
                (ranged_verbatim_tag (tag_name) @_tagname (tag_parameters .(tag_param) @_language) (ranged_verbatim_tag_content) @latex (#eq? @_tagname "embed") (#eq? @_language "latex"))
                (ranged_verbatim_tag (tag_name) @_tagname (tag_parameters)? (ranged_verbatim_tag_content) @latex (#eq? @_tagname "math"))
            ]],
                function(query, id, node)
                    if query.captures[id] ~= "latex" then
                        return
                    end

                    local latex_snippet = module.required["core.integrations.treesitter"].get_node_text(node, event.buf)

                    local png_location = module.public.parse_latex(latex_snippet)

                    local renderer = neorg.modules.get_module(module.config.public.renderer)

                    if not renderer then
                        return
                    end

                    renderer.render(
                        event.buf,
                        png_location,
                        module.required["core.integrations.treesitter"].get_node_range(node)
                    )
                end,
                event.buf
            )
        end,
    })
end

module.public = {
    create_latex_document = function(snippet)
        local tempname = vim.fn.tempname()

        local tempfile = io.open(tempname, "w")

        if not tempfile then
            return
        end

        local content = table.concat({
            "\\documentclass[6pt]{standalone}",
            "\\usepackage{amsmath}",
            "\\usepackage{amssymb}",
            "\\usepackage{graphicx}",
            "\\begin{document}",
            snippet,
            "\\end{document}",
            }, "\n")

        tempfile:write(content)
        tempfile:close()

        return tempname
    end,

    -- Returns a handle to an image containing
    -- the rendered snippet.
    -- This handle can then be delegated to an external renderer.
    parse_latex = function(snippet)
        local document_name = module.public.create_latex_document(snippet)

        if not document_name then
            return
        end

        local cwd = vim.fn.fnamemodify(document_name, ":h")
        vim.fn.jobwait({
            vim.fn.jobstart(
                "latex  --interaction=nonstopmode --output-dir=" .. cwd .. " --output-format=dvi " .. document_name,
            { cwd = cwd }
            ),
        })

        local png_result = vim.fn.tempname()
        -- TODO: Make the conversions async via `on_exit`
        vim.fn.jobwait({
            vim.fn.jobstart(
                "dvipng -D "
                .. tostring(module.config.public.dpi)
                .. " -T tight -bg Transparent -fg 'cmyk 0.00 0.04 0.21 0.02' -o "
                .. png_result
                .. " "
                .. document_name
                .. ".dvi",
                { cwd = vim.fn.fnamemodify(document_name, ":h") }
            ),
        })

        return png_result
    end,
}

module.config.public = {
    -- TODO: Documentation
    renderer = "core.integrations.image",
    dpi = 350,
}

return module

The first file just creates a module with a render function using image.nvim and the second one makes a latex image using the snippet in inline math and renders it.

showcase.mp4

Now, how can I make the images stay in place on the file and that the renderer takes into account the virtual lines from other latex snippets. I'd very much appreciate your help :)

[3rd]

Hey! It handles all that for you if you pass the window as well when you do require("image").from_file(png_path,...

[nolbap]

Thanks, I may have had a bit of tunnel vision when reading the documentation 😅.
If anyone is interested on neorg Latex rendering I made a fork you are welcome to check out :). Ill make the commits to fix these issues asap.

[3rd]

Your plugin looks great, love it!
Do the .image images still work? Never tried mixing the "internal" integration with external code.
I'm also working on adding support for on-demand generated images (starting with mermaid diagrams in Markdown) for the document integrations and toggleable through the default options, it's a great use-case!

[nolbap]

It works nicely with your integration only when the LaTex its rendered after the other images, at first, as you can see here, I was rendering the images on BufWinEnter and the LaTex was overwritten by image.nvim trying to also load the images. But yeah it's great, I really like it :)