Skip to content

Commit 07685a1

Browse files
Breaking change: Rename root folder to render-markdown, changes require statement
## Details The original name markdown has a larger potential for naming collisions, to avoid this have decided to fix this problem early on and rename the root folder which changes the require statement to require('render-markdown') instead of require('markdown'). Sorry to any early users :( The plugin name as a whole markdown.nvim can also collide, have updated instructions for lazy to specify a name, though this is not necessary in all cases.
1 parent acc2259 commit 07685a1

File tree

5 files changed

+5
-4
lines changed

5 files changed

+5
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ Plugin to improve viewing Markdown files in Neovim
2626
```lua
2727
{
2828
'MeanderingProgrammer/markdown.nvim',
29+
name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
2930
dependencies = { 'nvim-treesitter/nvim-treesitter' },
3031
config = function()
31-
require('markdown').setup({})
32+
require('render-markdown').setup({})
3233
end,
3334
}
3435
```
@@ -39,7 +40,7 @@ Below is the configuration that gets used by default, any part of it can be modi
3940
by the user.
4041

4142
```lua
42-
require('markdown').setup({
43+
require('render-markdown').setup({
4344
-- Capture groups that get pulled from the markdown file, these are later
4445
-- used to modify how the file gets rendered
4546
query = vim.treesitter.query.parse(
File renamed without changes.

lua/markdown/init.lua renamed to lua/render-markdown/init.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
local list = require('markdown.list')
2-
local state = require('markdown.state')
1+
local list = require('render-markdown.list')
2+
local state = require('render-markdown.state')
33

44
local M = {}
55

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)