Add section on some known limitation, unsure if I want to 'fix' them

Author: MeanderingProgrammer

README.md

@@ -26,6 +26,11 @@ Plugin to improve viewing Markdown files in Neovim
 - Support for [callouts](https://github.com/orgs/community/discussions/16925)
 - Support custom handlers which are ran identically to native handlers
 
+# Known Limitations
+
+- Text that extends beyond available space will overwrite content [#35](https://github.com/MeanderingProgrammer/markdown.nvim/issues/35)
+- `LaTeX` formula evaluations are placed above rather than overlayed [#6](https://github.com/MeanderingProgrammer/markdown.nvim/issues/6)
+
 # Dependencies
 
 - [treesitter](https://github.com/nvim-treesitter/nvim-treesitter) parsers:

doc/render-markdown.txt

@@ -1,20 +1,21 @@
-*render-markdown.txt*           For 0.10.0           Last change: 2024 June 05
+*render-markdown.txt*           For 0.10.0           Last change: 2024 June 08
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
 
 1. markdown.nvim                               |render-markdown-markdown.nvim|
 2. Features                                         |render-markdown-features|
-3. Dependencies                                 |render-markdown-dependencies|
-4. Install                                           |render-markdown-install|
+3. Known Limitations                       |render-markdown-known-limitations|
+4. Dependencies                                 |render-markdown-dependencies|
+5. 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. Custom Handlers                           |render-markdown-custom-handlers|
+6. Setup                                               |render-markdown-setup|
+7. Commands                                         |render-markdown-commands|
+8. Custom Handlers                           |render-markdown-custom-handlers|
   - More Complex Example|render-markdown-custom-handlers-more-complex-example|
-8. Purpose                                           |render-markdown-purpose|
-9. Markdown Ecosystem                     |render-markdown-markdown-ecosystem|
+9. Purpose                                           |render-markdown-purpose|
+10. Markdown Ecosystem                    |render-markdown-markdown-ecosystem|
   - Render in Neovim     |render-markdown-markdown-ecosystem-render-in-neovim|
   - Render in Browser   |render-markdown-markdown-ecosystem-render-in-browser|
   - Orthogonal                 |render-markdown-markdown-ecosystem-orthogonal|
@@ -53,7 +54,14 @@ Plugin to improve viewing Markdown files in Neovim
 
 
 ==============================================================================
-3. Dependencies                                 *render-markdown-dependencies*
+3. Known Limitations                       *render-markdown-known-limitations*
+
+- Text that extends beyond available space will overwrite content #35 <https://github.com/MeanderingProgrammer/markdown.nvim/issues/35>
+- `LaTeX` formula evaluations are placed above rather than overlayed #6 <https://github.com/MeanderingProgrammer/markdown.nvim/issues/6>
+
+
+==============================================================================
+4. Dependencies                                 *render-markdown-dependencies*
 
 - treesitter <https://github.com/nvim-treesitter/nvim-treesitter> parsers:
     - markdown & markdown_inline <https://github.com/tree-sitter-grammars/tree-sitter-markdown>:
@@ -66,7 +74,7 @@ Plugin to improve viewing Markdown files in Neovim
 
 
 ==============================================================================
-4. Install                                           *render-markdown-install*
+5. Install                                           *render-markdown-install*
 
 
 LAZY.NVIM                                  *render-markdown-install-lazy.nvim*
@@ -98,7 +106,7 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
 
 
 ==============================================================================
-5. Setup                                               *render-markdown-setup*
+6. Setup                                               *render-markdown-setup*
 
 Below is the configuration that gets used by default, any part of it can be
 modified by the user.
@@ -258,15 +266,15 @@ modified by the user.
 
 
 ==============================================================================
-6. Commands                                         *render-markdown-commands*
+7. Commands                                         *render-markdown-commands*
 
 `:RenderMarkdownToggle` - Switch between enabling & disabling this plugin
 
 - Function can also be accessed directly through `require('render-markdown').toggle()`
 
 
 ==============================================================================
-7. Custom Handlers                           *render-markdown-custom-handlers*
+8. Custom Handlers                           *render-markdown-custom-handlers*
 
 Custom handlers allow users to integrate custom rendering for either
 unsupported languages or to override the native implementations. This can also
@@ -336,7 +344,7 @@ Lets say for `python` we want to highlight lines with function definitions.
 
 
 ==============================================================================
-8. Purpose                                           *render-markdown-purpose*
+9. Purpose                                           *render-markdown-purpose*
 
 There are many existing markdown rendering plugins in the Neovim ecosystem.
 However, most of these rely on syncing a separate browser window with the
@@ -353,7 +361,7 @@ this plugin.
 
 
 ==============================================================================
-9. Markdown Ecosystem                     *render-markdown-markdown-ecosystem*
+10. Markdown Ecosystem                    *render-markdown-markdown-ecosystem*
 
 There are many `markdown` plugins that specialize in different aspects of
 interacting with `markdown` files. This plugin specializes in rendering the

tests/init_spec.lua

@@ -4,8 +4,16 @@ local util = require('plenary.async.util')
 
 local eq = assert.are.same
 
----@param expected any[]
-local function marks_are_equal(expected)
+---@param file string
+---@param opts? render.md.UserConfig
+local function setup(file, opts)
+    require('render-markdown').setup(opts)
+    vim.cmd('e ' .. file)
+    util.scheduler()
+end
+
+---@return any[]
+local function get_actual_marks()
     local actual = {}
     local marks = vim.api.nvim_buf_get_extmarks(0, ui.namespace, 0, -1, { details = true })
     for _, mark in ipairs(marks) do
@@ -23,21 +31,21 @@ local function marks_are_equal(expected)
         }
         table.insert(actual, mark_info)
     end
+    return actual
+end
 
+---@param expected any[]
+---@param actual any[]
+local function marks_are_equal(expected, actual)
     eq(#expected, #actual)
     for i, expected_mark_info in ipairs(expected) do
         eq(expected_mark_info, actual[i], string.format('Marks at index %d mismatch', i))
     end
 end
 
 async_tests.describe('init', function()
-    async_tests.before_each(function()
-        require('render-markdown').setup({})
-    end)
-
     async_tests.it('render heading_code.md', function()
-        vim.cmd('e demo/heading_code.md')
-        util.scheduler()
+        setup('demo/heading_code.md')
 
         local expected = {}
 
@@ -95,12 +103,12 @@ async_tests.describe('init', function()
             },
         })
 
-        marks_are_equal(expected)
+        local actual = get_actual_marks()
+        marks_are_equal(expected, actual)
     end)
 
     async_tests.it('render list_table.md', function()
-        vim.cmd('e demo/list_table.md')
-        util.scheduler()
+        setup('demo/list_table.md')
 
         local expected = {}
 
@@ -266,12 +274,12 @@ async_tests.describe('init', function()
             },
         })
 
-        marks_are_equal(expected)
+        local actual = get_actual_marks()
+        marks_are_equal(expected, actual)
     end)
 
     async_tests.it('render box_dash_quote.md', function()
-        vim.cmd('e demo/box_dash_quote.md')
-        util.scheduler()
+        setup('demo/box_dash_quote.md')
 
         local expected = {}
 
@@ -343,13 +351,13 @@ async_tests.describe('init', function()
             },
         })
 
-        marks_are_equal(expected)
+        local actual = get_actual_marks()
+        marks_are_equal(expected, actual)
     end)
 
     async_tests.it('render latex.md', function()
         -- TODO: mock interaction with latex2text
-        vim.cmd('e demo/latex.md')
-        util.scheduler()
+        setup('demo/latex.md')
 
         local expected = {}
 
@@ -385,12 +393,12 @@ async_tests.describe('init', function()
             },
         })
 
-        marks_are_equal(expected)
+        local actual = get_actual_marks()
+        marks_are_equal(expected, actual)
     end)
 
     async_tests.it('render callout.md', function()
-        vim.cmd('e demo/callout.md')
-        util.scheduler()
+        setup('demo/callout.md')
 
         local expected = {}
 
@@ -564,6 +572,7 @@ async_tests.describe('init', function()
             },
         })
 
-        marks_are_equal(expected)
+        local actual = get_actual_marks()
+        marks_are_equal(expected, actual)
     end)
 end)