Add support for code blocks in callouts / quotes

# Details

The current logic for finding quote markers in a block quote relies
on several tree-sitter queries that do not handle different element
types well, an example of this is code blocks.

To fix this rather than having a top level query which pulls quote
marker nodes use 2 separate queries. This first gets the block_quote,
the second runs on the block_quote node and gets all continuations,
regardless of how they are nested.

This does to a certain extent allow arbitrary nesting, however the
highlights chosen for nested callouts do not look great, but it does
work, so that's cool.

Other minor changes:
- README order
- Add checkhealth field to bug report template
- Store callouts as a list so order is consistent

Author: MeanderingProgrammer

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -5,20 +5,20 @@ labels: [bug]
 body:
   - type: input
     attributes:
-      label: "Neovim version (nvim -v)"
-      placeholder: "0.9.5"
+      label: Neovim version (nvim -v)
+      placeholder: 0.9.5
     validations:
       required: true
   - type: input
     attributes:
-      label: "Operating system"
-      placeholder: "MacOS"
+      label: Operating system
+      placeholder: MacOS
     validations:
       required: true
   - type: input
     attributes:
-      label: "Terminal emulator / GUI"
-      placeholder: "WezTerm"
+      label: Terminal emulator / GUI
+      placeholder: WezTerm
     validations:
       required: true
   - type: textarea
@@ -32,7 +32,12 @@ body:
       label: Expected behavior
       description: A description of what you expected to happen.
     validations:
-      required: true 
+      required: true
+  - type: textarea
+    attributes:
+      label: Healthcheck output (:checkhealth render-markdown)
+    validations:
+      required: true
   - type: textarea
     attributes:
       label: Additional information

README.md

@@ -75,6 +75,12 @@ use({
 })
 ```
 
+# Commands
+
+`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
+
+- Function can also be accessed directly through `require('render-markdown').toggle()`
+
 # Setup
 
 Below is the configuration that gets used by default, any part of it can be modified
@@ -114,16 +120,20 @@ require('render-markdown').setup({
         (task_list_marker_unchecked) @checkbox_unchecked
         (task_list_marker_checked) @checkbox_checked
 
-        (block_quote (block_quote_marker) @quote_marker)
-        (block_quote (block_continuation) @quote_marker)
-        (block_quote (paragraph (block_continuation) @quote_marker))
-        (block_quote (paragraph (inline (block_continuation) @quote_marker)))
+        (block_quote) @quote
 
         (pipe_table) @table
         (pipe_table_header) @table_head
         (pipe_table_delimiter_row) @table_delim
         (pipe_table_row) @table_row
     ]],
