Skip to content

Commit fc05fb7

Browse files
chore: update list docs to mention supporting list of lists
1 parent 14673b0 commit fc05fb7

File tree

4 files changed

+27
-21
lines changed

4 files changed

+27
-21
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
- custom checkbox scope_highlight [#207](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/207)
88
[2f36ac1](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/2f36ac16df20e0c6512f14e2793f7b2ba235989c)
9+
- handle and log latex converter errors [34044cd](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/34044cdfcc90b87f32eb962f1fcd9119fc1a62a5)
10+
- bullet icons list of lists [#217](https://github.com/MeanderingProgrammer/render-markdown.nvim/discussions/217)
11+
[04e75a3](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/04e75a35900d9e6bc53eb0f18e2aeee140d6c5ae)
12+
- icons for ordered lists [14673b0](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/14673b03963ef9bb9365474133306266fd4864f6)
913

1014
### Bug Fixes
1115

@@ -14,6 +18,8 @@
1418
- disable rendering when left column is > 0 [1871dc4](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/1871dc4ced6fd775591a63df8e4c343ebaf1a2d2)
1519
- skip updates when buffer in window changes [#209](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/209)
1620
[c6b59a2](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/c6b59a263cffbd6bf463fff03b28a35ad9f1a8e6)
21+
- use first window if buffer is not current window [#210](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/210)
22+
[5137b5e](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/5137b5e198ddff8a26f88df7000ff8ca336e6fcd)
1723

1824
## 7.4.0 (2024-10-16)
1925

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -354,13 +354,13 @@ require('render-markdown').setup({
354354
-- Turn on / off list bullet rendering
355355
enabled = true,
356356
-- Replaces '-'|'+'|'*' of 'list_item'
357-
-- How deeply nested the list is determines the 'level'
358-
-- The 'level' is used to index into the list using a cycle
357+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
358+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
359359
-- If the item is a 'checkbox' a conceal is used to hide the bullet instead
360360
icons = { '', '', '', '' },
361361
-- Replaces 'n.'|'n)' of 'list_item'
362-
-- How deeply nested the list is determines the 'level'
363-
-- The 'level' is used to index into the list using a cycle
362+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
363+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
364364
ordered_icons = {},
365365
-- Padding to add to the left of bullet point
366366
left_pad = 0,
@@ -810,13 +810,13 @@ require('render-markdown').setup({
810810
-- Turn on / off list bullet rendering
811811
enabled = true,
812812
-- Replaces '-'|'+'|'*' of 'list_item'
813-
-- How deeply nested the list is determines the 'level'
814-
-- The 'level' is used to index into the list using a cycle
813+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
814+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
815815
-- If the item is a 'checkbox' a conceal is used to hide the bullet instead
816816
icons = { '', '', '', '' },
817817
-- Replaces 'n.'|'n)' of 'list_item'
818-
-- How deeply nested the list is determines the 'level'
819-
-- The 'level' is used to index into the list using a cycle
818+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
819+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
820820
ordered_icons = {},
821821
-- Padding to add to the left of bullet point
822822
left_pad = 0,

doc/render-markdown.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For 0.10.0 Last change: 2024 October 25
1+
*render-markdown.txt* For 0.10.0 Last change: 2024 October 27
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -401,13 +401,13 @@ Default Configuration ~
401401
-- Turn on / off list bullet rendering
402402
enabled = true,
403403
-- Replaces '-'|'+'|'*' of 'list_item'
404-
-- How deeply nested the list is determines the 'level'
405-
-- The 'level' is used to index into the list using a cycle
404+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
405+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
406406
-- If the item is a 'checkbox' a conceal is used to hide the bullet instead
407407
icons = { '●', '○', '◆', '◇' },
408408
-- Replaces 'n.'|'n)' of 'list_item'
409-
-- How deeply nested the list is determines the 'level'
410-
-- The 'level' is used to index into the list using a cycle
409+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
410+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
411411
ordered_icons = {},
412412
-- Padding to add to the left of bullet point
413413
left_pad = 0,
@@ -847,13 +847,13 @@ Bullet Point Configuration ~
847847
-- Turn on / off list bullet rendering
848848
enabled = true,
849849
-- Replaces '-'|'+'|'*' of 'list_item'
850-
-- How deeply nested the list is determines the 'level'
851-
-- The 'level' is used to index into the list using a cycle
850+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
851+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
852852
-- If the item is a 'checkbox' a conceal is used to hide the bullet instead
853853
icons = { '●', '○', '◆', '◇' },
854854
-- Replaces 'n.'|'n)' of 'list_item'
855-
-- How deeply nested the list is determines the 'level'
856-
-- The 'level' is used to index into the list using a cycle
855+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
856+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
857857
ordered_icons = {},
858858
-- Padding to add to the left of bullet point
859859
left_pad = 0,

lua/render-markdown/init.lua

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -468,13 +468,13 @@ M.default_config = {
468468
-- Turn on / off list bullet rendering
469469
enabled = true,
470470
-- Replaces '-'|'+'|'*' of 'list_item'
471-
-- How deeply nested the list is determines the 'level'
472-
-- The 'level' is used to index into the list using a cycle
471+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
472+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
473473
-- If the item is a 'checkbox' a conceal is used to hide the bullet instead
474474
icons = { '', '', '', '' },
475475
-- Replaces 'n.'|'n)' of 'list_item'
476-
-- How deeply nested the list is determines the 'level'
477-
-- The 'level' is used to index into the list using a cycle
476+
-- How deeply nested the list is determines the 'level' which is used to index into the list using a cycle
477+
-- The item number in the list is used to index into the value using a clamp if the value is also a list
478478
ordered_icons = {},
479479
-- Padding to add to the left of bullet point
480480
left_pad = 0,

0 commit comments

Comments
 (0)