@@ -155,8 +155,8 @@ require('render-markdown').setup({
155
155
-- Pre configured settings that will attempt to mimic various target
156
156
-- user experiences. Any user provided settings will take precedence.
157
157
-- obsidian: mimic Obsidian UI
158
- -- lazy: will attempt to stay up to date with LazyVim configuration
159
- -- none: does nothing
158
+ -- lazy: will attempt to stay up to date with LazyVim configuration
159
+ -- none: does nothing
160
160
preset = ' none' ,
161
161
-- Capture groups that get pulled from markdown
162
162
markdown_query = [[
@@ -234,7 +234,7 @@ require('render-markdown').setup({
234
234
-- Turn on / off any sign column related rendering
235
235
sign = true ,
236
236
-- Determines how the icon fills the available space:
237
- -- inline: underlying '#'s are concealed resulting in a left aligned icon
237
+ -- inline: underlying '#'s are concealed resulting in a left aligned icon
238
238
-- overlay: result is left padded with spaces to hide any additional '#'
239
239
position = ' overlay' ,
240
240
-- Replaces '#+' of 'atx_h._marker'
@@ -246,7 +246,7 @@ require('render-markdown').setup({
246
246
signs = { ' ' },
247
247
-- Width of the heading background:
248
248
-- block: width of the heading text
249
- -- full: full width of the window
249
+ -- full: full width of the window
250
250
-- Can also be an array of the above values in which case the 'level' is used
251
251
-- to index into the array using a clamp
252
252
width = ' full' ,
@@ -291,21 +291,21 @@ require('render-markdown').setup({
291
291
-- Turn on / off any sign column related rendering
292
292
sign = true ,
293
293
-- Determines how code blocks & inline code are rendered:
294
- -- none: disables all rendering
295
- -- normal: adds highlight group to code blocks & inline code, adds padding to code blocks
294
+ -- none: disables all rendering
295
+ -- normal: adds highlight group to code blocks & inline code, adds padding to code blocks
296
296
-- language: adds language icon to sign column if enabled and icon + name above code blocks
297
- -- full: normal + language
297
+ -- full: normal + language
298
298
style = ' full' ,
299
299
-- Determines where language icon is rendered:
300
- -- right: Right side of code block
301
- -- left: Left side of code block
300
+ -- right: right side of code block
301
+ -- left: left side of code block
302
302
position = ' left' ,
303
303
-- An array of language names for which background highlighting will be disabled
304
304
-- Likely because that language has background highlights itself
305
305
disable_background = { ' diff' },
306
306
-- Width of the code block background:
307
307
-- block: width of the code block
308
- -- full: full width of the window
308
+ -- full: full width of the window
309
309
width = ' full' ,
310
310
-- Amount of padding to add to the left of code blocks
311
311
left_pad = 0 ,
@@ -315,7 +315,7 @@ require('render-markdown').setup({
315
315
min_width = 0 ,
316
316
-- Determins how the top / bottom of code block are rendered:
317
317
-- thick: use the same highlight as the code body
318
- -- thin: when lines are empty overlay the above & below icons
318
+ -- thin: when lines are empty overlay the above & below icons
319
319
border = ' thin' ,
320
320
-- Used above code blocks for thin border
321
321
above = ' ▄' ,
@@ -334,7 +334,7 @@ require('render-markdown').setup({
334
334
icon = ' ─' ,
335
335
-- Width of the generated line:
336
336
-- <integer>: a hard coded width value
337
- -- full: full width of the window
337
+ -- full: full width of the window
338
338
width = ' full' ,
339
339
-- Highlight for the whole line generated from the icon
340
340
highlight = ' RenderMarkdownDash' ,
@@ -375,8 +375,8 @@ require('render-markdown').setup({
375
375
-- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
376
376
-- Can specify as many additional states as you like following the 'todo' pattern below
377
377
-- The key in this case 'todo' is for healthcheck and to allow users to change its values
378
- -- 'raw': Matched against the raw text of a 'shortcut_link'
379
- -- 'rendered': Replaces the 'raw' value when rendering
378
+ -- 'raw': Matched against the raw text of a 'shortcut_link'
379
+ -- 'rendered': Replaces the 'raw' value when rendering
380
380
-- 'highlight': Highlight for the 'rendered' icon
381
381
custom = {
382
382
todo = { raw = ' [-]' , rendered = ' ' , highlight = ' RenderMarkdownTodo' },
@@ -400,18 +400,20 @@ require('render-markdown').setup({
400
400
-- Turn on / off pipe table rendering
401
401
enabled = true ,
402
402
-- Pre configured settings largely for setting table border easier
403
- -- round: use round border characters rather than right angles
404
- -- none: does nothing
403
+ -- heavy: use thicker border characters
404
+ -- double: use double line border characters
405
+ -- round: use round border corners
406
+ -- none: does nothing
405
407
preset = ' none' ,
406
408
-- Determines how the table as a whole is rendered:
407
- -- none: disables all rendering
409
+ -- none: disables all rendering
408
410
-- normal: applies the 'cell' style rendering to each row of the table
409
- -- full: normal + a top & bottom line that fill out the table when lengths match
411
+ -- full: normal + a top & bottom line that fill out the table when lengths match
410
412
style = ' full' ,
411
413
-- Determines how individual cells of a table are rendered:
412
414
-- overlay: writes completely over the table, removing conceal behavior and highlights
413
- -- raw: replaces only the '|' characters in each row, leaving the cells unmodified
414
- -- padded: raw + cells are padded with inline extmarks to make up for any concealed text
415
+ -- raw: replaces only the '|' characters in each row, leaving the cells unmodified
416
+ -- padded: raw + cells are padded with inline extmarks to make up for any concealed text
415
417
cell = ' padded' ,
416
418
-- Gets placed in delimiter row for each column, position is based on alignmnet
417
419
alignment_indicator = ' ━' ,
@@ -434,8 +436,8 @@ require('render-markdown').setup({
434
436
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
435
437
-- Can specify as many additional values as you like following the pattern from any below, such as 'note'
436
438
-- The key in this case 'note' is for healthcheck and to allow users to change its values
437
- -- 'raw': Matched against the raw text of a 'shortcut_link', case insensitive
438
- -- 'rendered': Replaces the 'raw' value when rendering
439
+ -- 'raw': Matched against the raw text of a 'shortcut_link', case insensitive
440
+ -- 'rendered': Replaces the 'raw' value when rendering
439
441
-- 'highlight': Highlight for the 'rendered' text and quote markers
440
442
callout = {
441
443
note = { raw = ' [!NOTE]' , rendered = ' Note' , highlight = ' RenderMarkdownInfo' },
@@ -467,8 +469,8 @@ require('render-markdown').setup({
467
469
-- contains. Applies to 'inline_link' and wikilink nodes.
468
470
-- Can specify as many additional values as you like following the 'web' pattern below
469
471
-- The key in this case 'web' is for healthcheck and to allow users to change its values
470
- -- 'pattern': Matched against the destination text see :h lua-pattern
471
- -- 'icon': Gets inlined before the link text
472
+ -- 'pattern': Matched against the destination text see :h lua-pattern
473
+ -- 'icon': Gets inlined before the link text
472
474
-- 'highlight': Highlight for the 'icon'
473
475
custom = {
474
476
web = { pattern = ' ^http[s]?://' , icon = ' ' , highlight = ' RenderMarkdownLink' },
@@ -537,7 +539,7 @@ require('render-markdown').setup({
537
539
-- Turn on / off any sign column related rendering
538
540
sign = true ,
539
541
-- Determines how the icon fills the available space:
540
- -- inline: underlying '#'s are concealed resulting in a left aligned icon
542
+ -- inline: underlying '#'s are concealed resulting in a left aligned icon
541
543
-- overlay: result is left padded with spaces to hide any additional '#'
542
544
position = ' overlay' ,
543
545
-- Replaces '#+' of 'atx_h._marker'
@@ -549,7 +551,7 @@ require('render-markdown').setup({
549
551
signs = { ' ' },
550
552
-- Width of the heading background:
551
553
-- block: width of the heading text
552
- -- full: full width of the window
554
+ -- full: full width of the window
553
555
-- Can also be an array of the above values in which case the 'level' is used
554
556
-- to index into the array using a clamp
555
557
width = ' full' ,
@@ -603,21 +605,21 @@ require('render-markdown').setup({
603
605
-- Turn on / off any sign column related rendering
604
606
sign = true ,
605
607
-- Determines how code blocks & inline code are rendered:
606
- -- none: disables all rendering
607
- -- normal: adds highlight group to code blocks & inline code, adds padding to code blocks
608
+ -- none: disables all rendering
609
+ -- normal: adds highlight group to code blocks & inline code, adds padding to code blocks
608
610
-- language: adds language icon to sign column if enabled and icon + name above code blocks
609
- -- full: normal + language
611
+ -- full: normal + language
610
612
style = ' full' ,
611
613
-- Determines where language icon is rendered:
612
- -- right: Right side of code block
613
- -- left: Left side of code block
614
+ -- right: right side of code block
615
+ -- left: left side of code block
614
616
position = ' left' ,
615
617
-- An array of language names for which background highlighting will be disabled
616
618
-- Likely because that language has background highlights itself
617
619
disable_background = { ' diff' },
618
620
-- Width of the code block background:
619
621
-- block: width of the code block
620
- -- full: full width of the window
622
+ -- full: full width of the window
621
623
width = ' full' ,
622
624
-- Amount of padding to add to the left of code blocks
623
625
left_pad = 0 ,
@@ -627,7 +629,7 @@ require('render-markdown').setup({
627
629
min_width = 0 ,
628
630
-- Determins how the top / bottom of code block are rendered:
629
631
-- thick: use the same highlight as the code body
630
- -- thin: when lines are empty overlay the above & below icons
632
+ -- thin: when lines are empty overlay the above & below icons
631
633
border = ' thin' ,
632
634
-- Used above code blocks for thin border
633
635
above = ' ▄' ,
@@ -655,7 +657,7 @@ require('render-markdown').setup({
655
657
icon = ' ─' ,
656
658
-- Width of the generated line:
657
659
-- <integer>: a hard coded width value
658
- -- full: full width of the window
660
+ -- full: full width of the window
659
661
width = ' full' ,
660
662
-- Highlight for the whole line generated from the icon
661
663
highlight = ' RenderMarkdownDash' ,
@@ -714,8 +716,8 @@ require('render-markdown').setup({
714
716
-- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
715
717
-- Can specify as many additional states as you like following the 'todo' pattern below
716
718
-- The key in this case 'todo' is for healthcheck and to allow users to change its values
717
- -- 'raw': Matched against the raw text of a 'shortcut_link'
718
- -- 'rendered': Replaces the 'raw' value when rendering
719
+ -- 'raw': Matched against the raw text of a 'shortcut_link'
720
+ -- 'rendered': Replaces the 'raw' value when rendering
719
721
-- 'highlight': Highlight for the 'rendered' icon
720
722
custom = {
721
723
todo = { raw = ' [-]' , rendered = ' ' , highlight = ' RenderMarkdownTodo' },
@@ -757,18 +759,20 @@ require('render-markdown').setup({
757
759
-- Turn on / off pipe table rendering
758
760
enabled = true ,
759
761
-- Pre configured settings largely for setting table border easier
760
- -- round: use round border characters rather than right angles
761
- -- none: does nothing
762
+ -- heavy: use thicker border characters
763
+ -- double: use double line border characters
764
+ -- round: use round border corners
765
+ -- none: does nothing
762
766
preset = ' none' ,
763
767
-- Determines how the table as a whole is rendered:
764
- -- none: disables all rendering
768
+ -- none: disables all rendering
765
769
-- normal: applies the 'cell' style rendering to each row of the table
766
- -- full: normal + a top & bottom line that fill out the table when lengths match
770
+ -- full: normal + a top & bottom line that fill out the table when lengths match
767
771
style = ' full' ,
768
772
-- Determines how individual cells of a table are rendered:
769
773
-- overlay: writes completely over the table, removing conceal behavior and highlights
770
- -- raw: replaces only the '|' characters in each row, leaving the cells unmodified
771
- -- padded: raw + cells are padded with inline extmarks to make up for any concealed text
774
+ -- raw: replaces only the '|' characters in each row, leaving the cells unmodified
775
+ -- padded: raw + cells are padded with inline extmarks to make up for any concealed text
772
776
cell = ' padded' ,
773
777
-- Gets placed in delimiter row for each column, position is based on alignmnet
774
778
alignment_indicator = ' ━' ,
@@ -800,8 +804,8 @@ require('render-markdown').setup({
800
804
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
801
805
-- Can specify as many additional values as you like following the pattern from any below, such as 'note'
802
806
-- The key in this case 'note' is for healthcheck and to allow users to change its values
803
- -- 'raw': Matched against the raw text of a 'shortcut_link', case insensitive
804
- -- 'rendered': Replaces the 'raw' value when rendering
807
+ -- 'raw': Matched against the raw text of a 'shortcut_link', case insensitive
808
+ -- 'rendered': Replaces the 'raw' value when rendering
805
809
-- 'highlight': Highlight for the 'rendered' text and quote markers
806
810
callout = {
807
811
note = { raw = ' [!NOTE]' , rendered = ' Note' , highlight = ' RenderMarkdownInfo' },
@@ -842,8 +846,8 @@ require('render-markdown').setup({
842
846
-- contains. Applies to 'inline_link' and wikilink nodes.
843
847
-- Can specify as many additional values as you like following the 'web' pattern below
844
848
-- The key in this case 'web' is for healthcheck and to allow users to change its values
845
- -- 'pattern': Matched against the destination text see :h lua-pattern
846
- -- 'icon': Gets inlined before the link text
849
+ -- 'pattern': Matched against the destination text see :h lua-pattern
850
+ -- 'icon': Gets inlined before the link text
847
851
-- 'highlight': Highlight for the 'icon'
848
852
custom = {
849
853
web = { pattern = ' ^http[s]?://' , icon = ' ' , highlight = ' RenderMarkdownLink' },
0 commit comments