Rename custom checkbox fields to be more consistent with rest of plugin

# Details

- text -> raw
- icon -> rendered

Author: MeanderingProgrammer

README.md

@@ -174,7 +174,7 @@ require('render-markdown').setup({
         checked = '󰱒 ',
         -- Specify custom checkboxes, must be surrounded in square brackets
         custom = {
-            todo = { text = '[-]', icon = '󰥔 ', highlight = '@markup.raw' },
+            todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' },
         },
     },
     -- Character that will replace the > at the start of block quotes
@@ -311,15 +311,15 @@ is used to hide the character.
 The checked `[ ]` & unchecked `[x]` are directly replaced with these values.
 
 Additionally `custom` states can be specified, an example of this is provided
-with: `todo = { text = '[-]', icon = '󰥔 ', highlight = '@markup.raw' }`.
+with: `todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' }`.
 
 This requires neovim >= `0.10.0` since it relies on `inline` extmarks.
 
 The key in the `custom` table is unused. The parts of the value are:
 
-- `text`: matched against the raw text of a `shortcut_link`, in the same way as `callouts`
-- `icon`: replaces the `text` value when rendering
-- `highlight`: color used for `icon`
+- `raw`: matched against the raw text of a `shortcut_link`, in the same way as `callouts`
+- `rendered`: replaces the `raw` value when rendering
+- `highlight`: color used for `rendered` text
 
 ### quote
 

doc/render-markdown.txt

@@ -206,7 +206,7 @@ Full Default Configuration ~
             checked = '󰱒 ',
             -- Specify custom checkboxes, must be surrounded in square brackets
             custom = {
-                todo = { text = '[-]', icon = '󰥔 ', highlight = '@markup.raw' },
+                todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' },
             },
         },
         -- Character that will replace the > at the start of block quotes
@@ -348,15 +348,15 @@ CHECKBOX ~
 The checked `[ ]` & unchecked `[x]` are directly replaced with these values.
 
 Additionally `custom` states can be specified, an example of this is provided
-with: `todo = { text = '[-]', icon = '󰥔 ', highlight = '@markup.raw' }`.
+with: `todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' }`.
 
 This requires neovim >= `0.10.0` since it relies on `inline` extmarks.
 
 The key in the `custom` table is unused. The parts of the value are:
 
-- `text`: matched against the raw text of a `shortcut_link`, in the same way as `callouts`
-- `icon`: replaces the `text` value when rendering
-- `highlight`: color used for `icon`
+- `raw`: matched against the raw text of a `shortcut_link`, in the same way as `callouts`
+- `rendered`: replaces the `raw` value when rendering
+- `highlight`: color used for `rendered` text
 
 
 QUOTE ~

lua/render-markdown/custom_checkbox.lua

@@ -6,7 +6,7 @@ local M = {}
 ---@return render.md.CustomCheckbox?
 M.get_exact = function(value)
     for _, checkbox in pairs(state.config.checkbox.custom) do
-        if checkbox.text == value then
+        if checkbox.raw == value then
             return checkbox
         end
     end
@@ -17,7 +17,7 @@ end
 ---@return render.md.CustomCheckbox?
 M.get_starts = function(value)
     for _, checkbox in pairs(state.config.checkbox.custom) do
-        if vim.startswith(value, checkbox.text) then
+        if vim.startswith(value, checkbox.raw) then
             return checkbox
         end
     end

lua/render-markdown/handler/markdown_inline.lua

@@ -54,7 +54,7 @@ M.render_node = function(namespace, buf, capture, node)
                 return
             end
 
-            local checkbox_text = { str.pad_to(value, checkbox.icon), checkbox.highlight }
+            local checkbox_text = { str.pad_to(value, checkbox.rendered), checkbox.highlight }
             vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {
                 end_row = end_row,
                 end_col = end_col,

lua/render-markdown/init.lua

@@ -42,8 +42,8 @@ local M = {}
 ---@field public rendered any
 
 ---@class render.md.CustomCheckbox
----@field public text string
----@field public icon string
+---@field public raw string
+---@field public rendered string
 ---@field public highlight string
 
 ---@class render.md.UserCheckbox
@@ -152,7 +152,7 @@ M.default_config = {
         checked = '󰱒 ',
         -- Specify custom checkboxes, must be surrounded in square brackets
         custom = {
-            todo = { text = '[-]', icon = '󰥔 ', highlight = '@markup.raw' },
+            todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' },
         },
     },
     -- Character that will replace the > at the start of block quotes