Skip to content

Commit 3bacd99

Browse files
feat: add double and heavy pipe table presets
1 parent c4eb6bf commit 3bacd99

File tree

7 files changed

+153
-120
lines changed

7 files changed

+153
-120
lines changed

Diff for: CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- min_width code block option [4b80b4f](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/4b80b4fb8f81dc39da23a13a0b4e971731c5f849)
99
- left_pad bullet option [e455c4f](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/e455c4f4886d250bd610165a24524da2c6adce80)
1010
- preset option, obsidian & lazy [96988cc](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/96988cc76414a2f69a57c5dbaca7bf9336c9cb52)
11+
- pipe table preset option [c4eb6bf](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/c4eb6bf30525fdc7efaf5f33bcb0fa9491ace245)
1112
- left_pad, right_pad, & min_width heading options [#121](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/121)
1213
[6392a5d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/6392a5dfa10f367e10fe58ea9c2faf3179b145d5)
1314
- border heading option [#123](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/123)

Diff for: README.md

+50-46
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@ require('render-markdown').setup({
155155
-- Pre configured settings that will attempt to mimic various target
156156
-- user experiences. Any user provided settings will take precedence.
157157
-- 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
160160
preset = 'none',
161161
-- Capture groups that get pulled from markdown
162162
markdown_query = [[
@@ -234,7 +234,7 @@ require('render-markdown').setup({
234234
-- Turn on / off any sign column related rendering
235235
sign = true,
236236
-- 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
238238
-- overlay: result is left padded with spaces to hide any additional '#'
239239
position = 'overlay',
240240
-- Replaces '#+' of 'atx_h._marker'
@@ -246,7 +246,7 @@ require('render-markdown').setup({
246246
signs = { '󰫎 ' },
247247
-- Width of the heading background:
248248
-- block: width of the heading text
249-
-- full: full width of the window
249+
-- full: full width of the window
250250
-- Can also be an array of the above values in which case the 'level' is used
251251
-- to index into the array using a clamp
252252
width = 'full',
@@ -291,21 +291,21 @@ require('render-markdown').setup({
291291
-- Turn on / off any sign column related rendering
292292
sign = true,
293293
-- 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
296296
-- language: adds language icon to sign column if enabled and icon + name above code blocks
297-
-- full: normal + language
297+
-- full: normal + language
298298
style = 'full',
299299
-- 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
302302
position = 'left',
303303
-- An array of language names for which background highlighting will be disabled
304304
-- Likely because that language has background highlights itself
305305
disable_background = { 'diff' },
306306
-- Width of the code block background:
307307
-- block: width of the code block
308-
-- full: full width of the window
308+
-- full: full width of the window
309309
width = 'full',
310310
-- Amount of padding to add to the left of code blocks
311311
left_pad = 0,
@@ -315,7 +315,7 @@ require('render-markdown').setup({
315315
min_width = 0,
316316
-- Determins how the top / bottom of code block are rendered:
317317
-- 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
319319
border = 'thin',
320320
-- Used above code blocks for thin border
321321
above = '',
@@ -334,7 +334,7 @@ require('render-markdown').setup({
334334
icon = '',
335335
-- Width of the generated line:
336336
-- <integer>: a hard coded width value
337-
-- full: full width of the window
337+
-- full: full width of the window
338338
width = 'full',
339339
-- Highlight for the whole line generated from the icon
340340
highlight = 'RenderMarkdownDash',
@@ -375,8 +375,8 @@ require('render-markdown').setup({
375375
-- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
376376
-- Can specify as many additional states as you like following the 'todo' pattern below
377377
-- 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
380380
-- 'highlight': Highlight for the 'rendered' icon
381381
custom = {
382382
todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
@@ -400,18 +400,20 @@ require('render-markdown').setup({
400400
-- Turn on / off pipe table rendering
401401
enabled = true,
402402
-- 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
405407
preset = 'none',
406408
-- Determines how the table as a whole is rendered:
407-
-- none: disables all rendering
409+
-- none: disables all rendering
408410
-- 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
410412
style = 'full',
411413
-- Determines how individual cells of a table are rendered:
412414
-- 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
415417
cell = 'padded',
416418
-- Gets placed in delimiter row for each column, position is based on alignmnet
417419
alignment_indicator = '',
@@ -434,8 +436,8 @@ require('render-markdown').setup({
434436
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
435437
-- Can specify as many additional values as you like following the pattern from any below, such as 'note'
436438
-- 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
439441
-- 'highlight': Highlight for the 'rendered' text and quote markers
440442
callout = {
441443
note = { raw = '[!NOTE]', rendered = '󰋽 Note', highlight = 'RenderMarkdownInfo' },
@@ -467,8 +469,8 @@ require('render-markdown').setup({
467469
-- contains. Applies to 'inline_link' and wikilink nodes.
468470
-- Can specify as many additional values as you like following the 'web' pattern below
469471
-- 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
472474
-- 'highlight': Highlight for the 'icon'
473475
custom = {
474476
web = { pattern = '^http[s]?://', icon = '󰖟 ', highlight = 'RenderMarkdownLink' },
@@ -537,7 +539,7 @@ require('render-markdown').setup({
537539
-- Turn on / off any sign column related rendering
538540
sign = true,
539541
-- 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
541543
-- overlay: result is left padded with spaces to hide any additional '#'
542544
position = 'overlay',
543545
-- Replaces '#+' of 'atx_h._marker'
@@ -549,7 +551,7 @@ require('render-markdown').setup({
549551
signs = { '󰫎 ' },
550552
-- Width of the heading background:
551553
-- block: width of the heading text
552-
-- full: full width of the window
554+
-- full: full width of the window
553555
-- Can also be an array of the above values in which case the 'level' is used
554556
-- to index into the array using a clamp
555557
width = 'full',
@@ -603,21 +605,21 @@ require('render-markdown').setup({
603605
-- Turn on / off any sign column related rendering
604606
sign = true,
605607
-- 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
608610
-- language: adds language icon to sign column if enabled and icon + name above code blocks
609-
-- full: normal + language
611+
-- full: normal + language
610612
style = 'full',
611613
-- 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
614616
position = 'left',
615617
-- An array of language names for which background highlighting will be disabled
616618
-- Likely because that language has background highlights itself
617619
disable_background = { 'diff' },
618620
-- Width of the code block background:
619621
-- block: width of the code block
620-
-- full: full width of the window
622+
-- full: full width of the window
621623
width = 'full',
622624
-- Amount of padding to add to the left of code blocks
623625
left_pad = 0,
@@ -627,7 +629,7 @@ require('render-markdown').setup({
627629
min_width = 0,
628630
-- Determins how the top / bottom of code block are rendered:
629631
-- 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
631633
border = 'thin',
632634
-- Used above code blocks for thin border
633635
above = '',
@@ -655,7 +657,7 @@ require('render-markdown').setup({
655657
icon = '',
656658
-- Width of the generated line:
657659
-- <integer>: a hard coded width value
658-
-- full: full width of the window
660+
-- full: full width of the window
659661
width = 'full',
660662
-- Highlight for the whole line generated from the icon
661663
highlight = 'RenderMarkdownDash',
@@ -714,8 +716,8 @@ require('render-markdown').setup({
714716
-- As a result this requires neovim >= 0.10.0 since it relies on 'inline' extmarks
715717
-- Can specify as many additional states as you like following the 'todo' pattern below
716718
-- 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
719721
-- 'highlight': Highlight for the 'rendered' icon
720722
custom = {
721723
todo = { raw = '[-]', rendered = '󰥔 ', highlight = 'RenderMarkdownTodo' },
@@ -757,18 +759,20 @@ require('render-markdown').setup({
757759
-- Turn on / off pipe table rendering
758760
enabled = true,
759761
-- 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
762766
preset = 'none',
763767
-- Determines how the table as a whole is rendered:
764-
-- none: disables all rendering
768+
-- none: disables all rendering
765769
-- 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
767771
style = 'full',
768772
-- Determines how individual cells of a table are rendered:
769773
-- 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
772776
cell = 'padded',
773777
-- Gets placed in delimiter row for each column, position is based on alignmnet
774778
alignment_indicator = '',
@@ -800,8 +804,8 @@ require('render-markdown').setup({
800804
-- Callouts are a special instance of a 'block_quote' that start with a 'shortcut_link'
801805
-- Can specify as many additional values as you like following the pattern from any below, such as 'note'
802806
-- 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
805809
-- 'highlight': Highlight for the 'rendered' text and quote markers
806810
callout = {
807811
note = { raw = '[!NOTE]', rendered = '󰋽 Note', highlight = 'RenderMarkdownInfo' },
@@ -842,8 +846,8 @@ require('render-markdown').setup({
842846
-- contains. Applies to 'inline_link' and wikilink nodes.
843847
-- Can specify as many additional values as you like following the 'web' pattern below
844848
-- 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
847851
-- 'highlight': Highlight for the 'icon'
848852
custom = {
849853
web = { pattern = '^http[s]?://', icon = '󰖟 ', highlight = 'RenderMarkdownLink' },

0 commit comments

Comments
 (0)