@@ -7,6 +7,7 @@ Table of Contents *grapple.nvim-table-of-contents*
7
7
- Introduction | grapple.nvim-grapple.nvim-introduction |
8
8
- Features | grapple.nvim-grapple.nvim-features |
9
9
- Requirements | grapple.nvim-grapple.nvim-requirements |
10
+ - Quickstart | grapple.nvim-grapple.nvim-quickstart |
10
11
- Installation | grapple.nvim-grapple.nvim-installation |
11
12
- Default Settings | grapple.nvim-grapple.nvim-default-settings |
12
13
- File Tags | grapple.nvim-grapple.nvim-file-tags |
@@ -32,10 +33,7 @@ files (and its last known cursor location) by means of persistent
32
33
can be bound to a | grapple.nvim-keymap | or selected from within an editable
33
34
| grapple.nvim-popup-menu | .
34
35
35
- To get started, | grapple.nvim-install | the plugin using your preferred package
36
- manager and give it a go! Default settings for the plugin can be found in the
37
- | grapple.nvim-settings | section below. The API provided by Grapple can be found
38
- in the | grapple.nvim-usage | section below.
36
+ See the | grapple.nvim-quickstart | section to get started.
39
37
40
38
41
39
FEATURES *grapple.nvim-grapple.nvim-features*
@@ -55,10 +53,35 @@ REQUIREMENTS *grapple.nvim-grapple.nvim-requirements*
55
53
- plenary.nvim <https://github.com/nvim-lua/plenary.nvim >
56
54
57
55
56
+ QUICKSTART *grapple.nvim-grapple.nvim-quickstart*
57
+
58
+
59
+ - | grapple.nvim-install | Grapple.nvim using your preferred package manager
60
+ - Add a keybind to | grapple.nvim-create | , | grapple.nvim-delete | , or | grapple.nvim-toggle | a tag. For example,
61
+ `lua vim.keymap.set("n", "<leader> m", require("grapple").toggle)`
62
+
63
+ **Next steps**
64
+
65
+
66
+ - The default settings can be found in the | grapple.nvim-settings | section
67
+ - The Grapple API can be found in the | grapple.nvim-usage | section
68
+ - View your tags | grapple.nvim-in-a-popup | using `:GrapplePopup tags`
69
+ - Add a | grapple.nvim-grapple-component | to your statusline
70
+ - Choose a | grapple.nvim-builtin | scope or try your hand at creating a | grapple.nvim-custom | scope to store your tags
71
+
72
+
58
73
INSTALLATION *grapple.nvim-grapple.nvim-installation*
59
74
75
+ lazy.nvim ~
60
76
61
- PACKER ~
77
+ >lua
78
+ {
79
+ "cbochs/grapple.nvim",
80
+ dependencies = { "nvim-lua/plenary.nvim" },
81
+ }
82
+ <
83
+
84
+ packer ~
62
85
63
86
>lua
64
87
use {
@@ -67,8 +90,7 @@ PACKER ~
67
90
}
68
91
<
69
92
70
-
71
- VIM-PLUG ~
93
+ vim-plug ~
72
94
73
95
>vim
74
96
Plug "nvim-lua/plenary.nvim"
@@ -785,7 +807,7 @@ SUGGESTED KEYMAPS *grapple.nvim-grapple.nvim-suggested-keymaps*
785
807
ANONYMOUS TAG KEYMAPS
786
808
787
809
>lua
788
- vim.keymap.set("n", "<leader> m", require("grapple").toggle, {} )
810
+ vim.keymap.set("n", "<leader> m", require("grapple").toggle)
789
811
<
790
812
791
813
@@ -794,11 +816,11 @@ NAMED TAG KEYMAPS
794
816
>lua
795
817
vim.keymap.set("n", "<leader> j", function()
796
818
require("grapple").select({ key = "{name} " })
797
- end, {} )
819
+ end)
798
820
799
821
vim.keymap.set("n", "<leader> J", function()
800
822
require("grapple").toggle({ key = "{name} " })
801
- end, {} )
823
+ end)
802
824
<
803
825
804
826
0 commit comments