+    -- Capture groups that get pulled from quote nodes
+    markdown_quote_query = [[
+        [
+            (block_quote_marker)
+            (block_continuation)
+        ] @quote_marker
+    ]],
     -- Capture groups that get pulled from inline markdown
     inline_query = [[
         (code_span) @code
@@ -245,31 +255,6 @@ require('render-markdown').setup({
 })
 ```
 
-# Commands
-
-`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
-
-- Function can also be accessed directly through `require('render-markdown').toggle()`
-
-# Note to `vimwiki` Users
-
-If you use [vimwiki](https://github.com/vimwiki/vimwiki), because it overrides the
-`filetype` of `markdown` files there are additional setup steps.
-
-- Add `vimwiki` to the `file_types` configuration of this plugin
-
-```lua
-require('render-markdown').setup({
-    file_types = { 'markdown', 'vimwiki' },
-})
-```
-
-- Register `markdown` as the parser for `vimwiki` files
-
-```lua
-vim.treesitter.language.register('markdown', 'vimwiki')
-```
-
 # Additional Info
 
 - [Limitations](doc/limitations.md): Known limitations of this plugin
@@ -279,3 +264,22 @@ vim.treesitter.language.register('markdown', 'vimwiki')
 - [Purpose](doc/purpose.md): Why this plugin exists
 - [Markdown Ecosystem](doc/markdown-ecosystem.md): Information about other `markdown`
   related plugins and how they co-exist
+
+> [!NOTE]
+>
+> If you use [vimwiki](https://github.com/vimwiki/vimwiki), because it overrides
+> the `filetype` of `markdown` files there are additional setup steps.
+>
+> - Add `vimwiki` to the `file_types` configuration of this plugin
+>
+> ```lua
+> require('render-markdown').setup({
+>     file_types = { 'markdown', 'vimwiki' },
+> })
+> ```
+>
+> - Register `markdown` as the parser for `vimwiki` files
+>
+> ```lua
+> vim.treesitter.language.register('markdown', 'vimwiki')
+> ```

demo/callout.gif

@@ -9,7 +9,10 @@
 # Tip
 
 > [!TIP]
-> Standard tip
+>
+> ```lua
+> print('Standard tip')
+> ```
 
 # Important
 

demo/callout.md

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 July 01
+*render-markdown.txt*           For 0.10.0           Last change: 2024 July 05
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -9,10 +9,9 @@ Table of Contents                          *render-markdown-table-of-contents*
 4. Install                                           |render-markdown-install|
   - lazy.nvim                              |render-markdown-install-lazy.nvim|
   - packer.nvim                          |render-markdown-install-packer.nvim|
-5. Setup                                               |render-markdown-setup|
-6. Commands                                         |render-markdown-commands|
-7. Note to vimwiki Users               |render-markdown-note-to-vimwiki-users|
-8. Additional Info                           |render-markdown-additional-info|
+5. Commands                                         |render-markdown-commands|
+6. Setup                                               |render-markdown-setup|
+7. Additional Info                           |render-markdown-additional-info|
 
 ==============================================================================
 1. markdown.nvim                               *render-markdown-markdown.nvim*
@@ -103,7 +102,15 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
 
 
 ==============================================================================
-5. Setup                                               *render-markdown-setup*
+5. Commands                                         *render-markdown-commands*
+
+`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
+
+- Function can also be accessed directly through `require('render-markdown').toggle()`
+
+
+==============================================================================
+6. Setup                                               *render-markdown-setup*
 
 Below is the configuration that gets used by default, any part of it can be
 modified by the user.
@@ -142,16 +149,20 @@ modified by the user.
             (task_list_marker_unchecked) @checkbox_unchecked
             (task_list_marker_checked) @checkbox_checked
 
-            (block_quote (block_quote_marker) @quote_marker)
-            (block_quote (block_continuation) @quote_marker)
-            (block_quote (paragraph (block_continuation) @quote_marker))
-            (block_quote (paragraph (inline (block_continuation) @quote_marker)))
+            (block_quote) @quote
 
             (pipe_table) @table
             (pipe_table_header) @table_head
             (pipe_table_delimiter_row) @table_delim
             (pipe_table_row) @table_row
         ]],
+        -- Capture groups that get pulled from quote nodes
+        markdown_quote_query = [[
+            [
+                (block_quote_marker)
+                (block_continuation)
+            ] @quote_marker
+        ]],
         -- Capture groups that get pulled from inline markdown
         inline_query = [[
             (code_span) @code
@@ -275,36 +286,7 @@ modified by the user.
 
 
 ==============================================================================
-6. Commands                                         *render-markdown-commands*
-
-`:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
-
-- Function can also be accessed directly through `require('render-markdown').toggle()`
-
-
-==============================================================================
-7. Note to vimwiki Users               *render-markdown-note-to-vimwiki-users*
-
-If you use vimwiki <https://github.com/vimwiki/vimwiki>, because it overrides
-the `filetype` of `markdown` files there are additional setup steps.
-
-- Add `vimwiki` to the `file_types` configuration of this plugin
-
->lua
-    require('render-markdown').setup({
-        file_types = { 'markdown', 'vimwiki' },
-    })
-<
-
-- Register `markdown` as the parser for `vimwiki` files
-
->lua
-    vim.treesitter.language.register('markdown', 'vimwiki')
-<
-
-
-==============================================================================
-8. Additional Info                           *render-markdown-additional-info*
+7. Additional Info                           *render-markdown-additional-info*
 
 - Limitations <doc/limitations.md>: Known limitations of this plugin
 - Custom Handlers <doc/custom-handlers.md>: Allow users to integrate custom rendering
@@ -314,6 +296,21 @@ the `filetype` of `markdown` files there are additional setup steps.
 - Markdown Ecosystem <doc/markdown-ecosystem.md>: Information about other `markdown`
     related plugins and how they co-exist
 
+
+  [!NOTE]
+  If you use vimwiki <https://github.com/vimwiki/vimwiki>, because it overrides
+  the `filetype` of `markdown` files there are additional setup steps.
+  - Add `vimwiki` to the `file_types` configuration of this plugin
+  >lua
+      require('render-markdown').setup({
+          file_types = { 'markdown', 'vimwiki' },
+      })
+  <
+  - Register `markdown` as the parser for `vimwiki` files
+  >lua
+      vim.treesitter.language.register('markdown', 'vimwiki')
+  <
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:

doc/render-markdown.txt

@@ -22,7 +22,7 @@ demo-latex:
   just demo "latex" "15" ""
 
 demo-callout:
-  just demo "callout" "30" ""
+  just demo "callout" "35" ""
 
 demo file rows content:
   rm -f demo/{{file}}.gif

justfile

@@ -1,25 +1,35 @@
-local callout_to_key = {
-    ['[!NOTE]'] = 'note',
-    ['[!TIP]'] = 'tip',
-    ['[!IMPORTANT]'] = 'important',
-    ['[!WARNING]'] = 'warning',
-    ['[!CAUTION]'] = 'caution',
+---@class render.md.CalloutInfo
+---@field text string
+---@field key string
+
+---@type render.md.CalloutInfo[]
+local callouts = {
+    { text = '[!NOTE]', key = 'note' },
+    { text = '[!TIP]', key = 'tip' },
+    { text = '[!IMPORTANT]', key = 'important' },
+    { text = '[!WARNING]', key = 'warning' },
+    { text = '[!CAUTION]', key = 'caution' },
 }
 
 local M = {}
 
 ---@param value string
 ---@return string?
 M.get_key_exact = function(value)
-    return callout_to_key[value]
+    for _, callout in ipairs(callouts) do
+        if value == callout.text then
+            return callout.key
+        end
+    end
+    return nil
 end
 
 ---@param value string
 ---@return string?
 M.get_key_contains = function(value)
-    for callout, key in pairs(callout_to_key) do
-        if value:find(callout, 1, true) then
-            return key
+    for _, callout in ipairs(callouts) do
+        if value:find(callout.text, 1, true) then
+            return callout.key
         end
     end
     return nil

lua/render-markdown/callout.lua

@@ -22,7 +22,6 @@ M.render = function(namespace, root, buf)
     if vim.fn.executable(converter) ~= 1 then
         logger.debug('Executable not found: ' .. converter)
     else
-        logger.debug_node('latex', root, buf)
         M.render_node(namespace, buf, root, converter)
     end
 end
@@ -35,6 +34,7 @@ M.render_node = function(namespace, buf, node, converter)
     local highlights = state.config.highlights
     local value = vim.treesitter.get_node_text(node, buf)
     local start_row, start_col, end_row, end_col = node:range()
+    logger.debug_node('latex', node, buf)
 
     local expressions = cache.expressions[value]
     if expressions == nil then

lua/render-markdown/handler/latex.lua

@@ -12,10 +12,9 @@ local M = {}
 ---@param root TSNode
 ---@param buf integer
 M.render = function(namespace, root, buf)
-    for id, node in state.markdown_query:iter_captures(root, buf) do
-        local capture = state.markdown_query.captures[id]
-        logger.debug_node(capture, node, buf)
-        M.render_node(namespace, buf, capture, node)
+    local query = state.markdown_query
+    for id, node in query:iter_captures(root, buf) do
+        M.render_node(namespace, buf, query.captures[id], node)
     end
 end
 
@@ -27,6 +26,7 @@ M.render_node = function(namespace, buf, capture, node)
     local highlights = state.config.highlights
     local value = vim.treesitter.get_node_text(node, buf)
     local start_row, start_col, end_row, end_col = node:range()
+    logger.debug_node(capture, node, buf)
 
     if capture == 'heading' then
         local level = vim.fn.strdisplaywidth(value)
@@ -109,6 +109,11 @@ M.render_node = function(namespace, buf, capture, node)
                 virt_text_pos = 'overlay',
             })
         end
+    elseif capture == 'quote' then
+        local query = state.markdown_quote_query
+        for id, nested_node in query:iter_captures(node, buf) do
+            M.render_node(namespace, buf, query.captures[id], nested_node)
+        end
     elseif capture == 'quote_marker' then
         local highlight = highlights.quote
         local quote = ts.parent_in_section(node, 'block_quote')

lua/render-markdown/handler/markdown.lua

@@ -8,10 +8,9 @@ local M = {}
 ---@param root TSNode
 ---@param buf integer
 M.render = function(namespace, root, buf)
-    for id, node in state.inline_query:iter_captures(root, buf) do
-        local capture = state.inline_query.captures[id]
-        logger.debug_node(capture, node, buf)
-        M.render_node(namespace, buf, capture, node)
+    local query = state.inline_query
+    for id, node in query:iter_captures(root, buf) do
+        M.render_node(namespace, buf, query.captures[id], node)
     end
 end
 
@@ -23,6 +22,7 @@ M.render_node = function(namespace, buf, capture, node)
     local highlights = state.config.highlights
     local value = vim.treesitter.get_node_text(node, buf)
     local start_row, start_col, end_row, end_col = node:range()
+    logger.debug_node(capture, node, buf)
 
     if capture == 'code' then
         vim.api.nvim_buf_set_extmark(buf, namespace, start_row, start_col, {