@@ -188,13 +188,13 @@ require('render-markdown').setup({
188
188
-- unaffected by this plugin.
189
189
render_modes = { ' n' , ' c' , ' t' },
190
190
-- Maximum file size (in MB) that this plugin will attempt to render.
191
- -- Any file larger than this will effectively be ignored.
191
+ -- File larger than this will effectively be ignored.
192
192
max_file_size = 10.0 ,
193
193
-- Milliseconds that must pass before updating marks, updates occur.
194
194
-- within the context of the visible window, not the entire buffer.
195
195
debounce = 100 ,
196
196
-- Pre configured settings that will attempt to mimic various target user experiences.
197
- -- Any user provided settings will take precedence.
197
+ -- User provided settings will take precedence.
198
198
-- | obsidian | mimic Obsidian UI |
199
199
-- | lazy | will attempt to stay up to date with LazyVim configuration |
200
200
-- | none | does nothing |
@@ -240,7 +240,7 @@ require('render-markdown').setup({
240
240
},
241
241
},
242
242
anti_conceal = {
243
- -- This enables hiding any added text on the line the cursor is on.
243
+ -- This enables hiding added text on the line the cursor is on.
244
244
enabled = true ,
245
245
-- Modes to disable anti conceal feature.
246
246
disabled_modes = false ,
@@ -333,17 +333,17 @@ require('render-markdown').setup({
333
333
atx = true ,
334
334
-- Turn on / off setext heading rendering.
335
335
setext = true ,
336
- -- Turn on / off any sign column related rendering.
336
+ -- Turn on / off sign column related rendering.
337
337
sign = true ,
338
338
-- Replaces '#+' of 'atx_h._marker'.
339
339
-- Output is evaluated depending on the type.
340
340
-- | function | `value(context)` |
341
341
-- | string[] | `cycle(value, context.level)` |
342
342
icons = { ' ' , ' ' , ' ' , ' ' , ' ' , ' ' },
343
343
-- Determines how icons fill the available space.
344
- -- | right | '#'s are concealed and icon is appended to right side |
345
- -- | inline | '#'s are concealed and icon is inlined on left side |
346
- -- | overlay | icon is left padded with spaces and inserted on left hiding any additional '#' |
344
+ -- | right | '#'s are concealed and icon is appended to right side |
345
+ -- | inline | '#'s are concealed and icon is inlined on left side |
346
+ -- | overlay | icon is left padded with spaces and inserted on left hiding additional '#' |
347
347
position = ' overlay' ,
348
348
-- Added to the sign column if enabled.
349
349
-- Output is evaluated by `cycle(value, context.level)`.
@@ -432,17 +432,11 @@ require('render-markdown').setup({
432
432
enabled = true ,
433
433
-- Additional modes to render code blocks.
434
434
render_modes = false ,
435
- -- Turn on / off any sign column related rendering.
435
+ -- Turn on / off sign column related rendering.
436
436
sign = true ,
437
- -- Determines how code blocks & inline code are rendered.
438
- -- | none | disables all rendering |
439
- -- | normal | background highlighting + padding |
440
- -- | language | language heading with icon + sign column |
441
- -- | full | normal + language |
442
- style = ' full' ,
443
437
-- Whether to conceal nodes at the top and bottom of code blocks.
444
438
conceal_delimiters = true ,
445
- -- Turn on / off any language heading related rendering.
439
+ -- Turn on / off language heading related rendering.
446
440
language = true ,
447
441
-- Determines where language icon is rendered.
448
442
-- | right | right side of code block |
@@ -494,6 +488,8 @@ require('render-markdown').setup({
494
488
above = ' ▄' ,
495
489
-- Used below code blocks for thin border.
496
490
below = ' ▀' ,
491
+ -- Turn on / off inline code related rendering.
492
+ inline = true ,
497
493
-- Icon to add to the left of inline code.
498
494
inline_left = ' ' ,
499
495
-- Icon to add to the right of inline code.
@@ -512,6 +508,12 @@ require('render-markdown').setup({
512
508
highlight_fallback = ' RenderMarkdownCodeFallback' ,
513
509
-- Highlight for inline code.
514
510
highlight_inline = ' RenderMarkdownCodeInline' ,
511
+ -- Determines how code blocks & inline code are rendered.
512
+ -- | none | { enabled = false } |
513
+ -- | normal | { language = false } |
514
+ -- | language | { disable_background = true, inline = false } |
515
+ -- | full | uses all default values |
516
+ style = ' full' ,
515
517
},
516
518
dash = {
517
519
-- Turn on / off thematic break rendering.
@@ -664,11 +666,6 @@ require('render-markdown').setup({
664
666
-- | round | use round border corners |
665
667
-- | none | does nothing |
666
668
preset = ' none' ,
667
- -- Determines how the table as a whole is rendered.
668
- -- | none | disables all rendering |
669
- -- | normal | applies the 'cell' style rendering to each row of the table |
670
- -- | full | normal + a top & bottom line that fill out the table when lengths match |
671
- style = ' full' ,
672
669
-- Determines how individual cells of a table are rendered.
673
670
-- | overlay | writes completely over the table, removing conceal behavior and highlights |
674
671
-- | raw | replaces only the '|' characters in each row, leaving the cells unmodified |
@@ -688,6 +685,8 @@ require('render-markdown').setup({
688
685
' └' , ' ┴' , ' ┘' ,
689
686
' │' , ' ─' ,
690
687
},
688
+ -- Turn on / off top & bottom lines.
689
+ border_enabled = true ,
691
690
-- Always use virtual lines for table borders instead of attempting to use empty lines.
692
691
-- Will be automatically enabled if indentation module is enabled.
693
692
border_virtual = false ,
@@ -699,6 +698,11 @@ require('render-markdown').setup({
699
698
row = ' RenderMarkdownTableRow' ,
700
699
-- Highlight for inline padding used to add back concealed space.
701
700
filler = ' RenderMarkdownTableFill' ,
701
+ -- Determines how the table as a whole is rendered.
702
+ -- | none | { enabled = false } |
703
+ -- | normal | { border_enabled = false } |
704
+ -- | full | uses all default values |
705
+ style = ' full' ,
702
706
},
703
707
callout = {
704
708
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'.
@@ -930,17 +934,17 @@ require('render-markdown').setup({
930
934
atx = true ,
931
935
-- Turn on / off setext heading rendering.
932
936
setext = true ,
933
- -- Turn on / off any sign column related rendering.
937
+ -- Turn on / off sign column related rendering.
934
938
sign = true ,
935
939
-- Replaces '#+' of 'atx_h._marker'.
936
940
-- Output is evaluated depending on the type.
937
941
-- | function | `value(context)` |
938
942
-- | string[] | `cycle(value, context.level)` |
939
943
icons = { ' ' , ' ' , ' ' , ' ' , ' ' , ' ' },
940
944
-- Determines how icons fill the available space.
941
- -- | right | '#'s are concealed and icon is appended to right side |
942
- -- | inline | '#'s are concealed and icon is inlined on left side |
943
- -- | overlay | icon is left padded with spaces and inserted on left hiding any additional '#' |
945
+ -- | right | '#'s are concealed and icon is appended to right side |
946
+ -- | inline | '#'s are concealed and icon is inlined on left side |
947
+ -- | overlay | icon is left padded with spaces and inserted on left hiding additional '#' |
944
948
position = ' overlay' ,
945
949
-- Added to the sign column if enabled.
946
950
-- Output is evaluated by `cycle(value, context.level)`.
@@ -1059,17 +1063,11 @@ require('render-markdown').setup({
1059
1063
enabled = true ,
1060
1064
-- Additional modes to render code blocks.
1061
1065
render_modes = false ,
1062
- -- Turn on / off any sign column related rendering.
1066
+ -- Turn on / off sign column related rendering.
1063
1067
sign = true ,
1064
- -- Determines how code blocks & inline code are rendered.
1065
- -- | none | disables all rendering |
1066
- -- | normal | background highlighting + padding |
1067
- -- | language | language heading with icon + sign column |
1068
- -- | full | normal + language |
1069
- style = ' full' ,
1070
1068
-- Whether to conceal nodes at the top and bottom of code blocks.
1071
1069
conceal_delimiters = true ,
1072
- -- Turn on / off any language heading related rendering.
1070
+ -- Turn on / off language heading related rendering.
1073
1071
language = true ,
1074
1072
-- Determines where language icon is rendered.
1075
1073
-- | right | right side of code block |
@@ -1121,6 +1119,8 @@ require('render-markdown').setup({
1121
1119
above = ' ▄' ,
1122
1120
-- Used below code blocks for thin border.
1123
1121
below = ' ▀' ,
1122
+ -- Turn on / off inline code related rendering.
1123
+ inline = true ,
1124
1124
-- Icon to add to the left of inline code.
1125
1125
inline_left = ' ' ,
1126
1126
-- Icon to add to the right of inline code.
@@ -1139,6 +1139,12 @@ require('render-markdown').setup({
1139
1139
highlight_fallback = ' RenderMarkdownCodeFallback' ,
1140
1140
-- Highlight for inline code.
1141
1141
highlight_inline = ' RenderMarkdownCodeInline' ,
1142
+ -- Determines how code blocks & inline code are rendered.
1143
+ -- | none | { enabled = false } |
1144
+ -- | normal | { language = false } |
1145
+ -- | language | { disable_background = true, inline = false } |
1146
+ -- | full | uses all default values |
1147
+ style = ' full' ,
1142
1148
},
1143
1149
})
1144
1150
```
@@ -1352,11 +1358,6 @@ require('render-markdown').setup({
1352
1358
-- | round | use round border corners |
1353
1359
-- | none | does nothing |
1354
1360
preset = ' none' ,
1355
- -- Determines how the table as a whole is rendered.
1356
- -- | none | disables all rendering |
1357
- -- | normal | applies the 'cell' style rendering to each row of the table |
1358
- -- | full | normal + a top & bottom line that fill out the table when lengths match |
1359
- style = ' full' ,
1360
1361
-- Determines how individual cells of a table are rendered.
1361
1362
-- | overlay | writes completely over the table, removing conceal behavior and highlights |
1362
1363
-- | raw | replaces only the '|' characters in each row, leaving the cells unmodified |
@@ -1376,6 +1377,8 @@ require('render-markdown').setup({
1376
1377
' └' , ' ┴' , ' ┘' ,
1377
1378
' │' , ' ─' ,
1378
1379
},
1380
+ -- Turn on / off top & bottom lines.
1381
+ border_enabled = true ,
1379
1382
-- Always use virtual lines for table borders instead of attempting to use empty lines.
1380
1383
-- Will be automatically enabled if indentation module is enabled.
1381
1384
border_virtual = false ,
@@ -1387,6 +1390,11 @@ require('render-markdown').setup({
1387
1390
row = ' RenderMarkdownTableRow' ,
1388
1391
-- Highlight for inline padding used to add back concealed space.
1389
1392
filler = ' RenderMarkdownTableFill' ,
1393
+ -- Determines how the table as a whole is rendered.
1394
+ -- | none | { enabled = false } |
1395
+ -- | normal | { border_enabled = false } |
1396
+ -- | full | uses all default values |
1397
+ style = ' full' ,
1390
1398
},
1391
1399
})
1392
1400
```
0 commit comments