Add support for rendering inline markdown code spans

# Details

- Adds support for markdown_inline code_span elements to be
  highlighted with the same group as code blocks.
- Update health check to check for inline parser.
- Update demo to show this new behavior.
- Minor update to how demo is created.

Author: MeanderingProgrammer

README.md

@@ -10,16 +10,16 @@ Plugin to improve viewing Markdown files in Neovim
 - Changes between `rendered` view in normal mode and raw view in all other modes
 - Supports rendering `markdown` injected into other file types
 - Highlights headings with different groups depending on level and replaces `#`
-- Highlights code blocks to better stand out
+- Highlights code blocks and inline code to better stand out
 - Replaces whichever style bullet point is being used with provided character
 - 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
 
 # Dependencies
 
-- [markdown](https://github.com/tree-sitter-grammars/tree-sitter-markdown) parser for
-  [treesitter](https://github.com/nvim-treesitter/nvim-treesitter): Used to parse
+- [markdown & markdown_inline](https://github.com/tree-sitter-grammars/tree-sitter-markdown)
+  parsers for [treesitter](https://github.com/nvim-treesitter/nvim-treesitter): Used to parse
   `markdown` files
 - [pylatexenc](https://pypi.org/project/pylatexenc/): Used to transform `LaTeX` strings
   to appropriate unicode using `latex2text`, not a mandatory dependency
@@ -46,8 +46,7 @@ by the user.
 
 ```lua
 require('render-markdown').setup({
-    -- Capture groups that get pulled from markdown, these are later used to
-    -- modify how the file gets rendered
+    -- Capture groups that get pulled from markdown
     markdown_query = [[
         (atx_heading [
             (atx_h1_marker)
@@ -73,10 +72,14 @@ require('render-markdown').setup({
         (pipe_table_delimiter_row) @table_delim
         (pipe_table_row) @table_row
     ]],
+    -- Capture groups that get pulled from inline markdown
+    inline_query = [[
+        (code_span) @code
+    ]],
     -- Filetypes this plugin will run on
     file_types = { 'markdown' },
-    -- vim modes that will show a rendered view of the markdown file, all other
-    -- modes will be uneffected by this plugin
+    -- Vim modes that will show a rendered view of the markdown file
+    -- All other modes will be uneffected by this plugin
     render_modes = { 'n', 'c' },
     -- Characters that will replace the # at the start of headings
     headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },

demo/demo.gif

@@ -17,7 +17,7 @@ def main(zoom: int, file: str, cast: str) -> None:
     # https://docs.asciinema.org/manual/cli/usage/
     pyautogui.write(f"asciinema rec -c 'nvim {file}' {cast}")
     pyautogui.press("enter")
-    time.sleep(1.0)
+    time.sleep(1.5)
 
     # Start typing in new heading
     pyautogui.press("o")
@@ -28,11 +28,12 @@ def main(zoom: int, file: str, cast: str) -> None:
     pyautogui.press("esc")
     time.sleep(2.0)
 
-    for _ in range(2):
+    # Swith between insert and normal mode a few times
+    for i in range(2):
         pyautogui.press("i")
-        time.sleep(1.0)
+        time.sleep(i + 1)
         pyautogui.press("esc")
-        time.sleep(2.0)
+        time.sleep((i + 1) * 2)
 
     # Close demo file
     pyautogui.write(":q!")

demo/record.py

@@ -21,7 +21,7 @@ if __name__ == "__main__":
 ```
 
 - List Item 1
-* List Item 2
+* List Item 2: with `inline` code
     * Nested List Item 1
     * Nested List Item 2
 + List Item 3

demo/sample.md

@@ -13,6 +13,7 @@ local M = {}
 function M.check()
     vim.health.start('Checking required treesitter parsers')
     parser_installed('markdown')
+    parser_installed('markdown_inline')
 end
 
 return M

lua/render-markdown/health.lua

@@ -21,6 +21,7 @@ local M = {}
 
 ---@class UserConfig
 ---@field public markdown_query? string
+---@field public inline_query? string
 ---@field public file_types? string[]
 ---@field public render_modes? string[]
 ---@field public headings? string[]
@@ -57,6 +58,9 @@ function M.setup(opts)
             (pipe_table_delimiter_row) @table_delim
             (pipe_table_row) @table_row
         ]],
+        inline_query = [[
+            (code_span) @code
+        ]],
         file_types = { 'markdown' },
         render_modes = { 'n', 'c' },
         headings = { '󰲡 ', '󰲣 ', '󰲥 ', '󰲧 ', '󰲩 ', '󰲫 ' },
@@ -87,6 +91,7 @@ function M.setup(opts)
     state.enabled = true
     state.config = vim.tbl_deep_extend('force', default_config, opts or {})
     state.markdown_query = vim.treesitter.query.parse('markdown', state.config.markdown_query)
+    state.inline_query = vim.treesitter.query.parse('markdown_inline', state.config.inline_query)
 
     -- Call immediately to re-render on LazyReload
     vim.schedule(ui.refresh)

lua/render-markdown/init.lua

@@ -16,6 +16,7 @@
 
 ---@class Config
 ---@field public markdown_query string
+---@field public inline_query string
 ---@field public file_types string[]
 ---@field public render_modes string[]
 ---@field public headings string[]
@@ -27,5 +28,6 @@
 ---@field enabled boolean
 ---@field config Config
 ---@field markdown_query Query
+---@field inline_query Query
 local state = {}
 return state

lua/render-markdown/state.lua

@@ -27,6 +27,8 @@ M.refresh = function()
         local language = language_tree:lang()
         if language == 'markdown' then
             M.markdown(tree:root())
+        elseif language == 'markdown_inline' then
+            M.markdown_inline(tree:root())
         elseif language == 'latex' then
             M.latex(tree:root())
         end
@@ -109,7 +111,28 @@ M.markdown = function(root)
             })
         else
             -- Should only get here if user provides custom capture, currently unhandled
-            vim.print('Unhandled capture: ' .. capture)
+            vim.print('Unhandled markdown capture: ' .. capture)
+        end
+    end
+end
+
+---@param root TSNode
+M.markdown_inline = function(root)
+    local highlights = state.config.highlights
+    ---@diagnostic disable-next-line: missing-parameter
+    for id, node in state.inline_query:iter_captures(root, 0) do
+        local capture = state.inline_query.captures[id]
+        local start_row, start_col, end_row, end_col = node:range()
+
+        if capture == 'code' then
+            vim.api.nvim_buf_set_extmark(0, M.namespace, start_row, start_col, {
+                end_row = end_row,
+                end_col = end_col,
+                hl_group = highlights.code,
+            })
+        else
+            -- Should only get here if user provides custom capture, currently unhandled
+            vim.print('Unhandled inline capture: ' .. capture)
         end
     end
 end