Skip to content

Commit 893ebeb

Browse files
github-actions[bot]github-actions[bot]
committed
chore(build): auto-generate docs
1 parent 45071bf commit 893ebeb

File tree

3 files changed

+155
-164
lines changed

3 files changed

+155
-164
lines changed

‎docs/extras/editor/snacks_picker.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,46 @@ end
275275

276276
<TabItem value="opts" label="Options">
277277

278+
```lua
279+
opts = function(_, opts)
280+
table.insert(opts.dashboard.preset.keys, 3, {
281+
icon = "",
282+
key = "p",
283+
desc = "Projects",
284+
action = ":lua Snacks.picker.projects()",
285+
})
286+
end
287+
```
288+
289+
</TabItem>
290+
291+
292+
<TabItem value="code" label="Full Spec">
293+
294+
```lua
295+
{
296+
"folke/snacks.nvim",
297+
opts = function(_, opts)
298+
table.insert(opts.dashboard.preset.keys, 3, {
299+
icon = "",
300+
key = "p",
301+
desc = "Projects",
302+
action = ":lua Snacks.picker.projects()",
303+
})
304+
end,
305+
}
306+
```
307+
308+
</TabItem>
309+
310+
</Tabs>
311+
312+
## [snacks.nvim](https://github.com/folke/snacks.nvim)
313+
314+
<Tabs>
315+
316+
<TabItem value="opts" label="Options">
317+
278318
```lua
279319
opts = {
280320
picker = {

‎docs/keymaps.md

Lines changed: 115 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -165,49 +165,6 @@ possible keymaps starting with `<space>`.
165165
| <code>s</code> | Flash | **n**, **o**, **x** |
166166
| <code>S</code> | Flash Treesitter | **n**, **o**, **x** |
167167

168-
## [fzf-lua](https://github.com/ibhagwan/fzf-lua.git)
169-
170-
| Key | Description | Mode |
171-
| --- | --- | --- |
172-
| <code>&lt;leader&gt;&lt;space&gt;</code> | Find Files (Root Dir) | **n** |
173-
| <code>&lt;leader&gt;,</code> | Switch Buffer | **n** |
174-
| <code>&lt;leader&gt;/</code> | Grep (Root Dir) | **n** |
175-
| <code>&lt;leader&gt;:</code> | Command History | **n** |
176-
| <code>&lt;leader&gt;fb</code> | Buffers | **n** |
177-
| <code>&lt;leader&gt;fc</code> | Find Config File | **n** |
178-
| <code>&lt;leader&gt;ff</code> | Find Files (Root Dir) | **n** |
179-
| <code>&lt;leader&gt;fF</code> | Find Files (cwd) | **n** |
180-
| <code>&lt;leader&gt;fg</code> | Find Files (git-files) | **n** |
181-
| <code>&lt;leader&gt;fr</code> | Recent | **n** |
182-
| <code>&lt;leader&gt;fR</code> | Recent (cwd) | **n** |
183-
| <code>&lt;leader&gt;gc</code> | Commits | **n** |
184-
| <code>&lt;leader&gt;gs</code> | Status | **n** |
185-
| <code>&lt;leader&gt;s"</code> | Registers | **n** |
186-
| <code>&lt;leader&gt;sa</code> | Auto Commands | **n** |
187-
| <code>&lt;leader&gt;sb</code> | Buffer | **n** |
188-
| <code>&lt;leader&gt;sc</code> | Command History | **n** |
189-
| <code>&lt;leader&gt;sC</code> | Commands | **n** |
190-
| <code>&lt;leader&gt;sd</code> | Document Diagnostics | **n** |
191-
| <code>&lt;leader&gt;sD</code> | Workspace Diagnostics | **n** |
192-
| <code>&lt;leader&gt;sg</code> | Grep (Root Dir) | **n** |
193-
| <code>&lt;leader&gt;sG</code> | Grep (cwd) | **n** |
194-
| <code>&lt;leader&gt;sh</code> | Help Pages | **n** |
195-
| <code>&lt;leader&gt;sH</code> | Search Highlight Groups | **n** |
196-
| <code>&lt;leader&gt;sj</code> | Jumplist | **n** |
197-
| <code>&lt;leader&gt;sk</code> | Key Maps | **n** |
198-
| <code>&lt;leader&gt;sl</code> | Location List | **n** |
199-
| <code>&lt;leader&gt;sm</code> | Jump to Mark | **n** |
200-
| <code>&lt;leader&gt;sM</code> | Man Pages | **n** |
201-
| <code>&lt;leader&gt;sq</code> | Quickfix List | **n** |
202-
| <code>&lt;leader&gt;sR</code> | Resume | **n** |
203-
| <code>&lt;leader&gt;ss</code> | Goto Symbol | **n** |
204-
| <code>&lt;leader&gt;sS</code> | Goto Symbol (Workspace) | **n** |
205-
| <code>&lt;leader&gt;sw</code> | Word (Root Dir) | **n** |
206-
| <code>&lt;leader&gt;sW</code> | Word (cwd) | **n** |
207-
| <code>&lt;leader&gt;sw</code> | Selection (Root Dir) | **v** |
208-
| <code>&lt;leader&gt;sW</code> | Selection (cwd) | **v** |
209-
| <code>&lt;leader&gt;uC</code> | Colorscheme with Preview | **n** |
210-
211168
## [grug-far.nvim](https://github.com/MagicDuck/grug-far.nvim.git)
212169

213170
| Key | Description | Mode |
@@ -220,17 +177,6 @@ possible keymaps starting with `<space>`.
220177
| --- | --- | --- |
221178
| <code>&lt;leader&gt;cm</code> | Mason | **n** |
222179

223-
## [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim.git)
224-
225-
| Key | Description | Mode |
226-
| --- | --- | --- |
227-
| <code>&lt;leader&gt;be</code> | Buffer Explorer | **n** |
228-
| <code>&lt;leader&gt;e</code> | Explorer NeoTree (Root Dir) | **n** |
229-
| <code>&lt;leader&gt;E</code> | Explorer NeoTree (cwd) | **n** |
230-
| <code>&lt;leader&gt;fe</code> | Explorer NeoTree (Root Dir) | **n** |
231-
| <code>&lt;leader&gt;fE</code> | Explorer NeoTree (cwd) | **n** |
232-
| <code>&lt;leader&gt;ge</code> | Git Explorer | **n** |
233-
234180
## [noice.nvim](https://github.com/folke/noice.nvim.git)
235181

236182
| Key | Description | Mode |
@@ -265,10 +211,57 @@ possible keymaps starting with `<space>`.
265211

266212
| Key | Description | Mode |
267213
| --- | --- | --- |
214+
| <code>&lt;leader&gt;&lt;space&gt;</code> | Find Files (Root Dir) | **n** |
215+
| <code>&lt;leader&gt;,</code> | Buffers | **n** |
268216
| <code>&lt;leader&gt;.</code> | Toggle Scratch Buffer | **n** |
217+
| <code>&lt;leader&gt;/</code> | Grep (Root Dir) | **n** |
218+
| <code>&lt;leader&gt;:</code> | Command History | **n** |
269219
| <code>&lt;leader&gt;dps</code> | Profiler Scratch Buffer | **n** |
220+
| <code>&lt;leader&gt;e</code> | Explorer Snacks (root dir) | **n** |
221+
| <code>&lt;leader&gt;E</code> | Explorer Snacks (cwd) | **n** |
222+
| <code>&lt;leader&gt;fb</code> | Buffers | **n** |
223+
| <code>&lt;leader&gt;fB</code> | Buffers (all) | **n** |
224+
| <code>&lt;leader&gt;fc</code> | Find Config File | **n** |
225+
| <code>&lt;leader&gt;fe</code> | Explorer Snacks (root dir) | **n** |
226+
| <code>&lt;leader&gt;fE</code> | Explorer Snacks (cwd) | **n** |
227+
| <code>&lt;leader&gt;ff</code> | Find Files (Root Dir) | **n** |
228+
| <code>&lt;leader&gt;fF</code> | Find Files (cwd) | **n** |
229+
| <code>&lt;leader&gt;fg</code> | Find Files (git-files) | **n** |
230+
| <code>&lt;leader&gt;fp</code> | Projects | **n** |
231+
| <code>&lt;leader&gt;fr</code> | Recent | **n** |
232+
| <code>&lt;leader&gt;fR</code> | Recent (cwd) | **n** |
233+
| <code>&lt;leader&gt;gc</code> | Git Log | **n** |
234+
| <code>&lt;leader&gt;gd</code> | Git Diff (hunks) | **n** |
235+
| <code>&lt;leader&gt;gs</code> | Git Status | **n** |
236+
| <code>&lt;leader&gt;gS</code> | Git Stash | **n** |
270237
| <code>&lt;leader&gt;n</code> | Notification History | **n** |
271238
| <code>&lt;leader&gt;S</code> | Select Scratch Buffer | **n** |
239+
| <code>&lt;leader&gt;s"</code> | Registers | **n** |
240+
| <code>&lt;leader&gt;s/</code> | Search History | **n** |
241+
| <code>&lt;leader&gt;sa</code> | Autocmds | **n** |
242+
| <code>&lt;leader&gt;sb</code> | Buffer Lines | **n** |
243+
| <code>&lt;leader&gt;sB</code> | Grep Open Buffers | **n** |
244+
| <code>&lt;leader&gt;sc</code> | Command History | **n** |
245+
| <code>&lt;leader&gt;sC</code> | Commands | **n** |
246+
| <code>&lt;leader&gt;sd</code> | Diagnostics | **n** |
247+
| <code>&lt;leader&gt;sD</code> | Buffer Diagnostics | **n** |
248+
| <code>&lt;leader&gt;sg</code> | Grep (Root Dir) | **n** |
249+
| <code>&lt;leader&gt;sG</code> | Grep (cwd) | **n** |
250+
| <code>&lt;leader&gt;sh</code> | Help Pages | **n** |
251+
| <code>&lt;leader&gt;sH</code> | Highlights | **n** |
252+
| <code>&lt;leader&gt;si</code> | Icons | **n** |
253+
| <code>&lt;leader&gt;sj</code> | Jumps | **n** |
254+
| <code>&lt;leader&gt;sk</code> | Keymaps | **n** |
255+
| <code>&lt;leader&gt;sl</code> | Location List | **n** |
256+
| <code>&lt;leader&gt;sm</code> | Marks | **n** |
257+
| <code>&lt;leader&gt;sM</code> | Man Pages | **n** |
258+
| <code>&lt;leader&gt;sp</code> | Search for Plugin Spec | **n** |
259+
| <code>&lt;leader&gt;sq</code> | Quickfix List | **n** |
260+
| <code>&lt;leader&gt;sR</code> | Resume | **n** |
261+
| <code>&lt;leader&gt;su</code> | Undotree | **n** |
262+
| <code>&lt;leader&gt;sw</code> | Visual selection or word (Root Dir) | **n**, **x** |
263+
| <code>&lt;leader&gt;sW</code> | Visual selection or word (cwd) | **n**, **x** |
264+
| <code>&lt;leader&gt;uC</code> | Colorschemes | **n** |
272265
| <code>&lt;leader&gt;un</code> | Dismiss All Notifications | **n** |
273266

274267
## [todo-comments.nvim](https://github.com/folke/todo-comments.nvim.git)
@@ -413,58 +406,6 @@ Part of [lazyvim.plugins.extras.editor.dial](/extras/editor/dial)
413406
| <code>g&lt;C-a&gt;</code> | Increment | **n**, **v** |
414407
| <code>g&lt;C-x&gt;</code> | Decrement | **n**, **v** |
415408

416-
## [fzf-lua](https://github.com/ibhagwan/fzf-lua.git)
417-
Part of [lazyvim.plugins.extras.editor.fzf](/extras/editor/fzf)
418-
419-
| Key | Description | Mode |
420-
| --- | --- | --- |
421-
| <code>&lt;leader&gt;&lt;space&gt;</code> | Find Files (Root Dir) | **n** |
422-
| <code>&lt;leader&gt;,</code> | Switch Buffer | **n** |
423-
| <code>&lt;leader&gt;/</code> | Grep (Root Dir) | **n** |
424-
| <code>&lt;leader&gt;:</code> | Command History | **n** |
425-
| <code>&lt;leader&gt;fb</code> | Buffers | **n** |
426-
| <code>&lt;leader&gt;fc</code> | Find Config File | **n** |
427-
| <code>&lt;leader&gt;ff</code> | Find Files (Root Dir) | **n** |
428-
| <code>&lt;leader&gt;fF</code> | Find Files (cwd) | **n** |
429-
| <code>&lt;leader&gt;fg</code> | Find Files (git-files) | **n** |
430-
| <code>&lt;leader&gt;fr</code> | Recent | **n** |
431-
| <code>&lt;leader&gt;fR</code> | Recent (cwd) | **n** |
432-
| <code>&lt;leader&gt;gc</code> | Commits | **n** |
433-
| <code>&lt;leader&gt;gs</code> | Status | **n** |
434-
| <code>&lt;leader&gt;s"</code> | Registers | **n** |
435-
| <code>&lt;leader&gt;sa</code> | Auto Commands | **n** |
436-
| <code>&lt;leader&gt;sb</code> | Buffer | **n** |
437-
| <code>&lt;leader&gt;sc</code> | Command History | **n** |
438-
| <code>&lt;leader&gt;sC</code> | Commands | **n** |
439-
| <code>&lt;leader&gt;sd</code> | Document Diagnostics | **n** |
440-
| <code>&lt;leader&gt;sD</code> | Workspace Diagnostics | **n** |
441-
| <code>&lt;leader&gt;sg</code> | Grep (Root Dir) | **n** |
442-
| <code>&lt;leader&gt;sG</code> | Grep (cwd) | **n** |
443-
| <code>&lt;leader&gt;sh</code> | Help Pages | **n** |
444-
| <code>&lt;leader&gt;sH</code> | Search Highlight Groups | **n** |
445-
| <code>&lt;leader&gt;sj</code> | Jumplist | **n** |
446-
| <code>&lt;leader&gt;sk</code> | Key Maps | **n** |
447-
| <code>&lt;leader&gt;sl</code> | Location List | **n** |
448-
| <code>&lt;leader&gt;sm</code> | Jump to Mark | **n** |
449-
| <code>&lt;leader&gt;sM</code> | Man Pages | **n** |
450-
| <code>&lt;leader&gt;sq</code> | Quickfix List | **n** |
451-
| <code>&lt;leader&gt;sR</code> | Resume | **n** |
452-
| <code>&lt;leader&gt;ss</code> | Goto Symbol | **n** |
453-
| <code>&lt;leader&gt;sS</code> | Goto Symbol (Workspace) | **n** |
454-
| <code>&lt;leader&gt;sw</code> | Word (Root Dir) | **n** |
455-
| <code>&lt;leader&gt;sW</code> | Word (cwd) | **n** |
456-
| <code>&lt;leader&gt;sw</code> | Selection (Root Dir) | **v** |
457-
| <code>&lt;leader&gt;sW</code> | Selection (cwd) | **v** |
458-
| <code>&lt;leader&gt;uC</code> | Colorscheme with Preview | **n** |
459-
460-
## [todo-comments.nvim](https://github.com/folke/todo-comments.nvim.git)
461-
Part of [lazyvim.plugins.extras.editor.fzf](/extras/editor/fzf)
462-
463-
| Key | Description | Mode |
464-
| --- | --- | --- |
465-
| <code>&lt;leader&gt;st</code> | Todo | **n** |
466-
| <code>&lt;leader&gt;sT</code> | Todo/Fix/Fixme | **n** |
467-
468409
## [harpoon](https://github.com/ThePrimeagen/harpoon.git)
469410
Part of [lazyvim.plugins.extras.editor.harpoon2](/extras/editor/harpoon2)
470411

@@ -517,18 +458,6 @@ Part of [lazyvim.plugins.extras.editor.mini-files](/extras/editor/mini-files)
517458
| <code>&lt;leader&gt;fm</code> | Open mini.files (Directory of Current File) | **n** |
518459
| <code>&lt;leader&gt;fM</code> | Open mini.files (cwd) | **n** |
519460

520-
## [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim.git)
521-
Part of [lazyvim.plugins.extras.editor.neo-tree](/extras/editor/neo-tree)
522-
523-
| Key | Description | Mode |
524-
| --- | --- | --- |
525-
| <code>&lt;leader&gt;be</code> | Buffer Explorer | **n** |
526-
| <code>&lt;leader&gt;e</code> | Explorer NeoTree (Root Dir) | **n** |
527-
| <code>&lt;leader&gt;E</code> | Explorer NeoTree (cwd) | **n** |
528-
| <code>&lt;leader&gt;fe</code> | Explorer NeoTree (Root Dir) | **n** |
529-
| <code>&lt;leader&gt;fE</code> | Explorer NeoTree (cwd) | **n** |
530-
| <code>&lt;leader&gt;ge</code> | Git Explorer | **n** |
531-
532461
## [outline.nvim](https://github.com/hedyhli/outline.nvim.git)
533462
Part of [lazyvim.plugins.extras.editor.outline](/extras/editor/outline)
534463

@@ -566,6 +495,74 @@ Part of [lazyvim.plugins.extras.editor.refactoring](/extras/editor/refactoring)
566495
| <code>&lt;leader&gt;rs</code> | Refactor | **v** |
567496
| <code>&lt;leader&gt;rx</code> | Extract Variable | **v** |
568497

498+
## [snacks.nvim](https://github.com/folke/snacks.nvim.git)
499+
Part of [lazyvim.plugins.extras.editor.snacks_explorer](/extras/editor/snacks_explorer)
500+
501+
| Key | Description | Mode |
502+
| --- | --- | --- |
503+
| <code>&lt;leader&gt;e</code> | Explorer Snacks (root dir) | **n** |
504+
| <code>&lt;leader&gt;E</code> | Explorer Snacks (cwd) | **n** |
505+
| <code>&lt;leader&gt;fe</code> | Explorer Snacks (root dir) | **n** |
506+
| <code>&lt;leader&gt;fE</code> | Explorer Snacks (cwd) | **n** |
507+
508+
## [snacks.nvim](https://github.com/folke/snacks.nvim.git)
509+
Part of [lazyvim.plugins.extras.editor.snacks_picker](/extras/editor/snacks_picker)
510+
511+
| Key | Description | Mode |
512+
| --- | --- | --- |
513+
| <code>&lt;leader&gt;&lt;space&gt;</code> | Find Files (Root Dir) | **n** |
514+
| <code>&lt;leader&gt;,</code> | Buffers | **n** |
515+
| <code>&lt;leader&gt;/</code> | Grep (Root Dir) | **n** |
516+
| <code>&lt;leader&gt;:</code> | Command History | **n** |
517+
| <code>&lt;leader&gt;fb</code> | Buffers | **n** |
518+
| <code>&lt;leader&gt;fB</code> | Buffers (all) | **n** |
519+
| <code>&lt;leader&gt;fc</code> | Find Config File | **n** |
520+
| <code>&lt;leader&gt;ff</code> | Find Files (Root Dir) | **n** |
521+
| <code>&lt;leader&gt;fF</code> | Find Files (cwd) | **n** |
522+
| <code>&lt;leader&gt;fg</code> | Find Files (git-files) | **n** |
523+
| <code>&lt;leader&gt;fp</code> | Projects | **n** |
524+
| <code>&lt;leader&gt;fr</code> | Recent | **n** |
525+
| <code>&lt;leader&gt;fR</code> | Recent (cwd) | **n** |
526+
| <code>&lt;leader&gt;gc</code> | Git Log | **n** |
527+
| <code>&lt;leader&gt;gd</code> | Git Diff (hunks) | **n** |
528+
| <code>&lt;leader&gt;gs</code> | Git Status | **n** |
529+
| <code>&lt;leader&gt;gS</code> | Git Stash | **n** |
530+
| <code>&lt;leader&gt;n</code> | Notification History | **n** |
531+
| <code>&lt;leader&gt;s"</code> | Registers | **n** |
532+
| <code>&lt;leader&gt;s/</code> | Search History | **n** |
533+
| <code>&lt;leader&gt;sa</code> | Autocmds | **n** |
534+
| <code>&lt;leader&gt;sb</code> | Buffer Lines | **n** |
535+
| <code>&lt;leader&gt;sB</code> | Grep Open Buffers | **n** |
536+
| <code>&lt;leader&gt;sc</code> | Command History | **n** |
537+
| <code>&lt;leader&gt;sC</code> | Commands | **n** |
538+
| <code>&lt;leader&gt;sd</code> | Diagnostics | **n** |
539+
| <code>&lt;leader&gt;sD</code> | Buffer Diagnostics | **n** |
540+
| <code>&lt;leader&gt;sg</code> | Grep (Root Dir) | **n** |
541+
| <code>&lt;leader&gt;sG</code> | Grep (cwd) | **n** |
542+
| <code>&lt;leader&gt;sh</code> | Help Pages | **n** |
543+
| <code>&lt;leader&gt;sH</code> | Highlights | **n** |
544+
| <code>&lt;leader&gt;si</code> | Icons | **n** |
545+
| <code>&lt;leader&gt;sj</code> | Jumps | **n** |
546+
| <code>&lt;leader&gt;sk</code> | Keymaps | **n** |
547+
| <code>&lt;leader&gt;sl</code> | Location List | **n** |
548+
| <code>&lt;leader&gt;sm</code> | Marks | **n** |
549+
| <code>&lt;leader&gt;sM</code> | Man Pages | **n** |
550+
| <code>&lt;leader&gt;sp</code> | Search for Plugin Spec | **n** |
551+
| <code>&lt;leader&gt;sq</code> | Quickfix List | **n** |
552+
| <code>&lt;leader&gt;sR</code> | Resume | **n** |
553+
| <code>&lt;leader&gt;su</code> | Undotree | **n** |
554+
| <code>&lt;leader&gt;sw</code> | Visual selection or word (Root Dir) | **n**, **x** |
555+
| <code>&lt;leader&gt;sW</code> | Visual selection or word (cwd) | **n**, **x** |
556+
| <code>&lt;leader&gt;uC</code> | Colorschemes | **n** |
557+
558+
## [todo-comments.nvim](https://github.com/folke/todo-comments.nvim.git)
559+
Part of [lazyvim.plugins.extras.editor.snacks_picker](/extras/editor/snacks_picker)
560+
561+
| Key | Description | Mode |
562+
| --- | --- | --- |
563+
| <code>&lt;leader&gt;st</code> | Todo | **n** |
564+
| <code>&lt;leader&gt;sT</code> | Todo/Fix/Fixme | **n** |
565+
569566
## [nvim-ansible](https://github.com/mfussenegger/nvim-ansible.git)
570567
Part of [lazyvim.plugins.extras.lang.ansible](/extras/lang/ansible)
571568

‎docs/plugins/ui.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -703,50 +703,4 @@ opts = {
703703

704704
</Tabs>
705705

706-
## [snacks.nvim](https://github.com/folke/snacks.nvim)
707-
708-
<Tabs>
709-
710-
<TabItem value="opts" label="Options">
711-
712-
```lua
713-
opts = function(_, opts)
714-
if not opts.picker then
715-
return
716-
end
717-
table.insert(opts.dashboard.preset.keys, 3, {
718-
icon = "",
719-
key = "p",
720-
desc = "Projects",
721-
action = ":lua Snacks.picker.projects()",
722-
})
723-
end
724-
```
725-
726-
</TabItem>
727-
728-
729-
<TabItem value="code" label="Full Spec">
730-
731-
```lua
732-
{
733-
"folke/snacks.nvim",
734-
opts = function(_, opts)
735-
if not opts.picker then
736-
return
737-
end
738-
table.insert(opts.dashboard.preset.keys, 3, {
739-
icon = "",
740-
key = "p",
741-
desc = "Projects",
742-
action = ":lua Snacks.picker.projects()",
743-
})
744-
end,
745-
}
746-
```
747-
748-
</TabItem>
749-
750-
</Tabs>
751-
752706
<!-- plugins:end -->

0 commit comments

Comments
 (0)