|
1 | | -*render-markdown.txt* For 0.10.0 Last change: 2024 October 23 |
| 1 | +*render-markdown.txt* For 0.10.0 Last change: 2024 October 24 |
2 | 2 |
|
3 | 3 | ============================================================================== |
4 | 4 | Table of Contents *render-markdown-table-of-contents* |
@@ -48,7 +48,7 @@ Plugin to improve viewing Markdown files in Neovim |
48 | 48 | - Modal rendering: changes between `rendered` and `raw` view based on mode |
49 | 49 | - Anti-conceal: hides virtual text added by this plugin on cursor line |
50 | 50 | - Window options: changes option values between `rendered` and `raw` view |
51 | | -- Large files: only renders visisble range, can be entirely disabled based on size |
| 51 | +- Large files: only renders visible range, can be entirely disabled based on size |
52 | 52 | - Custom rendering: provides extension point where user can add anything |
53 | 53 | - Renders the following `markdown` components out of the box: |
54 | 54 | - Headings: icon, color, border, padding , width |
@@ -213,7 +213,7 @@ Default Configuration ~ |
213 | 213 | }, |
214 | 214 | }, |
215 | 215 | -- Vim modes that will show a rendered view of the markdown file |
216 | | - -- All other modes will be uneffected by this plugin |
| 216 | + -- All other modes will be unaffected by this plugin |
217 | 217 | render_modes = { 'n', 'c' }, |
218 | 218 | anti_conceal = { |
219 | 219 | -- This enables hiding any added text on the line the cursor is on |
@@ -290,9 +290,9 @@ Default Configuration ~ |
290 | 290 | -- Minimum width to use for headings when width is 'block' |
291 | 291 | -- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp |
292 | 292 | min_width = 0, |
293 | | - -- Determins if a border is added above and below headings |
| 293 | + -- Determines if a border is added above and below headings |
294 | 294 | border = false, |
295 | | - -- Alway use virtual lines for heading borders instead of attempting to use empty lines |
| 295 | + -- Always use virtual lines for heading borders instead of attempting to use empty lines |
296 | 296 | border_virtual = false, |
297 | 297 | -- Highlight the start of the border using the foreground highlight |
298 | 298 | border_prefix = false, |
@@ -369,7 +369,7 @@ Default Configuration ~ |
369 | 369 | right_pad = 0, |
370 | 370 | -- Minimum width to use for code blocks when width is 'block' |
371 | 371 | min_width = 0, |
372 | | - -- Determins how the top / bottom of code block are rendered: |
| 372 | + -- Determines how the top / bottom of code block are rendered: |
373 | 373 | -- thick: use the same highlight as the code body |
374 | 374 | -- thin: when lines are empty overlay the above & below icons |
375 | 375 | border = 'thin', |
@@ -432,7 +432,7 @@ Default Configuration ~ |
432 | 432 | checked = { |
433 | 433 | -- Replaces '[x]' of 'task_list_marker_checked' |
434 | 434 | icon = ' ', |
435 | | - -- Highligh for the checked icon |
| 435 | + -- Highlight for the checked icon |
436 | 436 | highlight = 'RenderMarkdownChecked', |
437 | 437 | -- Highlight for item associated with checked checkbox |
438 | 438 | scope_highlight = nil, |
@@ -496,7 +496,7 @@ Default Configuration ~ |
496 | 496 | '└', '┴', '┘', |
497 | 497 | '│', '─', |
498 | 498 | }, |
499 | | - -- Gets placed in delimiter row for each column, position is based on alignmnet |
| 499 | + -- Gets placed in delimiter row for each column, position is based on alignment |
500 | 500 | alignment_indicator = '━', |
501 | 501 | -- Highlight for table heading, delimiter, and the line above |
502 | 502 | head = 'RenderMarkdownTableHead', |
@@ -680,9 +680,9 @@ Heading Configuration ~ |
680 | 680 | -- Minimum width to use for headings when width is 'block' |
681 | 681 | -- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp |
682 | 682 | min_width = 0, |
683 | | - -- Determins if a border is added above and below headings |
| 683 | + -- Determines if a border is added above and below headings |
684 | 684 | border = false, |
685 | | - -- Alway use virtual lines for heading borders instead of attempting to use empty lines |
| 685 | + -- Always use virtual lines for heading borders instead of attempting to use empty lines |
686 | 686 | border_virtual = false, |
687 | 687 | -- Highlight the start of the border using the foreground highlight |
688 | 688 | border_prefix = false, |
@@ -785,7 +785,7 @@ Code Block Configuration ~ |
785 | 785 | right_pad = 0, |
786 | 786 | -- Minimum width to use for code blocks when width is 'block' |
787 | 787 | min_width = 0, |
788 | | - -- Determins how the top / bottom of code block are rendered: |
| 788 | + -- Determines how the top / bottom of code block are rendered: |
789 | 789 | -- thick: use the same highlight as the code body |
790 | 790 | -- thin: when lines are empty overlay the above & below icons |
791 | 791 | border = 'thin', |
@@ -887,7 +887,7 @@ Checkbox Configuration ~ |
887 | 887 | checked = { |
888 | 888 | -- Replaces '[x]' of 'task_list_marker_checked' |
889 | 889 | icon = ' ', |
890 | | - -- Highligh for the checked icon |
| 890 | + -- Highlight for the checked icon |
891 | 891 | highlight = 'RenderMarkdownChecked', |
892 | 892 | -- Highlight for item associated with checked checkbox |
893 | 893 | scope_highlight = nil, |
@@ -977,7 +977,7 @@ Table Configuration ~ |
977 | 977 | '└', '┴', '┘', |
978 | 978 | '│', '─', |
979 | 979 | }, |
980 | | - -- Gets placed in delimiter row for each column, position is based on alignmnet |
| 980 | + -- Gets placed in delimiter row for each column, position is based on alignment |
981 | 981 | alignment_indicator = '━', |
982 | 982 | -- Highlight for table heading, delimiter, and the line above |
983 | 983 | head = 'RenderMarkdownTableHead', |
|
0 commit comments