Update change log for 3.3.0 release

Author: MeanderingProgrammer

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## 3.3.0 (2024-07-06)
+
+### Features
+
+- Improve performance by attaching events at buffer level [#45](https://github.com/MeanderingProgrammer/markdown.nvim/issues/45)
+  [14b3a01](https://github.com/MeanderingProgrammer/markdown.nvim/commit/14b3a01fbd7de25b03dafad7398e4ce463a4d323)
+- Reduce startup time by scheduling treesitter parsing [6d153d7](https://github.com/MeanderingProgrammer/markdown.nvim/commit/6d153d749b9297c0e5cb74716f2a8aacc8df3d0e)
+- Support arbitrary nesting of block quotes & code blocks [770f7a1](https://github.com/MeanderingProgrammer/markdown.nvim/commit/770f7a13515b9fd8d4ed4d6a1d8a854b3fbeeb7e)
+- Prefer `mini.icons` for code blocks over `nvim-web-devicons` [353e445](https://github.com/MeanderingProgrammer/markdown.nvim/commit/353e4459938dd58873772e27a45c1d92bc83bafc)
+- Support custom checkbox states [#42](https://github.com/MeanderingProgrammer/markdown.nvim/issues/42)
+  [ff3e8e3](https://github.com/MeanderingProgrammer/markdown.nvim/commit/ff3e8e344004bd6acda48a59f6780b5326e8a453)
+- Support custom callouts [8f5bbbd](https://github.com/MeanderingProgrammer/markdown.nvim/commit/8f5bbbd9e29508e2fc15b6fa9228eada15fca08a)
+
+### Bug Fixes
+
+- Fix language selection logic for code blocks [#44](https://github.com/MeanderingProgrammer/markdown.nvim/issues/44)
+  [90072fd](https://github.com/MeanderingProgrammer/markdown.nvim/commit/90072fdbc28042add4cd08bef282df032bf6ac42)
+
 ## 3.2.0 (2024-06-28)
 
 ### Features
@@ -52,8 +70,8 @@
   [#31](https://github.com/MeanderingProgrammer/markdown.nvim/pull/31)
   [258da4b](https://github.com/MeanderingProgrammer/markdown.nvim/commit/258da4bcdecdc83318a515fc4c6c3e18c0c65a61)
 - In order to fix:
-  - `conceal = { default = <value_1>, rendered = <value_2> }` ->
-    `win_options = { conceallevel = { default = <value_1>, rendered = <value_2> } }`
+  - `conceal = { default = <v1>, rendered = <v2> }` ->
+    `win_options = { conceallevel = { default = <v1>, rendered = <v2> } }`
 
 ### Contributor Shoutouts
 

README.md

@@ -269,135 +269,119 @@ require('render-markdown').setup({
 
 </details>
 
-There are 4 main types of settings:
-
-1. Icon: the text that gets rendered
-2. Highlight: the color for text & backgrounds
-3. Style: how different components are rendered
-4. Window Options: handles conceal behavior
-
-There are 2 main ways array like values are accessed:
+We use the following definitions when discussing indexing into arrays:
 
 1. Cycle: Indexed `mod` the length.
    Example: `{ 1, 2, 3 }` @ 4 = 1.
 2. Clamp: Indexed normally but larger values use the last value in the array.
    Example: `{ 1, 2, 3 }` @ 4 = 3.
 
-## Icon
+## Headings
 
-### headings
-
-Replace the `#` characters in front of headings.
+Icon: `headings`
+Highlight: `highlights.heading.backgrounds` & `highlights.heading.backgrounds`
+Style: N/A
 
+The icons replace the `#` characters in front of headings.
 The number of `#` characters in the heading determines the level of the heading.
+The level is used to index into the icon table using a cycle.
+The icon is left padded with spaces to fill the gap and hide any additional `#`.
+The level is also used to index into both highlights tables using a clamp.
+Both are applied to the icon and the background extends through the entire line.
 
-The level is used to index into the table using a cycle.
-
-The icon is pre-pendeded with spaces to fill the gap and hide any additional `#`.
+## Dashed Line
 
-### dash
+Icon: `dash`
+Highlight: `highlights.dash`
+Style: N/A
 
 Gets repeated across the window's width when a `thematic_break` is found.
 
-### bullets
-
-Replace the `-`, `+`, and `*` characters in front of list items.
-
-A different bullet is used depending on the level of nesting for the list item.
-
-The nesting level is used to index into the table using a cycle.
+## List Bullets
 
-If the character is before a checkbox, rather than changing the icon a conceal
-is used to hide the character.
+Icon: `bullets`
+Highlight: `highlights.bullet`
+Style: N/A
 
-### checkbox
+The icons replace the `-`, `+`, and `*` characters in front of list items.
+How deeply nested the list is determines the level of the list.
+The level is used to index into the icon table using a cycle.
+If the item is a `checkbox` a conceal is instead used to hide the bullet.
 
-The checked `[ ]` & unchecked `[x]` are directly replaced with these values.
+## Checkboxes
 
-Additionally `custom` states can be specified, an example of this is provided with:
-`todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' }`.
+Icon: `checkbox.unchecked`, `checkbox.checkbox`, & `checkbox.custom.rendered`
+Highlight: `highlights.checkbox.unchecked`, `highlights.checkbox.checked`, & `checkbox.custom.highlight`
+Style: N/A
 
-This requires neovim >= `0.10.0` since it relies on `inline` extmarks.
+In the case of a standard checked `[x]` or unchecked `[ ]` checkbox state we simply
+overlay the appropriate icon and apply the appropriate highlight.
 
-The key in the `custom` table is unused. The parts of the value are:
-
-- `raw`: matched against the raw text of a `shortcut_link`, in the same way as `callouts`
+Custom checkbox states setup through `checkbox.custom` are more involved as they
+are not part of the actual `markdown` grammar.
+As a result this requires neovim >= `0.10.0` since it relies on `inline` extmarks.
+An example comes with the default config:
+`todo = { raw = '[-]', rendered = '󰥔 ', highlight = '@markup.raw' }`
+The key part in this case `todo` is unused. The parts of the value are:
+- `raw`: matched against the raw text of a `shortcut_link`
 - `rendered`: replaces the `raw` value when rendering
 - `highlight`: color used for `rendered` text
 
-### quote
-
-Replaces the `|` character in front of `block_quotes`.
+## Standard Quotes
 
-### callout
+Icon: `quote`
+Highlight: `highlights.quote`
+Style: N/A
 
-This is a special instance of a `block_quote`.
+The icon replaces the `|` character in front of `block_quotes`.
 
-When the `callout` syntax is used the start, i.e. `[!NOTE]`, is replaced
-with this text.
+## Callouts
 
-Additionally `custom` callouts can be specified, an example of this is provided with:
-`bug = { raw = '[!BUG]', rendered = '󰨰 Bug', highlight = 'DiagnosticError' }`.
+Icon: `callout` & `callout.custom.rendered`
+Highlight: `highlights.callout` & `callout.custom.highlight`
+Style: N/A
 
-The key in the `custom` table is unused. The parts of the value are:
+Callouts are a special instance of a `block_quote` that start with a `shortcut_link`.
+When this pattern is seen the link text gets replaced by the icon.
+The highlight is then applied to the icon as well as the quote markers.
 
+Custom callouts setup through `callout.custom` behave in much the same way.
+An example comes with the default config:
+`bug = { raw = '[!BUG]', rendered = '󰨰 Bug', highlight = 'DiagnosticError' }`
+The key part in this case `bug` is unused. The parts of the value are:
 - `raw`: matched against the raw text of a `shortcut_link`
 - `rendered`: replaces the `raw` value when rendering
 - `highlight`: color used for `rendered` text
 
-## Highlight
-
-Options are all contained in the `highlights` table.
-
-For the most part the highlight group is used directly when writing the
-associated icons. We'll cover some of the specific behaviors.
-
-### heading
+## Code Blocks
 
-Both `backgrounds` and `foregrounds` are indexed by the level of the heading
-using a clamp.
-
-Both values are applied to the icon, however the background extends through
-the entire line.
-
-### table
-
-The `head` is used for the table heading, delimitter, and the line above.
-
-The `row` is used for everything else, so the main table rows and the line below.
-
-## Style
-
-### code_style
-
-Determines how `fenced_code_block`s are rendered.
+Icon: N/A
+Highlight: `highlights.code`
+Style: `code_style`
 
+`code_style` determines how code blocks are rendered:
 - `none`: disables all rendering
-- `normal`: adds background highlight group to the code block
+- `normal`: adds highlight group to the code block
 - `full`: `normal` + language icon & name above the code block
 
-### table_style
+## Tables
 
-Determines how `table`s are rendered.
+Icon: N/A
+Highlight: `highlights.table.head` & `highlights.table.row`
+Style: `table_style` & `cell_style`
 
+The `head` highlight is used for the table heading, delimitter, and the line above.
+The `row` highlight is used for everything else, main table rows and the line below.
+
+`table_style` determines how the table as a whole is rendered:
 - `none`: disables all rendering
 - `normal`: applies the `cell_style` rendering to each row of the table
 - `full`: `normal` + a top & bottom line that fill out the table when lengths match
 
-### cell_style
-
-Determines how `table cell`s are rendered.
-
+`cell_style` determines how individual cells of a table are rendered:
 - `overlay`: writes completely over the table, removing conceal behavior and highlights
 - `raw`: replaces only the `|` icons in each row, leaving the cell completely unmodified
 
-## Window Options
-
-Options are all contained in the `win_options` table.
-
-This changes the `conceallevel` & `concealcursor` when rendering. When not rendering
-the value is changed back to the users configured value.
-
 # Additional Info
 
 - [Limitations](doc/limitations.md): Known limitations of this plugin