@@ -173,6 +173,10 @@ Some of the more useful fields are discussed further down.
173
173
require (' render-markdown' ).setup ({
174
174
-- Whether Markdown should be rendered by default or not
175
175
enabled = true ,
176
+ -- Vim modes that will show a rendered view of the markdown file, :h mode(), for
177
+ -- all enabled components. Individual components can be enabled for other modes.
178
+ -- Remaining modes will be unaffected by this plugin.
179
+ render_modes = { ' n' , ' c' , ' t' },
176
180
-- Maximum file size (in MB) that this plugin will attempt to render
177
181
-- Any file larger than this will effectively be ignored
178
182
max_file_size = 10.0 ,
@@ -207,9 +211,6 @@ require('render-markdown').setup({
207
211
]] ,
208
212
},
209
213
},
210
- -- Vim modes that will show a rendered view of the markdown file, :h mode()
211
- -- All other modes will be unaffected by this plugin
212
- render_modes = { ' n' , ' c' , ' t' },
213
214
anti_conceal = {
214
215
-- This enables hiding any added text on the line the cursor is on
215
216
enabled = true ,
@@ -234,6 +235,8 @@ require('render-markdown').setup({
234
235
latex = {
235
236
-- Whether LaTeX should be rendered, mainly used for health check
236
237
enabled = true ,
238
+ -- Additional modes to render LaTeX
239
+ render_modes = false ,
237
240
-- Executable used to convert latex formula to rendered unicode
238
241
converter = ' latex2text' ,
239
242
-- Highlight for LaTeX blocks
@@ -252,6 +255,8 @@ require('render-markdown').setup({
252
255
heading = {
253
256
-- Turn on / off heading icon & background rendering
254
257
enabled = true ,
258
+ -- Additional modes to render headings
259
+ render_modes = false ,
255
260
-- Turn on / off any sign column related rendering
256
261
sign = true ,
257
262
-- Determines how icons fill the available space:
@@ -323,6 +328,8 @@ require('render-markdown').setup({
323
328
paragraph = {
324
329
-- Turn on / off paragraph rendering
325
330
enabled = true ,
331
+ -- Additional modes to render paragraphs
332
+ render_modes = false ,
326
333
-- Amount of margin to add to the left of paragraphs
327
334
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
328
335
left_margin = 0 ,
@@ -332,6 +339,8 @@ require('render-markdown').setup({
332
339
code = {
333
340
-- Turn on / off code block & inline code rendering
334
341
enabled = true ,
342
+ -- Additional modes to render code blocks
343
+ render_modes = false ,
335
344
-- Turn on / off any sign column related rendering
336
345
sign = true ,
337
346
-- Determines how code blocks & inline code are rendered:
@@ -391,6 +400,8 @@ require('render-markdown').setup({
391
400
dash = {
392
401
-- Turn on / off thematic break rendering
393
402
enabled = true ,
403
+ -- Additional modes to render dash
404
+ render_modes = false ,
394
405
-- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
395
406
-- The icon gets repeated across the window's width
396
407
icon = ' ─' ,
@@ -408,6 +419,8 @@ require('render-markdown').setup({
408
419
bullet = {
409
420
-- Turn on / off list bullet rendering
410
421
enabled = true ,
422
+ -- Additional modes to render list bullets
423
+ render_modes = false ,
411
424
-- Replaces '-'|'+'|'*' of 'list_item'
412
425
-- How deeply nested the list is determines the 'level', how far down at that level determines the 'index'
413
426
-- If a function is provided both of these values are passed in using 1 based indexing
@@ -437,6 +450,8 @@ require('render-markdown').setup({
437
450
checkbox = {
438
451
-- Turn on / off checkbox state rendering
439
452
enabled = true ,
453
+ -- Additional modes to render checkboxes
454
+ render_modes = false ,
440
455
-- Determines how icons fill the available space:
441
456
-- inline: underlying text is concealed resulting in a left aligned icon
442
457
-- overlay: result is left padded with spaces to hide any additional text
@@ -472,6 +487,8 @@ require('render-markdown').setup({
472
487
quote = {
473
488
-- Turn on / off block quote & callout rendering
474
489
enabled = true ,
490
+ -- Additional modes to render quotes
491
+ render_modes = false ,
475
492
-- Replaces '>' of 'block_quote'
476
493
icon = ' ▋' ,
477
494
-- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
@@ -486,6 +503,8 @@ require('render-markdown').setup({
486
503
pipe_table = {
487
504
-- Turn on / off pipe table rendering
488
505
enabled = true ,
506
+ -- Additional modes to render pipe tables
507
+ render_modes = false ,
489
508
-- Pre configured settings largely for setting table border easier
490
509
-- heavy: use thicker border characters
491
510
-- double: use double line border characters
@@ -565,6 +584,8 @@ require('render-markdown').setup({
565
584
link = {
566
585
-- Turn on / off inline link icon rendering
567
586
enabled = true ,
587
+ -- Additional modes to render links
588
+ render_modes = false ,
568
589
-- How to handle footnote links, start with a '^'
569
590
footnote = {
570
591
-- Replace value with superscript equivalent
@@ -613,6 +634,8 @@ require('render-markdown').setup({
613
634
inline_highlight = {
614
635
-- Turn on / off inline highlight rendering
615
636
enabled = true ,
637
+ -- Additional modes to render inline highlights
638
+ render_modes = false ,
616
639
-- Applies to background of surrounded text
617
640
highlight = ' RenderMarkdownInlineHighlight' ,
618
641
},
@@ -621,6 +644,8 @@ require('render-markdown').setup({
621
644
indent = {
622
645
-- Turn on / off org-indent-mode
623
646
enabled = false ,
647
+ -- Additional modes to render indents
648
+ render_modes = false ,
624
649
-- Amount of additional padding added for each heading level
625
650
per_level = 2 ,
626
651
-- Heading levels <= this value will not be indented
@@ -632,6 +657,8 @@ require('render-markdown').setup({
632
657
html = {
633
658
-- Turn on / off all HTML rendering
634
659
enabled = true ,
660
+ -- Additional modes to render HTML
661
+ render_modes = false ,
635
662
comment = {
636
663
-- Turn on / off HTML comment concealing
637
664
conceal = true ,
@@ -663,7 +690,7 @@ require('render-markdown').setup({
663
690
-- if no override is provided. Supports the following fields:
664
691
-- enabled, max_file_size, debounce, render_modes, anti_conceal, padding,
665
692
-- heading, paragraph, code, dash, bullet, checkbox, quote, pipe_table,
666
- -- callout, link, sign, indent, html, win_options
693
+ -- callout, link, sign, indent, latex, html, win_options
667
694
overrides = {
668
695
-- Overrides for different buftypes, see :h 'buftype'
669
696
buftype = {
@@ -703,6 +730,8 @@ require('render-markdown').setup({
703
730
heading = {
704
731
-- Turn on / off heading icon & background rendering
705
732
enabled = true ,
733
+ -- Additional modes to render headings
734
+ render_modes = false ,
706
735
-- Turn on / off any sign column related rendering
707
736
sign = true ,
708
737
-- Determines how icons fill the available space:
@@ -789,6 +818,8 @@ require('render-markdown').setup({
789
818
paragraph = {
790
819
-- Turn on / off paragraph rendering
791
820
enabled = true ,
821
+ -- Additional modes to render paragraphs
822
+ render_modes = false ,
792
823
-- Amount of margin to add to the left of paragraphs
793
824
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
794
825
left_margin = 0 ,
@@ -813,6 +844,8 @@ require('render-markdown').setup({
813
844
code = {
814
845
-- Turn on / off code block & inline code rendering
815
846
enabled = true ,
847
+ -- Additional modes to render code blocks
848
+ render_modes = false ,
816
849
-- Turn on / off any sign column related rendering
817
850
sign = true ,
818
851
-- Determines how code blocks & inline code are rendered:
@@ -887,6 +920,8 @@ require('render-markdown').setup({
887
920
dash = {
888
921
-- Turn on / off thematic break rendering
889
922
enabled = true ,
923
+ -- Additional modes to render dash
924
+ render_modes = false ,
890
925
-- Replaces '---'|'***'|'___'|'* * *' of 'thematic_break'
891
926
-- The icon gets repeated across the window's width
892
927
icon = ' ─' ,
@@ -919,6 +954,8 @@ require('render-markdown').setup({
919
954
bullet = {
920
955
-- Turn on / off list bullet rendering
921
956
enabled = true ,
957
+ -- Additional modes to render list bullets
958
+ render_modes = false ,
922
959
-- Replaces '-'|'+'|'*' of 'list_item'
923
960
-- How deeply nested the list is determines the 'level', how far down at that level determines the 'index'
924
961
-- If a function is provided both of these values are passed in using 1 based indexing
@@ -963,6 +1000,8 @@ require('render-markdown').setup({
963
1000
checkbox = {
964
1001
-- Turn on / off checkbox state rendering
965
1002
enabled = true ,
1003
+ -- Additional modes to render checkboxes
1004
+ render_modes = false ,
966
1005
-- Determines how icons fill the available space:
967
1006
-- inline: underlying text is concealed resulting in a left aligned icon
968
1007
-- overlay: result is left padded with spaces to hide any additional text
@@ -1013,6 +1052,8 @@ require('render-markdown').setup({
1013
1052
quote = {
1014
1053
-- Turn on / off block quote & callout rendering
1015
1054
enabled = true ,
1055
+ -- Additional modes to render quotes
1056
+ render_modes = false ,
1016
1057
-- Replaces '>' of 'block_quote'
1017
1058
icon = ' ▋' ,
1018
1059
-- Whether to repeat icon on wrapped lines. Requires neovim >= 0.10. This will obscure text if
@@ -1042,6 +1083,8 @@ require('render-markdown').setup({
1042
1083
pipe_table = {
1043
1084
-- Turn on / off pipe table rendering
1044
1085
enabled = true ,
1086
+ -- Additional modes to render pipe tables
1087
+ render_modes = false ,
1045
1088
-- Pre configured settings largely for setting table border easier
1046
1089
-- heavy: use thicker border characters
1047
1090
-- double: use double line border characters
@@ -1151,6 +1194,8 @@ require('render-markdown').setup({
1151
1194
link = {
1152
1195
-- Turn on / off inline link icon rendering
1153
1196
enabled = true ,
1197
+ -- Additional modes to render links
1198
+ render_modes = false ,
1154
1199
-- How to handle footnote links, start with a '^'
1155
1200
footnote = {
1156
1201
-- Replace value with superscript equivalent
@@ -1229,6 +1274,8 @@ require('render-markdown').setup({
1229
1274
indent = {
1230
1275
-- Turn on / off org-indent-mode
1231
1276
enabled = false ,
1277
+ -- Additional modes to render indents
1278
+ render_modes = false ,
1232
1279
-- Amount of additional padding added for each heading level
1233
1280
per_level = 2 ,
1234
1281
-- Heading levels <= this value will not be indented
0 commit comments