chore(docs): more details about rename for tokyonight & rocks.nvim

Author: MeanderingProgrammer

README.md

@@ -4,8 +4,27 @@ Plugin to improve viewing Markdown files in Neovim
 
 > [!NOTE]
 >
-> Repo has been renamed from `markdown.nvim` to make things less confusing and
-> more consistent. Github should redirect all requests so nothing should break.
+> Repo has been renamed from `markdown.nvim` to make things more consistent.
+>
+> Github will redirect all requests so nothing should break for most users.
+>
+> For `lazy.nvim` & `tokyonight.nvim` users changing the plugin name will remove
+> custom highlights until the following is merged [#620](https://github.com/folke/tokyonight.nvim/pull/620).
+>
+> In the meantime you can fix this by adding the following to your config:
+>
+> ```lua
+> require('tokyonight').setup({
+>     plugins = { markdown = true },
+> })
+> ```
+>
+> For `rocks.nvim` users migrate to the new [LuaRock](https://luarocks.org/modules/MeanderingProgrammer/render-markdown.nvim).
+>
+> ```vim
+> :Rocks prune markdown.nvim
+> :Rocks install render-markdown.nvim
+> ```
 
 <!-- panvimdoc-ignore-start -->
 

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0          Last change: 2024 August 05
+*render-markdown.txt*          For 0.10.0          Last change: 2024 August 06
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -36,8 +36,23 @@ Plugin to improve viewing Markdown files in Neovim
 
 
   [!NOTE]
-  Repo has been renamed from `markdown.nvim` to make things less confusing and
-  more consistent. Github should redirect all requests so nothing should break.
+  Repo has been renamed from `markdown.nvim` to make things more consistent.
+  Github will redirect all requests so nothing should break for most users.
+  For `lazy.nvim` & `tokyonight.nvim` users changing the plugin name will remove
+  custom highlights until the following is merged #620
+  <https://github.com/folke/tokyonight.nvim/pull/620>.
+  In the meantime you can fix this by adding the following to your config:
+  >lua
+      require('tokyonight').setup({
+          plugins = { markdown = true },
+      })
+  <
+  For `rocks.nvim` users migrate to the new LuaRock
+  <https://luarocks.org/modules/MeanderingProgrammer/render-markdown.nvim>.
+  >vim
+      :Rocks prune markdown.nvim
+      :Rocks install render-markdown.nvim
+  <
 
 ==============================================================================
 2. Features                                         *render-markdown-features*

lua/render-markdown/handler/latex.lua

@@ -1,3 +1,4 @@
+local list = require('render-markdown.list')
 local logger = require('render-markdown.logger')
 local state = require('render-markdown.state')
 local str = require('render-markdown.str')
@@ -42,20 +43,14 @@ function M.parse(root, buf)
         return { { expression, latex.highlight } }
     end, expressions)
 
-    ---@type render.md.Mark
-    local latex_mark = {
-        conceal = false,
-        start_row = info.start_row,
-        start_col = info.start_col,
-        opts = {
-            end_row = info.end_row,
-            end_col = info.end_col,
-            virt_lines = latex_lines,
-            virt_lines_above = true,
-        },
-    }
-    logger.debug('mark', latex_mark)
-    return { latex_mark }
+    local marks = {}
+    list.add_mark(marks, false, info.start_row, info.start_col, {
+        end_row = info.end_row,
+        end_col = info.end_col,
+        virt_lines = latex_lines,
+        virt_lines_above = true,
+    })
+    return marks
 end
 
 return M

lua/render-markdown/handler/markdown.lua

@@ -9,7 +9,6 @@ local pipe_table_parser = require('render-markdown.parser.pipe_table')
 local state = require('render-markdown.state')
 local str = require('render-markdown.str')
 local ts = require('render-markdown.ts')
-local util = require('render-markdown.util')
 
 ---@class render.md.handler.buf.Markdown
 ---@field private buf integer
@@ -72,20 +71,7 @@ end
 ---@param opts vim.api.keyset.set_extmark
 ---@return boolean
 function Handler:add(conceal, start_row, start_col, opts)
-    -- Inline extmarks require neovim >= 0.10.0
-    if opts.virt_text_pos == 'inline' and not util.has_10 then
-        return false
-    end
-    ---@type render.md.Mark
-    local mark = {
-        conceal = conceal,
-        start_row = start_row,
-        start_col = start_col,
-        opts = opts,
-    }
-    logger.debug('mark', mark)
-    table.insert(self.marks, mark)
-    return true
+    return list.add_mark(self.marks, conceal, start_row, start_col, opts)
 end
 
 ---@private

lua/render-markdown/handler/markdown_inline.lua

@@ -1,10 +1,10 @@
 local component = require('render-markdown.component')
 local context = require('render-markdown.context')
+local list = require('render-markdown.list')
 local logger = require('render-markdown.logger')
 local state = require('render-markdown.state')
 local str = require('render-markdown.str')
 local ts = require('render-markdown.ts')
-local util = require('render-markdown.util')
 
 ---@class render.md.handler.buf.MarkdownInline
 ---@field private buf integer
@@ -48,20 +48,7 @@ end
 ---@param opts vim.api.keyset.set_extmark
 ---@return boolean
 function Handler:add(start_row, start_col, opts)
-    -- Inline extmarks require neovim >= 0.10.0
-    if opts.virt_text_pos == 'inline' and not util.has_10 then
-        return false
-    end
-    ---@type render.md.Mark
-    local mark = {
-        conceal = true,
-        start_row = start_row,
-        start_col = start_col,
-        opts = opts,
-    }
-    logger.debug('mark', mark)
-    table.insert(self.marks, mark)
-    return true
+    return list.add_mark(self.marks, true, start_row, start_col, opts)
 end
 
 ---@private

lua/render-markdown/list.lua

@@ -1,6 +1,32 @@
+local logger = require('render-markdown.logger')
+local util = require('render-markdown.util')
+
 ---@class render.md.ListHelper
 local M = {}
 
+---@param marks render.md.Mark[]
+---@param conceal boolean
+---@param start_row integer
+---@param start_col integer
+---@param opts vim.api.keyset.set_extmark
+---@return boolean
+function M.add_mark(marks, conceal, start_row, start_col, opts)
+    -- Inline extmarks require neovim >= 0.10.0
+    if opts.virt_text_pos == 'inline' and not util.has_10 then
+        return false
+    end
+    ---@type render.md.Mark
+    local mark = {
+        conceal = conceal,
+        start_row = start_row,
+        start_col = start_col,
+        opts = opts,
+    }
+    logger.debug('mark', mark)
+    table.insert(marks, mark)
+    return true
+end
+
 ---@param values string[]
 ---@param index integer
 ---@return string?