Add sign text for headings & code blocks

Author: MeanderingProgrammer

README.md

@@ -27,7 +27,7 @@ Plugin to improve viewing Markdown files in Neovim
   - Block quotes: replace leading `>` with provided icon
   - Tables: replace border characters, does NOT automatically align
   - [Callouts](https://github.com/orgs/community/discussions/16925)
-    - Base set as well as custom ones
+    - Github & Obsidian out of the box, supports user defined as well
   - Custom checkbox states, function similar to `callouts`
   - `LaTeX` blocks: renders formulas if `latex` parser and `pylatexenc` are installed
 - Disable rendering when file is larger than provided value
@@ -172,18 +172,21 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the array using a cycle
         -- The result is left padded with spaces to hide any additional '#'
         icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
+        -- Added to the sign column
+        -- The 'level' is used to index into the array using a cycle
+        signs = { '󰫎 ' },
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
         -- The 'level' is used to index into the array using a clamp
-        -- Highlight for the heading icon only
+        -- Highlight for the heading and sign icons
         foregrounds = { 'markdownH1', 'markdownH2', 'markdownH3', 'markdownH4', 'markdownH5', 'markdownH6' },
     },
     code = {
         -- Determines how code blocks & inline code are rendered:
         --  none: disables all rendering
         --  normal: adds highlight group to code blocks & inline code
-        --  language: adds language icon & name above code blocks
+        --  language: adds language icon to sign column and icon + name above code blocks
         --  full: normal + language
         style = 'full',
         -- Highlight for code blocks & inline code
@@ -326,11 +329,14 @@ require('render-markdown').setup({
         -- The 'level' is used to index into the array using a cycle
         -- The result is left padded with spaces to hide any additional '#'
         icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
+        -- Added to the sign column
+        -- The 'level' is used to index into the array using a cycle
+        signs = { '󰫎 ' },
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
         -- The 'level' is used to index into the array using a clamp
-        -- Highlight for the heading icon only
+        -- Highlight for the heading and sign icons
         foregrounds = { 'markdownH1', 'markdownH2', 'markdownH3', 'markdownH4', 'markdownH5', 'markdownH6' },
     },
 })
@@ -344,7 +350,7 @@ require('render-markdown').setup({
         -- Determines how code blocks & inline code are rendered:
         --  none: disables all rendering
         --  normal: adds highlight group to code blocks & inline code
-        --  language: adds language icon & name above code blocks
+        --  language: adds language icon to sign column and icon + name above code blocks
         --  full: normal + language
         style = 'full',
         -- Highlight for code blocks & inline code

demo/box_dash_quote.gif

@@ -54,7 +54,7 @@ Plugin to improve viewing Markdown files in Neovim
     - Block quotes: replace leading `>` with provided icon
     - Tables: replace border characters, does NOT automatically align
     - Callouts <https://github.com/orgs/community/discussions/16925>
-        - Base set as well as custom ones
+        - Github & Obsidian out of the box, supports user defined as well
     - Custom checkbox states, function similar to `callouts`
     - `LaTeX` blocks: renders formulas if `latex` parser and `pylatexenc` are installed
 - Disable rendering when file is larger than provided value
@@ -208,18 +208,21 @@ Full Default Configuration ~
             -- The 'level' is used to index into the array using a cycle
             -- The result is left padded with spaces to hide any additional '#'
             icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
+            -- Added to the sign column
+            -- The 'level' is used to index into the array using a cycle
+            signs = { '󰫎 ' },
             -- The 'level' is used to index into the array using a clamp
             -- Highlight for the heading icon and extends through the entire line
             backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
             -- The 'level' is used to index into the array using a clamp
-            -- Highlight for the heading icon only
+            -- Highlight for the heading and sign icons
             foregrounds = { 'markdownH1', 'markdownH2', 'markdownH3', 'markdownH4', 'markdownH5', 'markdownH6' },
         },
         code = {
             -- Determines how code blocks & inline code are rendered:
             --  none: disables all rendering
             --  normal: adds highlight group to code blocks & inline code
-            --  language: adds language icon & name above code blocks
+            --  language: adds language icon to sign column and icon + name above code blocks
             --  full: normal + language
             style = 'full',
             -- Highlight for code blocks & inline code
@@ -361,11 +364,14 @@ HEADINGS                                      *render-markdown-setup-headings*
             -- The 'level' is used to index into the array using a cycle
             -- The result is left padded with spaces to hide any additional '#'
             icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
+            -- Added to the sign column
+            -- The 'level' is used to index into the array using a cycle
+            signs = { '󰫎 ' },
             -- The 'level' is used to index into the array using a clamp
             -- Highlight for the heading icon and extends through the entire line
             backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
             -- The 'level' is used to index into the array using a clamp
-            -- Highlight for the heading icon only
+            -- Highlight for the heading and sign icons
             foregrounds = { 'markdownH1', 'markdownH2', 'markdownH3', 'markdownH4', 'markdownH5', 'markdownH6' },
         },
     })
