Skip to content

Commit 13b7de5

Browse files
authored
docs: better install instructions for lazy.nvim (#80)
* docs: better install instructions for lazy.nvim - `ft` ensures the plugin is only loaded in markdown files - `main` defines the module name used in the `setup` call, we can use `opts` instead of `config` (cleaner & preferred method of configuring plugins in lazy.nvim) - consequently, we are able to replace `config` with `opts`. reference: https://lazy.folke.io/spec#spec-setup * docs: add trailing comma in lazy.nvim install snippet * docs: no ft for lazy.nvim installation
1 parent ecd5253 commit 13b7de5

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,13 @@ Plugin to improve viewing Markdown files in Neovim
6060
```lua
6161
{
6262
'MeanderingProgrammer/markdown.nvim',
63+
main = "render-markdown",
64+
opts = {},
6365
name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
6466
dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
6567
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
6668
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
67-
config = function()
68-
require('render-markdown').setup({})
69-
end,
70-
}
69+
},
7170
```
7271

7372
## packer.nvim

0 commit comments

Comments
 (0)