Skip to content

Commit aeb5cec

Browse files
committedAug 5, 2024
render-markdown now the repo name as well, I really should've done this sooner
But better late than never :P
1 parent af67ac5 commit aeb5cec

File tree

6 files changed

+23
-26
lines changed

6 files changed

+23
-26
lines changed
 

‎README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# markdown.nvim
1+
# render-markdown.nvim
22

33
Plugin to improve viewing Markdown files in Neovim
44

@@ -63,10 +63,8 @@ Plugin to improve viewing Markdown files in Neovim
6363

6464
```lua
6565
{
66-
'MeanderingProgrammer/markdown.nvim',
67-
main = "render-markdown",
66+
'MeanderingProgrammer/render-markdown.nvim',
6867
opts = {},
69-
name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
7068
dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
7169
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
7270
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
@@ -77,6 +75,8 @@ Plugin to improve viewing Markdown files in Neovim
7775

7876
This plugin is available on [LuaRocks](https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim)
7977

78+
- TODO: Publish this under both packages?
79+
8080
```vim
8181
:Rocks install markdown.nvim
8282
```
@@ -85,8 +85,7 @@ This plugin is available on [LuaRocks](https://luarocks.org/modules/MeanderingPr
8585

8686
```lua
8787
use({
88-
'MeanderingProgrammer/markdown.nvim',
89-
as = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
88+
'MeanderingProgrammer/render-markdown.nvim',
9089
after = { 'nvim-treesitter' },
9190
requires = { 'echasnovski/mini.nvim', opt = true }, -- if you use the mini.nvim suite
9291
-- requires = { 'echasnovski/mini.icons', opt = true }, -- if you use standalone mini plugins
@@ -852,8 +851,7 @@ The table below shows all the highlight groups with their default link
852851
>
853852
> ```lua
854853
> return {
855-
> 'MeanderingProgrammer/markdown.nvim',
856-
> name = 'render-markdown',
854+
> 'MeanderingProgrammer/render-markdown.nvim',
857855
> cmd = { 'RenderMarkdown' },
858856
> dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' },
859857
> config = function()

‎doc/render-markdown.txt

+7-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
55

6-
1. markdown.nvim |render-markdown-markdown.nvim|
6+
1. render-markdown.nvim |render-markdown-render-markdown.nvim|
77
2. Features |render-markdown-features|
88
3. Requirements |render-markdown-requirements|
99
4. Install |render-markdown-install|
@@ -30,7 +30,7 @@ Table of Contents *render-markdown-table-of-contents*
3030
- Additional |render-markdown-info-additional|
3131

3232
==============================================================================
33-
1. markdown.nvim *render-markdown-markdown.nvim*
33+
1. render-markdown.nvim *render-markdown-render-markdown.nvim*
3434

3535
Plugin to improve viewing Markdown files in Neovim
3636

@@ -90,10 +90,8 @@ LAZY.NVIM *render-markdown-install-lazy.nvim*
9090

9191
>lua
9292
{
93-
'MeanderingProgrammer/markdown.nvim',
94-
main = "render-markdown",
93+
'MeanderingProgrammer/render-markdown.nvim',
9594
opts = {},
96-
name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
9795
dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
9896
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
9997
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
@@ -106,6 +104,8 @@ ROCKS.NVIM *render-markdown-install-rocks.nvim*
106104
This plugin is available on LuaRocks
107105
<https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim>
108106

107+
- TODO: Publish this under both packages?
108+
109109
>vim
110110
:Rocks install markdown.nvim
111111
<
@@ -115,8 +115,7 @@ PACKER.NVIM *render-markdown-install-packer.nvim*
115115

116116
>lua
117117
use({
118-
'MeanderingProgrammer/markdown.nvim',
119-
as = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
118+
'MeanderingProgrammer/render-markdown.nvim',
120119
after = { 'nvim-treesitter' },
121120
requires = { 'echasnovski/mini.nvim', opt = true }, -- if you use the mini.nvim suite
122121
-- requires = { 'echasnovski/mini.icons', opt = true }, -- if you use standalone mini plugins
@@ -932,8 +931,7 @@ OBSIDIAN.NVIM *render-markdown-info-obsidian.nvim*
932931
things like this can break at any time given the reliance on internal logic:
933932
>lua
934933
return {
935-
'MeanderingProgrammer/markdown.nvim',
936-
name = 'render-markdown',
934+
'MeanderingProgrammer/render-markdown.nvim',
937935
cmd = { 'RenderMarkdown' },
938936
dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' },
939937
config = function()

‎doc/todo.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
alignment info.
55
- Figure out how to display the many configuration options & impact, Wiki in progress
66
- Potentially change LuaRocks icon dependency to [mini.icons](https://luarocks.org/modules/neorocks/mini.icons)
7+
- Rename plugin refernces in relevant places, fun :[

‎lua/render-markdown/health.lua

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ local M = {}
88
M.version = '5.1.4'
99

1010
function M.check()
11-
vim.health.start('markdown.nvim [version]')
11+
vim.health.start('render-markdown.nvim [version]')
1212
vim.health.ok('plugin ' .. M.version)
1313
M.neovim('0.9', '0.10')
1414

15-
vim.health.start('markdown.nvim [configuration]')
15+
vim.health.start('render-markdown.nvim [configuration]')
1616
local errors = state.validate()
1717
if #errors == 0 then
1818
vim.health.ok('valid')
@@ -24,7 +24,7 @@ function M.check()
2424
local latex = state.latex
2525
local latex_advice = 'Disable LaTeX support to avoid this warning by setting { latex = { enabled = false } }'
2626

27-
vim.health.start('markdown.nvim [nvim-treesitter]')
27+
vim.health.start('render-markdown.nvim [nvim-treesitter]')
2828
local has_treesitter = pcall(require, 'nvim-treesitter')
2929
if has_treesitter then
3030
vim.health.ok('installed')
@@ -39,14 +39,14 @@ function M.check()
3939
vim.health.error('not installed')
4040
end
4141

42-
vim.health.start('markdown.nvim [executables]')
42+
vim.health.start('render-markdown.nvim [executables]')
4343
if latex.enabled then
4444
M.check_executable(latex.converter, latex_advice)
4545
else
4646
vim.health.ok('none to check')
4747
end
4848

49-
vim.health.start('markdown.nvim [conflicts]')
49+
vim.health.start('render-markdown.nvim [conflicts]')
5050
if state.acknowledge_conflicts then
5151
vim.health.ok('conflicts acknowledged')
5252
else

‎lua/render-markdown/ui.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ function M.parse_tree(buf, language, root)
165165
-- TODO: remove call to render & parse nil check
166166
---@diagnostic disable-next-line: undefined-field
167167
if user_handler.render ~= nil then
168-
local message = 'markdown.nvim: custom_handlers render is deprecated use parse instead'
168+
local message = 'render-markdown.nvim: custom_handlers render is deprecated use parse instead'
169169
message = message .. ', will be fully removed on 2024-08-19'
170170
vim.notify_once(message, vim.log.levels.ERROR)
171171
---@diagnostic disable-next-line: undefined-field

‎plugin/render-markdown.lua

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ vim.api.nvim_create_user_command('RenderMarkdown', function(opts)
1616
if command ~= nil then
1717
command()
1818
else
19-
vim.notify('markdown.nvim: unexpected command: ' .. args[1], vim.log.levels.ERROR)
19+
vim.notify('render-markdown.nvim: unexpected command: ' .. args[1], vim.log.levels.ERROR)
2020
end
2121
else
22-
vim.notify('markdown.nvim: unexpected # arguments: ' .. #args, vim.log.levels.ERROR)
22+
vim.notify('render-markdown.nvim: unexpected # arguments: ' .. #args, vim.log.levels.ERROR)
2323
end
2424
end, {
2525
nargs = '*',
26-
desc = 'markdown.nvim commands',
26+
desc = 'render-markdown.nvim commands',
2727
complete = function(_, cmdline)
2828
if cmdline:find('RenderMarkdown%s+%S+%s+.*') then
2929
return {}

0 commit comments

Comments
 (0)