Skip to content

Commit b36cf8b

Browse files
cbochsgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent fa7f903 commit b36cf8b

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

doc/grapple.nvim.txt

+32-10
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Table of Contents *grapple.nvim-table-of-contents*
77
- Introduction |grapple.nvim-grapple.nvim-introduction|
88
- Features |grapple.nvim-grapple.nvim-features|
99
- Requirements |grapple.nvim-grapple.nvim-requirements|
10+
- Quickstart |grapple.nvim-grapple.nvim-quickstart|
1011
- Installation |grapple.nvim-grapple.nvim-installation|
1112
- Default Settings |grapple.nvim-grapple.nvim-default-settings|
1213
- File Tags |grapple.nvim-grapple.nvim-file-tags|
@@ -32,10 +33,7 @@ files (and its last known cursor location) by means of persistent
3233
can be bound to a |grapple.nvim-keymap| or selected from within an editable
3334
|grapple.nvim-popup-menu|.
3435

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.
3937

4038

4139
FEATURES *grapple.nvim-grapple.nvim-features*
@@ -55,10 +53,35 @@ REQUIREMENTS *grapple.nvim-grapple.nvim-requirements*
5553
- plenary.nvim <https://github.com/nvim-lua/plenary.nvim>
5654

5755

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+
5873
INSTALLATION *grapple.nvim-grapple.nvim-installation*
5974

75+
lazy.nvim ~
6076

61-
PACKER ~
77+
>lua
78+
{
79+
"cbochs/grapple.nvim",
80+
dependencies = { "nvim-lua/plenary.nvim" },
81+
}
82+
<
83+
84+
packer ~
6285

6386
>lua
6487
use {
@@ -67,8 +90,7 @@ PACKER ~
6790
}
6891
<
6992

70-
71-
VIM-PLUG ~
93+
vim-plug ~
7294

7395
>vim
7496
Plug "nvim-lua/plenary.nvim"
@@ -785,7 +807,7 @@ SUGGESTED KEYMAPS *grapple.nvim-grapple.nvim-suggested-keymaps*
785807
ANONYMOUS TAG KEYMAPS
786808

787809
>lua
788-
vim.keymap.set("n", "<leader>m", require("grapple").toggle, {})
810+
vim.keymap.set("n", "<leader>m", require("grapple").toggle)
789811
<
790812

791813

@@ -794,11 +816,11 @@ NAMED TAG KEYMAPS
794816
>lua
795817
vim.keymap.set("n", "<leader>j", function()
796818
require("grapple").select({ key = "{name}" })
797-
end, {})
819+
end)
798820

799821
vim.keymap.set("n", "<leader>J", function()
800822
require("grapple").toggle({ key = "{name}" })
801-
end, {})
823+
end)
802824
<
803825

804826

0 commit comments

Comments
 (0)