Neovim plugin improving access to clipboard history (mirror)
doc: auto-generate vimdoc
+21
-6
+21
-6
doc/yankbank-nvim.txt
+21
-6
doc/yankbank-nvim.txt
···
1
-
*yankbank-nvim.txt* For Neovim >= 0.7.0 Last change: 2024 August 31
1
+
*yankbank-nvim.txt* For Neovim >= 0.7.0 Last change: 2024 September 12
2
2
3
3
==============================================================================
4
4
Table of Contents *yankbank-nvim-table-of-contents*
···
157
157
}
158
158
<
159
159
160
+
Note:The database can be cleared with the `:YankBankClearDB` command or by
161
+
deleting the db file (found in the plugin install directory by default).
162
+
163
+
If you run into any SQL related issues, please file an issue on GitHub. (As a
164
+
temporary fix, you can also try clearing the database)
165
+
160
166
161
167
USAGE *yankbank-nvim-yankbank-usage*
162
168
163
-
Thepopup menu can be opened with the command:`:YankBank`, an entry is pasted at
164
-
the current cursor position by hitting enter, and the menu can be closed by
169
+
The popup menu can be opened with the command:`:YankBank`, an entry is pasted
170
+
at the current cursor position by hitting enter, and the menu can be closed by
165
171
hitting escape, ctrl-c, or q. An entry from the menu can also be yanked into
166
172
the unnamedplus register by hitting yy.
167
173
···
181
187
Examples:
182
188
183
189
>lua
184
-
-- get the 2nd entry in the bank
190
+
-- get the ith entry in the bank
185
191
---@param i integer index to get
186
192
-- output format: { yank_text = "entry", reg_type = "v" }
187
-
local e = require("yankbank.api").get_entry(2)
193
+
local e = require("yankbank.api").get_entry(i)
188
194
189
195
-- add an entry to the bank
190
196
---@param yank_text string yank text to add to YANKS table
···
193
199
194
200
-- remove an entry from the bank by index
195
201
---@param i integer index to remove
196
-
require("yankbank.api").remove_entry(1)
202
+
require("yankbank.api").remove_entry(i)
203
+
204
+
--- pin entry to yankbank so that it won't be removed when its position exceeds the max number of entries
205
+
---@param i integer index to pin
206
+
require("yankbank.api").pin_entry(i)
207
+
208
+
209
+
--- unpin bank entry
210
+
---@param i integer index to unpin
211
+
require("yankbank.api").unpin_entry(i)
197
212
<
198
213
199
214
For more details about the API see lua/yankbank/api.lua <lua/yankbank/api.lua>