3
3
<!-- Badges (replace with actual badges) -->
4
4
5
5
[ ![ Lua] ( https://img.shields.io/badge/Lua-blue.svg?style=flat-square&logo=lua )] ( https://www.lua.org )
6
- [ ![ License] ( https://img.shields.io/github/license/magnusriga/markdown-shortcuts .nvim?style=flat-square )] ( LICENSE )
6
+ [ ![ License] ( https://img.shields.io/github/license/magnusriga/markdown-tools .nvim?style=flat-square )] ( LICENSE )
7
7
8
8
> Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands.
9
9
22
22
## ⚡️ Requirements
23
23
24
24
- Neovim >= 0.8.0
25
- - Optional: A picker plugin (` fzf ` / ` fzf.vim ` , ` telescope.nvim ` , or ` mini.pick ` ) for the template creation feature.
25
+ - Optional: A picker plugin (` fzf-lua ` , ` telescope.nvim ` , or ` mini.pick ` ) for the template creation feature.
26
26
- Optional: An external Markdown preview tool (like ` glow ` , ` pandoc ` , etc.) if using the ` MarkdownPreview ` command.
27
27
28
28
## 📦 Installation
@@ -35,16 +35,14 @@ Use your favorite plugin manager.
35
35
{
36
36
' magnusriga/markdown-tools.nvim' ,
37
37
-- Optional dependencies for picker:
38
+ -- dependencies = { 'folke/snacks.nvim' },
39
+ -- dependencies = { 'ibhagwan/fzf-lua' },
38
40
-- dependencies = { 'nvim-telescope/telescope.nvim' },
39
- -- dependencies = { 'junegunn/fzf', 'junegunn/fzf.vim' },
40
- -- dependencies = { 'echasnovski/mini.nvim' }, -- If using mini.pick
41
- event = " FileType markdown" , -- Load when a markdown file is opened
42
- config = function ()
43
- require (' markdown-shortcuts' ).setup ({
41
+ opts = {
44
42
-- Your custom configuration here
45
43
-- Example: Use Telescope for template picking
46
44
-- picker = 'telescope',
47
- })
45
+ }
48
46
end ,
49
47
}
50
48
```
@@ -53,14 +51,14 @@ Use your favorite plugin manager.
53
51
54
52
``` lua
55
53
use {
56
- ' magnusriga/markdown-shortcuts .nvim' ,
54
+ ' magnusriga/markdown-tools .nvim' ,
57
55
-- Optional dependencies:
56
+ -- requires = { 'folke/snacks.nvim' },
57
+ -- requires = { 'ibhagwan/fzf-lua' },
58
58
-- requires = { 'nvim-telescope/telescope.nvim' },
59
- -- requires = { 'junegunn/fzf', run = ':call fzf#install()' },
60
- -- requires = { 'echasnovski/mini.nvim' },
61
59
ft = { " markdown" },
62
60
config = function ()
63
- require (' markdown-shortcuts ' ).setup ({
61
+ require (' markdown-tools ' ).setup ({
64
62
-- Configuration goes here
65
63
})
66
64
end ,
@@ -73,7 +71,7 @@ Call the `setup` function to configure the plugin. Here are the default settings
73
71
74
72
``` lua
75
73
-- Default configuration
76
- require (' markdown-shortcuts ' ).setup ({
74
+ require (' markdown-tools ' ).setup ({
77
75
-- Directory containing your Markdown templates
78
76
template_dir = vim .fn .expand (" ~/.config/nvim/templates" ),
79
77
0 commit comments