Skip to content

Commit 435b1ed

Browse files
chore: fix spelling
1 parent 34044cd commit 435b1ed

File tree

4 files changed

+32
-32
lines changed

4 files changed

+32
-32
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Plugin to improve viewing Markdown files in Neovim
2222
- Modal rendering: changes between `rendered` and `raw` view based on mode
2323
- Anti-conceal: hides virtual text added by this plugin on cursor line
2424
- Window options: changes option values between `rendered` and `raw` view
25-
- Large files: only renders visisble range, can be entirely disabled based on size
25+
- Large files: only renders visible range, can be entirely disabled based on size
2626
- Custom rendering: provides extension point where user can add anything
2727
- Renders the following `markdown` components out of the box:
2828
- Headings: icon, color, border, padding [^1], width
@@ -164,7 +164,7 @@ require('render-markdown').setup({
164164
},
165165
},
166166
-- Vim modes that will show a rendered view of the markdown file
167-
-- All other modes will be uneffected by this plugin
167+
-- All other modes will be unaffected by this plugin
168168
render_modes = { 'n', 'c' },
169169
anti_conceal = {
170170
-- This enables hiding any added text on the line the cursor is on
@@ -241,9 +241,9 @@ require('render-markdown').setup({
241241
-- Minimum width to use for headings when width is 'block'
242242
-- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp
243243
min_width = 0,
244-
-- Determins if a border is added above and below headings
244+
-- Determines if a border is added above and below headings
245245
border = false,
246-
-- Alway use virtual lines for heading borders instead of attempting to use empty lines
246+
-- Always use virtual lines for heading borders instead of attempting to use empty lines
247247
border_virtual = false,
248248
-- Highlight the start of the border using the foreground highlight
249249
border_prefix = false,
@@ -320,7 +320,7 @@ require('render-markdown').setup({
320320
right_pad = 0,
321321
-- Minimum width to use for code blocks when width is 'block'
322322
min_width = 0,
323-
-- Determins how the top / bottom of code block are rendered:
323+
-- Determines how the top / bottom of code block are rendered:
324324
-- thick: use the same highlight as the code body
325325
-- thin: when lines are empty overlay the above & below icons
326326
border = 'thin',
@@ -383,7 +383,7 @@ require('render-markdown').setup({
383383
checked = {
384384
-- Replaces '[x]' of 'task_list_marker_checked'
385385
icon = '󰱒 ',
386-
-- Highligh for the checked icon
386+
-- Highlight for the checked icon
387387
highlight = 'RenderMarkdownChecked',
388388
-- Highlight for item associated with checked checkbox
389389
scope_highlight = nil,
@@ -447,7 +447,7 @@ require('render-markdown').setup({
447447
'', '', '',
448448
'', '',
449449
},
450-
-- Gets placed in delimiter row for each column, position is based on alignmnet
450+
-- Gets placed in delimiter row for each column, position is based on alignment
451451
alignment_indicator = '',
452452
-- Highlight for table heading, delimiter, and the line above
453453
head = 'RenderMarkdownTableHead',
@@ -633,9 +633,9 @@ require('render-markdown').setup({
633633
-- Minimum width to use for headings when width is 'block'
634634
-- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp
635635
min_width = 0,
636-
-- Determins if a border is added above and below headings
636+
-- Determines if a border is added above and below headings
637637
border = false,
638-
-- Alway use virtual lines for heading borders instead of attempting to use empty lines
638+
-- Always use virtual lines for heading borders instead of attempting to use empty lines
639639
border_virtual = false,
640640
-- Highlight the start of the border using the foreground highlight
641641
border_prefix = false,
@@ -742,7 +742,7 @@ require('render-markdown').setup({
742742
right_pad = 0,
743743
-- Minimum width to use for code blocks when width is 'block'
744744
min_width = 0,
745-
-- Determins how the top / bottom of code block are rendered:
745+
-- Determines how the top / bottom of code block are rendered:
746746
-- thick: use the same highlight as the code body
747747
-- thin: when lines are empty overlay the above & below icons
748748
border = 'thin',
@@ -850,7 +850,7 @@ require('render-markdown').setup({
850850
checked = {
851851
-- Replaces '[x]' of 'task_list_marker_checked'
852852
icon = '󰱒 ',
853-
-- Highligh for the checked icon
853+
-- Highlight for the checked icon
854854
highlight = 'RenderMarkdownChecked',
855855
-- Highlight for item associated with checked checkbox
856856
scope_highlight = nil,
@@ -944,7 +944,7 @@ require('render-markdown').setup({
944944
'', '', '',
945945
'', '',
946946
},
947-
-- Gets placed in delimiter row for each column, position is based on alignmnet
947+
-- Gets placed in delimiter row for each column, position is based on alignment
948948
alignment_indicator = '',
949949
-- Highlight for table heading, delimiter, and the line above
950950
head = 'RenderMarkdownTableHead',

doc/limitations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[ISSUE #6](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/6)
66

7-
`LaTeX` formula evaluations are placed above text rather than overlayed.
7+
`LaTeX` formula evaluations are placed above text rather than overlaid.
88

99
A way around this is to use a separate plugin for `LaTeX` and disable that feature
1010
in this plugin. Different plugins will have different setups, below are some examples:

doc/render-markdown.txt

Lines changed: 13 additions & 13 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 23
1+
*render-markdown.txt* For 0.10.0 Last change: 2024 October 24
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -48,7 +48,7 @@ Plugin to improve viewing Markdown files in Neovim
4848
- Modal rendering: changes between `rendered` and `raw` view based on mode
4949
- Anti-conceal: hides virtual text added by this plugin on cursor line
5050
- 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
5252
- Custom rendering: provides extension point where user can add anything
5353
- Renders the following `markdown` components out of the box:
5454
- Headings: icon, color, border, padding , width
@@ -213,7 +213,7 @@ Default Configuration ~
213213
},
214214
},
215215
-- 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
217217
render_modes = { 'n', 'c' },
218218
anti_conceal = {
219219
-- This enables hiding any added text on the line the cursor is on
@@ -290,9 +290,9 @@ Default Configuration ~
290290
-- Minimum width to use for headings when width is 'block'
291291
-- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp
292292
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
294294
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
296296
border_virtual = false,
297297
-- Highlight the start of the border using the foreground highlight
298298
border_prefix = false,
@@ -369,7 +369,7 @@ Default Configuration ~
369369
right_pad = 0,
370370
-- Minimum width to use for code blocks when width is 'block'
371371
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:
373373
-- thick: use the same highlight as the code body
374374
-- thin: when lines are empty overlay the above & below icons
375375
border = 'thin',
@@ -432,7 +432,7 @@ Default Configuration ~
432432
checked = {
433433
-- Replaces '[x]' of 'task_list_marker_checked'
434434
icon = '󰱒 ',
435-
-- Highligh for the checked icon
435+
-- Highlight for the checked icon
436436
highlight = 'RenderMarkdownChecked',
437437
-- Highlight for item associated with checked checkbox
438438
scope_highlight = nil,
@@ -496,7 +496,7 @@ Default Configuration ~
496496
'└', '┴', '┘',
497497
'│', '─',
498498
},
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
500500
alignment_indicator = '━',
501501
-- Highlight for table heading, delimiter, and the line above
502502
head = 'RenderMarkdownTableHead',
@@ -680,9 +680,9 @@ Heading Configuration ~
680680
-- Minimum width to use for headings when width is 'block'
681681
-- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp
682682
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
684684
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
686686
border_virtual = false,
687687
-- Highlight the start of the border using the foreground highlight
688688
border_prefix = false,
@@ -785,7 +785,7 @@ Code Block Configuration ~
785785
right_pad = 0,
786786
-- Minimum width to use for code blocks when width is 'block'
787787
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:
789789
-- thick: use the same highlight as the code body
790790
-- thin: when lines are empty overlay the above & below icons
791791
border = 'thin',
@@ -887,7 +887,7 @@ Checkbox Configuration ~
887887
checked = {
888888
-- Replaces '[x]' of 'task_list_marker_checked'
889889
icon = '󰱒 ',
890-
-- Highligh for the checked icon
890+
-- Highlight for the checked icon
891891
highlight = 'RenderMarkdownChecked',
892892
-- Highlight for item associated with checked checkbox
893893
scope_highlight = nil,
@@ -977,7 +977,7 @@ Table Configuration ~
977977
'└', '┴', '┘',
978978
'│', '─',
979979
},
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
981981
alignment_indicator = '━',
982982
-- Highlight for table heading, delimiter, and the line above
983983
head = 'RenderMarkdownTableHead',

lua/render-markdown/init.lua

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ M.default_config = {
279279
},
280280
},
281281
-- Vim modes that will show a rendered view of the markdown file
282-
-- All other modes will be uneffected by this plugin
282+
-- All other modes will be unaffected by this plugin
283283
render_modes = { 'n', 'c' },
284284
anti_conceal = {
285285
-- This enables hiding any added text on the line the cursor is on
@@ -356,9 +356,9 @@ M.default_config = {
356356
-- Minimum width to use for headings when width is 'block'
357357
-- Can also be a list of integers in which case the 'level' is used to index into the list using a clamp
358358
min_width = 0,
359-
-- Determins if a border is added above and below headings
359+
-- Determines if a border is added above and below headings
360360
border = false,
361-
-- Alway use virtual lines for heading borders instead of attempting to use empty lines
361+
-- Always use virtual lines for heading borders instead of attempting to use empty lines
362362
border_virtual = false,
363363
-- Highlight the start of the border using the foreground highlight
364364
border_prefix = false,
@@ -435,7 +435,7 @@ M.default_config = {
435435
right_pad = 0,
436436
-- Minimum width to use for code blocks when width is 'block'
437437
min_width = 0,
438-
-- Determins how the top / bottom of code block are rendered:
438+
-- Determines how the top / bottom of code block are rendered:
439439
-- thick: use the same highlight as the code body
440440
-- thin: when lines are empty overlay the above & below icons
441441
border = 'thin',
@@ -498,7 +498,7 @@ M.default_config = {
498498
checked = {
499499
-- Replaces '[x]' of 'task_list_marker_checked'
500500
icon = '󰱒 ',
501-
-- Highligh for the checked icon
501+
-- Highlight for the checked icon
502502
highlight = 'RenderMarkdownChecked',
503503
-- Highlight for item associated with checked checkbox
504504
scope_highlight = nil,
@@ -562,7 +562,7 @@ M.default_config = {
562562
'', '', '',
563563
'', '',
564564
},
565-
-- Gets placed in delimiter row for each column, position is based on alignmnet
565+
-- Gets placed in delimiter row for each column, position is based on alignment
566566
alignment_indicator = '',
567567
-- Highlight for table heading, delimiter, and the line above
568568
head = 'RenderMarkdownTableHead',

0 commit comments

Comments
 (0)