Skip to content

Commit d72575b

Browse files
chore: update docs and healthcheck
## Details Minor updates following: #272
1 parent 931b5e3 commit d72575b

File tree

6 files changed

+36
-14
lines changed

6 files changed

+36
-14
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,21 @@
77
- nvim-cmp completion source [3d2dc15](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/3d2dc15542e56671dd14dfbfff63434ec21d8fcd)
88
- blink.cmp completion source [3d2dc15](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/3d2dc15542e56671dd14dfbfff63434ec21d8fcd)
99
- coq_nvim completion source [#258](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/258)
10-
[75cdf9d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/75cdf9d2b049f0e27440bd78cc52b39acd15cd6e)
10+
[#259](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/259) [75cdf9d](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/75cdf9d2b049f0e27440bd78cc52b39acd15cd6e)
11+
- dash width and margin percent [#272](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/272)
1112

1213
### Bug Fixes
1314

1415
- nil check for window [#257](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/257)
1516
[eb8fdac](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/eb8fdace39e6eab96037539aace272f14e40fd80)
17+
- check buffer is valid when getting name [#260](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/260)
18+
[0022a57](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/0022a579ac7355966be5ade77699b88c76b6a549)
1619

1720
### Collaborator Shoutouts
1821

1922
- @argizuno
2023
- @TheLeoP
24+
- @Kurama622
2125

2226
## 7.7.0 (2024-12-07)
2327

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -391,9 +391,9 @@ require('render-markdown').setup({
391391
-- The icon gets repeated across the window's width
392392
icon = '',
393393
-- Width of the generated line:
394+
-- <number>: a hard coded width value, if a floating point value < 1 is provided it is
395+
-- treated as a percentage of the available window space
394396
-- full: full width of the window
395-
-- <number>: a hard coded width value
396-
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
397397
width = 'full',
398398
-- Amount of margin to add to the left of dash
399399
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
@@ -885,9 +885,13 @@ require('render-markdown').setup({
885885
-- The icon gets repeated across the window's width
886886
icon = '',
887887
-- Width of the generated line:
888-
-- <integer>: a hard coded width value
889-
-- full: full width of the window
888+
-- <number>: a hard coded width value, if a floating point value < 1 is provided it is
889+
-- treated as a percentage of the available window space
890+
-- full: full width of the window
890891
width = 'full',
892+
-- Amount of margin to add to the left of dash
893+
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
894+
left_margin = 0,
891895
-- Highlight for the whole line generated from the icon
892896
highlight = 'RenderMarkdownDash',
893897
},

doc/render-markdown.txt

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For 0.10.0 Last change: 2024 December 13
1+
*render-markdown.txt* For 0.10.0 Last change: 2024 December 24
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -447,9 +447,13 @@ Default Configuration ~
447447
-- The icon gets repeated across the window's width
448448
icon = '─',
449449
-- Width of the generated line:
450-
-- <integer>: a hard coded width value
451-
-- full: full width of the window
450+
-- <number>: a hard coded width value, if a floating point value < 1 is provided it is
451+
-- treated as a percentage of the available window space
452+
-- full: full width of the window
452453
width = 'full',
454+
-- Amount of margin to add to the left of dash
455+
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
456+
left_margin = 0,
453457
-- Highlight for the whole line generated from the icon
454458
highlight = 'RenderMarkdownDash',
455459
},
@@ -929,9 +933,13 @@ Dashed Line Configuration ~
929933
-- The icon gets repeated across the window's width
930934
icon = '─',
931935
-- Width of the generated line:
932-
-- <integer>: a hard coded width value
933-
-- full: full width of the window
936+
-- <number>: a hard coded width value, if a floating point value < 1 is provided it is
937+
-- treated as a percentage of the available window space
938+
-- full: full width of the window
934939
width = 'full',
940+
-- Amount of margin to add to the left of dash
941+
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
942+
left_margin = 0,
935943
-- Highlight for the whole line generated from the icon
936944
highlight = 'RenderMarkdownDash',
937945
},

lua/render-markdown/health.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
44
local M = {}
55

66
---@private
7-
M.version = '7.7.4'
7+
M.version = '7.7.5'
88

99
function M.check()
1010
M.start('version')

lua/render-markdown/init.lua

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,8 @@ local M = {}
144144
---@class (exact) render.md.UserDash
145145
---@field public enabled? boolean
146146
---@field public icon? string
147-
---@field public width? 'full'|integer
147+
---@field public width? 'full'|number
148+
---@field public left_margin? number
148149
---@field public highlight? string
149150

150151
---@alias render.md.code.Style 'full'|'normal'|'language'|'none'
@@ -492,9 +493,13 @@ M.default_config = {
492493
-- The icon gets repeated across the window's width
493494
icon = '',
494495
-- Width of the generated line:
495-
-- <integer>: a hard coded width value
496-
-- full: full width of the window
496+
-- <number>: a hard coded width value, if a floating point value < 1 is provided it is
497+
-- treated as a percentage of the available window space
498+
-- full: full width of the window
497499
width = 'full',
500+
-- Amount of margin to add to the left of dash
501+
-- If a floating point value < 1 is provided it is treated as a percentage of the available window space
502+
left_margin = 0,
498503
-- Highlight for the whole line generated from the icon
499504
highlight = 'RenderMarkdownDash',
500505
},

lua/render-markdown/state.lua

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ function M.validate()
180180
end)
181181
:nested('dash', function(dash)
182182
dash:type('enabled', 'boolean')
183+
:type('left_margin', 'number')
183184
:type({ 'icon', 'highlight' }, 'string')
184185
:one_of('width', { 'full' }, 'number')
185186
:check()

0 commit comments

Comments
 (0)