@@ -380,7 +386,7 @@ CODE BLOCKS                                *render-markdown-setup-code-blocks*
             -- Determines how code blocks & inline code are rendered:
             --  none: disables all rendering
             --  normal: adds highlight group to code blocks & inline code
-            --  language: adds language icon & name above code blocks
+            --  language: adds language icon to sign column and icon + name above code blocks
             --  full: normal + language
             style = 'full',
             -- Highlight for code blocks & inline code

demo/callout.gif

@@ -48,6 +48,13 @@ M.render_node = function(namespace, buf, capture, node)
             virt_text_pos = 'overlay',
             hl_eol = true,
         })
+
+        vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+            end_row = end_row,
+            end_col = end_col,
+            sign_text = list.cycle(heading.signs, level),
+            sign_hl_group = foreground,
+        })
     elseif capture == 'dash' then
         local dash = state.config.dash
         local width = vim.api.nvim_win_get_width(util.buf_to_win(buf))
@@ -72,14 +79,20 @@ M.render_node = function(namespace, buf, capture, node)
         if not vim.tbl_contains({ 'language', 'full' }, code.style) then
             return
         end
-        -- Requires inline extmarks
-        if not util.has_10 then
-            return
-        end
         local icon, icon_highlight = icons.get(value)
         if icon == nil or icon_highlight == nil then
             return
         end
+        vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
+            end_row = end_row,
+            end_col = end_col,
+            sign_text = icon,
+            sign_hl_group = icon_highlight,
+        })
+        -- Requires inline extmarks
+        if not util.has_10 then
+            return
+        end
         local highlight = { icon_highlight }
         if code.style == 'full' then
             highlight = { icon_highlight, code.highlight }

demo/heading_code.gif

@@ -144,10 +144,12 @@ function M.check_config(config)
     local heading = config.heading
     append_errors('heading', {
         icons = { heading.icons, 'table' },
+        signs = { heading.signs, 'table' },
         backgrounds = { heading.backgrounds, 'table' },
         foregrounds = { heading.foregrounds, 'table' },
     })
     all_strings('heading.icons', heading.icons)
+    all_strings('heading.signs', heading.signs)
     all_strings('heading.backgrounds', heading.backgrounds)
     all_strings('heading.foregrounds', heading.foregrounds)
 

demo/latex.gif

@@ -42,6 +42,7 @@ local M = {}
 
 ---@class render.md.UserHeading
 ---@field public icons? string[]
+---@field public signs? string[]
 ---@field public backgrounds? string[]
 ---@field public foregrounds? string[]
 
@@ -145,18 +146,21 @@ M.default_config = {
         -- The 'level' is used to index into the array using a cycle
         -- The result is left padded with spaces to hide any additional '#'
         icons = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
+        -- Added to the sign column
+        -- The 'level' is used to index into the array using a cycle
+        signs = { '󰫎 ' },
         -- The 'level' is used to index into the array using a clamp
         -- Highlight for the heading icon and extends through the entire line
         backgrounds = { 'DiffAdd', 'DiffChange', 'DiffDelete' },
         -- The 'level' is used to index into the array using a clamp
-        -- Highlight for the heading icon only
+        -- Highlight for the heading and sign icons
         foregrounds = { 'markdownH1', 'markdownH2', 'markdownH3', 'markdownH4', 'markdownH5', 'markdownH6' },
     },
     code = {
         -- Determines how code blocks & inline code are rendered:
         --  none: disables all rendering
         --  normal: adds highlight group to code blocks & inline code
-        --  language: adds language icon & name above code blocks
+        --  language: adds language icon to sign column and icon + name above code blocks
         --  full: normal + language
         style = 'full',
         -- Highlight for code blocks & inline code