Add support for block quotes > replacement

Author: MeanderingProgrammer

README.md

@@ -8,9 +8,11 @@ Plugin to improve viewing Markdown files in Neovim
 
 - Functions entirely inside of Neovim with no external windows
 - Changes between `rendered` view in normal mode and raw view in all other modes
+- Supports rendering `markdown` injected into other file types
 - Highlights headings with different groups depending on level and replaces `#`
 - Highlights code blocks to better stand out
 - Replaces whichever style bullet point is being used with provided character
+- Replaces block quote leading `>` with provided character
 - Updates table borders with better border characters, does NOT automatically align
 - Basic support for `LaTeX` if `pylatexenc` is installed on system
 
@@ -64,6 +66,9 @@ require('render-markdown').setup({
             (list_marker_star)
         ] @list_marker
 
+        (block_quote (block_quote_marker) @quote_marker)
+        (block_quote (paragraph (inline (block_continuation) @quote_marker)))
+
         (pipe_table_header) @table_head
         (pipe_table_delimiter_row) @table_delim
         (pipe_table_row) @table_row
@@ -73,15 +78,18 @@ require('render-markdown').setup({
     -- vim modes that will show a rendered view of the markdown file, all other
     -- modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
-    -- Characters that will replace the # at the start of markdown headings
+    -- Characters that will replace the # at the start of headings
     headings = { '󰲡', '󰲣', '󰲥', '󰲧', '󰲩', '󰲫' },
     -- Character to use for the bullet point in lists
     bullet = '○',
+    -- Character that will replace the > at the start of block quotes
+    quote = '┃',
+    -- Define the highlight groups to use when rendering various components
     highlights = {
         heading = {
-            -- Used for rendering heading line backgrounds
+            -- Background of heading line
             backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
-            -- Used for rendering the foreground of the heading character only
+            -- Foreground of heading character only
             foregrounds = {
                 'markdownH1',
                 'markdownH2',
@@ -91,18 +99,20 @@ require('render-markdown').setup({
                 'markdownH6',
             },
         },
-        -- Used when displaying code blocks
+        -- Code blocks
         code = 'ColorColumn',
-        -- Used when displaying bullet points in list
+        -- Bullet points in list
         bullet = 'Normal',
         table = {
-            -- Used when displaying header in a markdown table
+            -- Header of a markdown table
             head = '@markup.heading',
-            -- Used when displaying non header rows in a markdown table
+            -- Non header rows in a markdown table
             row = 'Normal',
         },
-        -- Used when displaying LaTeX
-        latex = 'Special',
+        -- LaTeX blocks
+        latex = '@markup.math',
+        -- Quote character in a block quote
+        quote = '@markup.quote',
     },
 })
 ```

demo/sample.md

@@ -30,6 +30,9 @@ if __name__ == "__main__":
 2. Item 2
 3. Item 3
 
+  > Quote line 1
+  > Quote line 2
+
 | Heading 1    | Heading 2    |
 | ------------ | ------------ |
 | Row 1 Item 1 | Row 1 Item 2 |

lua/render-markdown/init.lua

@@ -17,13 +17,15 @@ local M = {}
 ---@field public bullet? string
 ---@field public table? UserTableHighlights
 ---@field public latex? string
+---@field public quote? string
 
 ---@class UserConfig
 ---@field public markdown_query? string
 ---@field public file_types? string[]
 ---@field public render_modes? string[]
 ---@field public headings? string[]
 ---@field public bullet? string
+---@field public quote? string
 ---@field public highlights? UserHighlights
 
 ---@param opts UserConfig|nil
@@ -48,6 +50,9 @@ function M.setup(opts)
                 (list_marker_star)
             ] @list_marker
 
+            (block_quote (block_quote_marker) @quote_marker)
+            (block_quote (paragraph (inline (block_continuation) @quote_marker)))
+
             (pipe_table_header) @table_head
             (pipe_table_delimiter_row) @table_delim
             (pipe_table_row) @table_row
@@ -56,6 +61,7 @@ function M.setup(opts)
         render_modes = { 'n', 'c' },
         headings = { '󰲡', '󰲣', '󰲥', '󰲧', '󰲩', '󰲫' },
         bullet = '○',
+        quote = '┃',
         highlights = {
             heading = {
                 backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
@@ -74,7 +80,8 @@ function M.setup(opts)
                 head = '@markup.heading',
                 row = 'Normal',
             },
-            latex = 'Special',
+            latex = '@markup.math',
+            quote = '@markup.quote',
         },
     }
     state.enabled = true

lua/render-markdown/state.lua

@@ -12,13 +12,15 @@
 ---@field public bullet string
 ---@field public table TableHighlights
 ---@field public latex string
+---@field public quote string
 
 ---@class Config
 ---@field public markdown_query string
 ---@field public file_types string[]
 ---@field public render_modes string[]
 ---@field public headings string[]
 ---@field public bullet string
+---@field public quote string
 ---@field public highlights Highlights
 
 ---@class State

lua/render-markdown/ui.lua

@@ -76,6 +76,14 @@ M.markdown = function(root)
                 virt_text = { virt_text },
                 virt_text_pos = 'overlay',
             })
+        elseif capture == 'quote_marker' then
+            local virt_text = { value:gsub('>', state.config.quote), highlights.quote }
+            vim.api.nvim_buf_set_extmark(0, M.namespace, start_row, start_col, {
+                end_row = end_row,
+                end_col = end_col,
+                virt_text = { virt_text },
+                virt_text_pos = 'overlay',
+            })
         elseif vim.tbl_contains({ 'table_head', 'table_delim', 'table_row' }, capture) then
             local row = value:gsub('|', '│')
             if capture == 'table_delim' then