Skip to content

Commit 8790a38

Browse files
chore: add doc for link pattern matching
1 parent 401a6c9 commit 8790a38

File tree

4 files changed

+17
-10
lines changed

4 files changed

+17
-10
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
[f3cda24](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/f3cda24c71261f6a52f5ddafb95786684d862d87)
1212
- expand default custom links [#245](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/245)
1313
[61850bf](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/61850bf7df4af8398e97559a35b62378ba8435b1)
14+
- bare URLs in angle brackets [#244](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/244)
15+
[401a6c9](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/401a6c9c4cf39e22b8487503dd7dfe37fc7fb064)
1416

1517
### Bug Fixes
1618

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -521,14 +521,15 @@ require('render-markdown').setup({
521521
image = '󰥶 ',
522522
-- Inlined with 'email_autolink' elements
523523
email = '󰀓 ',
524-
-- Fallback icon for 'inline_link' elements
524+
-- Fallback icon for 'inline_link' and 'uri_autolink' elements
525525
hyperlink = '󰌹 ',
526526
-- Applies to the inlined icon as a fallback
527527
highlight = 'RenderMarkdownLink',
528528
-- Applies to WikiLink elements
529529
wiki = { icon = '󱗖 ', highlight = 'RenderMarkdownWikiLink' },
530530
-- Define custom destination patterns so icons can quickly inform you of what a link
531-
-- contains. Applies to 'inline_link' and wikilink nodes.
531+
-- contains. Applies to 'inline_link', 'uri_autolink', and wikilink nodes. When multiple
532+
-- patterns match a link the one with the longer pattern is used.
532533
-- Can specify as many additional values as you like following the 'web' pattern below
533534
-- The key in this case 'web' is for healthcheck and to allow users to change its values
534535
-- 'pattern': Matched against the destination text see :h lua-pattern
@@ -1080,14 +1081,15 @@ require('render-markdown').setup({
10801081
image = '󰥶 ',
10811082
-- Inlined with 'email_autolink' elements
10821083
email = '󰀓 ',
1083-
-- Fallback icon for 'inline_link' elements
1084+
-- Fallback icon for 'inline_link' and 'uri_autolink' elements
10841085
hyperlink = '󰌹 ',
10851086
-- Applies to the inlined icon as a fallback
10861087
highlight = 'RenderMarkdownLink',
10871088
-- Applies to WikiLink elements
10881089
wiki = { icon = '󱗖 ', highlight = 'RenderMarkdownWikiLink' },
10891090
-- Define custom destination patterns so icons can quickly inform you of what a link
1090-
-- contains. Applies to 'inline_link' and wikilink nodes.
1091+
-- contains. Applies to 'inline_link', 'uri_autolink', and wikilink nodes. When multiple
1092+
-- patterns match a link the one with the longer pattern is used.
10911093
-- Can specify as many additional values as you like following the 'web' pattern below
10921094
-- The key in this case 'web' is for healthcheck and to allow users to change its values
10931095
-- 'pattern': Matched against the destination text see :h lua-pattern

doc/render-markdown.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -568,14 +568,15 @@ Default Configuration ~
568568
image = '󰥶 ',
569569
-- Inlined with 'email_autolink' elements
570570
email = '󰀓 ',
571-
-- Fallback icon for 'inline_link' elements
571+
-- Fallback icon for 'inline_link' and 'uri_autolink' elements
572572
hyperlink = '󰌹 ',
573573
-- Applies to the inlined icon as a fallback
574574
highlight = 'RenderMarkdownLink',
575575
-- Applies to WikiLink elements
576576
wiki = { icon = '󱗖 ', highlight = 'RenderMarkdownWikiLink' },
577577
-- Define custom destination patterns so icons can quickly inform you of what a link
578-
-- contains. Applies to 'inline_link' and wikilink nodes.
578+
-- contains. Applies to 'inline_link', 'uri_autolink', and wikilink nodes. When multiple
579+
-- patterns match a link the one with the longer pattern is used.
579580
-- Can specify as many additional values as you like following the 'web' pattern below
580581
-- The key in this case 'web' is for healthcheck and to allow users to change its values
581582
-- 'pattern': Matched against the destination text see :h lua-pattern
@@ -1107,14 +1108,15 @@ Link Configuration ~
11071108
image = '󰥶 ',
11081109
-- Inlined with 'email_autolink' elements
11091110
email = '󰀓 ',
1110-
-- Fallback icon for 'inline_link' elements
1111+
-- Fallback icon for 'inline_link' and 'uri_autolink' elements
11111112
hyperlink = '󰌹 ',
11121113
-- Applies to the inlined icon as a fallback
11131114
highlight = 'RenderMarkdownLink',
11141115
-- Applies to WikiLink elements
11151116
wiki = { icon = '󱗖 ', highlight = 'RenderMarkdownWikiLink' },
11161117
-- Define custom destination patterns so icons can quickly inform you of what a link
1117-
-- contains. Applies to 'inline_link' and wikilink nodes.
1118+
-- contains. Applies to 'inline_link', 'uri_autolink', and wikilink nodes. When multiple
1119+
-- patterns match a link the one with the longer pattern is used.
11181120
-- Can specify as many additional values as you like following the 'web' pattern below
11191121
-- The key in this case 'web' is for healthcheck and to allow users to change its values
11201122
-- 'pattern': Matched against the destination text see :h lua-pattern

lua/render-markdown/init.lua

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -645,14 +645,15 @@ M.default_config = {
645645
image = '󰥶 ',
646646
-- Inlined with 'email_autolink' elements
647647
email = '󰀓 ',
648-
-- Fallback icon for 'inline_link' elements
648+
-- Fallback icon for 'inline_link' and 'uri_autolink' elements
649649
hyperlink = '󰌹 ',
650650
-- Applies to the inlined icon as a fallback
651651
highlight = 'RenderMarkdownLink',
652652
-- Applies to WikiLink elements
653653
wiki = { icon = '󱗖 ', highlight = 'RenderMarkdownWikiLink' },
654654
-- Define custom destination patterns so icons can quickly inform you of what a link
655-
-- contains. Applies to 'inline_link' and wikilink nodes.
655+
-- contains. Applies to 'inline_link', 'uri_autolink', and wikilink nodes. When multiple
656+
-- patterns match a link the one with the longer pattern is used.
656657
-- Can specify as many additional values as you like following the 'web' pattern below
657658
-- The key in this case 'web' is for healthcheck and to allow users to change its values
658659
-- 'pattern': Matched against the destination text see :h lua-pattern

0 commit comments

Comments
 (0)