Apply stylua / minor edits / demo update

Author: MeanderingProgrammer

README.md

@@ -12,7 +12,7 @@ Plugin to improve viewing Markdown files in Neovim
 - Supports rendering `markdown` injected into other file types
 - Highlights headings with different groups depending on level and replaces `#`
 - Highlights code blocks and inline code to better stand out
-- Replaces whichever style bullet point is being used with provided character
+- Replaces bullet points with provided character based on level
 - 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
@@ -86,7 +86,7 @@ require('render-markdown').setup({
     -- Characters that will replace the # at the start of headings
     headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
     -- Character to use for the bullet points in lists
-    bullets = {"●","○","◆","◇"},
+    bullets = { '●', '○', '◆', '◇' },
     -- Character that will replace the > at the start of block quotes
     quote = '┃',
     -- See :h 'conceallevel' for more information about meaning of values

demo/demo.gif

@@ -22,8 +22,11 @@ if __name__ == "__main__":
 
 - List Item 1: with [link](https://example.com)
 * List Item 2: with `inline` code
-    * Nested List Item 1
-    * Nested List Item 2
+    * Nested List 1 Item 1
+    * Nested List 1 Item 2
+      - Nested List 2 Item 1
+        - Nested List 3 Item 1
+          - Nested List 4 Item 1
 + List Item 3
 
 1. Item 1

demo/sample.md

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.9.5           Last change: 2024 March 29
+*render-markdown.txt*           For 0.9.5           Last change: 2024 April 01
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -32,7 +32,7 @@ Plugin to improve viewing Markdown files in Neovim
 - Supports rendering `markdown` injected into other file types
 - Highlights headings with different groups depending on level and replaces `#`
 - Highlights code blocks and inline code to better stand out
-- Replaces whichever style bullet point is being used with provided character
+- Replaces bullet points with provided character based on level
 - 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
@@ -113,7 +113,7 @@ modified by the user.
         -- Characters that will replace the # at the start of headings
         headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
         -- Character to use for the bullet points in lists
-        bullets = {"●","○","◆","◇"},
+        bullets = { '●', '○', '◆', '◇' },
         -- Character that will replace the > at the start of block quotes
         quote = '┃',
         -- See :h 'conceallevel' for more information about meaning of values

doc/render-markdown.txt

@@ -71,7 +71,7 @@ function M.setup(opts)
         file_types = { 'markdown' },
         render_modes = { 'n', 'c' },
         headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
-        bullets = {"●","○","◆","◇"},
+        bullets = { '●', '○', '◆', '◇' },
         quote = '┃',
         conceal = {
             default = vim.opt.conceallevel:get(),

lua/render-markdown/init.lua

@@ -37,28 +37,6 @@ M.refresh = function()
     end)
 end
 
---- Walk through all parent nodes and count the number of nodes with type list
---- to calculate the level of the given node
----@param node TSNode
----@return integer
-M.calculate_list_level = function(node)
-    local candidate = node:parent()
-    local level = 0
-    while candidate ~= nil do
-        local candidate_type = candidate:type()
-        if candidate_type == "section" or candidate_type == "document" then
-            -- when reaching a section or the document we are clearly at the
-            -- top of the list
-            break
-        elseif candidate_type == "list" then
-            -- found a list increase the level and continue
-            level = level + 1
-        end
-        candidate = candidate:parent()
-    end
-    return level
-end
-
 ---@param root TSNode
 M.markdown = function(root)
     local highlights = state.config.highlights
@@ -95,10 +73,10 @@ M.markdown = function(root)
             -- edge cases in the parser: https://github.com/tree-sitter-grammars/tree-sitter-markdown/issues/127
             -- As a result we handle leading spaces here, can remove if this gets fixed upstream
             local _, leading_spaces = value:find('^%s*')
-            -- Get the level of the list_marker by counting the number of parent list nodes
             local level = M.calculate_list_level(node)
-            local bullet_marker = list.cycle(state.config.bullets, level)
-            local virt_text = { string.rep(' ', leading_spaces or 0) .. bullet_marker, highlights.bullet }
+            local bullet = list.cycle(state.config.bullets, level)
+
+            local virt_text = { string.rep(' ', leading_spaces or 0) .. bullet, highlights.bullet }
             vim.api.nvim_buf_set_extmark(0, M.namespace, start_row, start_col, {
                 end_row = end_row,
                 end_col = end_col,
@@ -167,6 +145,28 @@ M.markdown = function(root)
     end
 end
 
+--- Walk through all parent nodes and count the number of nodes with type list
+--- to calculate the level of the given node
+---@param node TSNode
+---@return integer
+M.calculate_list_level = function(node)
+    local level = 0
+    local parent = node:parent()
+    while parent ~= nil do
+        local parent_type = parent:type()
+        if vim.tbl_contains({ 'section', 'document' }, parent_type) then
+            -- when reaching a section or the document we are clearly at the
+            -- top of the list
+            break
+        elseif parent_type == 'list' then
+            -- found a list increase the level and continue
+            level = level + 1
+        end
+        parent = parent:parent()
+    end
+    return level
+end
+
 ---@param root TSNode
 M.markdown_inline = function(root)
     local highlights = state.config.highlights