feat: only use auto index when marker is 1

## Details

Request: #254

Previously auto indexing was added for ordered lists to generate the
number value based on the items position in the list. This works for
standard lists but sometimes users want to override the number based on
the value actually set. To support this the default value has been
updated to only use the auto value if the user value is <= 1. The icons
function now also takes a third parameter with the text value of the marker.

Author: MeanderingProgrammer

README.md

@@ -375,8 +375,10 @@ require('render-markdown').setup({
         -- If a function is provided both of these values are passed in using 1 based indexing
         -- If a list is provided we index into it using a cycle based on the level
         -- If the value at that level is also a list we further index into it using a clamp based on the index
-        ordered_icons = function(level, index)
-            return string.format('%d.', index)
+        ordered_icons = function(level, index, value)
+            value = vim.trim(value)
+            local value_index = tonumber(value:sub(1, #value - 1))
+            return string.format('%d.', value_index > 1 and value_index or index)
         end,
         -- Padding to add to the left of bullet point
         left_pad = 0,
@@ -878,8 +880,10 @@ require('render-markdown').setup({
         -- If a function is provided both of these values are passed in using 1 based indexing
         -- If a list is provided we index into it using a cycle based on the level
         -- If the value at that level is also a list we further index into it using a clamp based on the index
-        ordered_icons = function(level, index)
-            return string.format('%d.', index)
+        ordered_icons = function(level, index, value)
+            value = vim.trim(value)
+            local value_index = tonumber(value:sub(1, #value - 1))
+            return string.format('%d.', value_index > 1 and value_index or index)
         end,
         -- Padding to add to the left of bullet point
         left_pad = 0,

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0         Last change: 2024 December 06
+*render-markdown.txt*         For 0.10.0         Last change: 2024 December 07
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -422,8 +422,10 @@ Default Configuration ~
             -- If a function is provided both of these values are passed in using 1 based indexing
             -- If a list is provided we index into it using a cycle based on the level
             -- If the value at that level is also a list we further index into it using a clamp based on the index
-            ordered_icons = function(level, index)
-                return string.format('%d.', index)
+            ordered_icons = function(level, index, value)
+                value = vim.trim(value)
+                local value_index = tonumber(value:sub(1, #value - 1))
+                return string.format('%d.', value_index > 1 and value_index or index)
             end,
             -- Padding to add to the left of bullet point
             left_pad = 0,
@@ -915,8 +917,10 @@ Bullet Point Configuration ~
             -- If a function is provided both of these values are passed in using 1 based indexing
             -- If a list is provided we index into it using a cycle based on the level
             -- If the value at that level is also a list we further index into it using a clamp based on the index
-            ordered_icons = function(level, index)
-                return string.format('%d.', index)
+            ordered_icons = function(level, index, value)
+                value = vim.trim(value)
+                local value_index = tonumber(value:sub(1, #value - 1))
+                return string.format('%d.', value_index > 1 and value_index or index)
             end,
             -- Padding to add to the left of bullet point
             left_pad = 0,

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.6.12'
+M.version = '7.6.13'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -128,7 +128,10 @@ local M = {}
 ---@field public checked? render.md.UserCheckboxComponent
 ---@field public custom? table<string, render.md.UserCustomCheckbox>
 
----@alias render.md.bullet.Icons string[]|string[][]|fun(level: integer, index: integer): string?
+---@alias render.md.bullet.Icons
+---| string[]
+---| string[][]
+---| fun(level: integer, index: integer, value: string): string?
 
 ---@class (exact) render.md.UserBullet
 ---@field public enabled? boolean
@@ -510,8 +513,10 @@ M.default_config = {
         -- If a function is provided both of these values are passed in using 1 based indexing
         -- If a list is provided we index into it using a cycle based on the level
         -- If the value at that level is also a list we further index into it using a clamp based on the index
-        ordered_icons = function(level, index)
-            return string.format('%d.', index)
+        ordered_icons = function(level, index, value)
+            value = vim.trim(value)
+            local value_index = tonumber(value:sub(1, #value - 1))
+            return string.format('%d.', value_index > 1 and value_index or index)
         end,
         -- Padding to add to the left of bullet point
         left_pad = 0,

lua/render-markdown/render/list_item.lua

@@ -87,11 +87,12 @@ end
 ---@private
 ---@param level integer
 function Render:icon(level)
+    local node = self.data.marker
     local index = self.node:sibling_count('list_item')
     local icons = self.data.ordered and self.bullet.ordered_icons or self.bullet.icons
     local icon = nil
     if type(icons) == 'function' then
-        icon = icons(level, index)
+        icon = icons(level, index, node.text)
     else
         icon = List.cycle(icons, level)
         if type(icon) == 'table' then
@@ -101,7 +102,6 @@ function Render:icon(level)
     if icon == nil then
         return
     end
-    local node = self.data.marker
     local text = Str.pad(self.data.spaces) .. icon
     local position, conceal = 'overlay', nil
     if Str.width(text) > Str.width(node.text) then