Skip to content

Commit a92e06b

Browse files
chore(build): auto-generate docs
1 parent f4ae411 commit a92e06b

File tree

3 files changed

+87
-1
lines changed

3 files changed

+87
-1
lines changed

docs/extras/editor/snacks_explorer.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# `Snacks_explorer`
2+
3+
<!-- plugins:start -->
4+
5+
:::info
6+
You can enable the extra with the `:LazyExtras` command.
7+
Plugins marked as optional will only be configured if they are installed.
8+
:::
9+
10+
Below you can find a list of included plugins and their default settings.
11+
12+
:::caution
13+
You don't need to copy the default settings to your config.
14+
They are only shown here for reference.
15+
:::
16+
17+
import Tabs from '@theme/Tabs';
18+
import TabItem from '@theme/TabItem';
19+
20+
## [snacks.nvim](https://github.com/folke/snacks.nvim)
21+
22+
<Tabs>
23+
24+
<TabItem value="opts" label="Options">
25+
26+
```lua
27+
opts = nil
28+
```
29+
30+
</TabItem>
31+
32+
33+
<TabItem value="code" label="Full Spec">
34+
35+
```lua
36+
{
37+
"folke/snacks.nvim",
38+
keys = {
39+
{
40+
"<leader>fe",
41+
function()
42+
Snacks.picker.explorer({ cwd = LazyVim.root() })
43+
end,
44+
desc = "Explorer Snacks (root dir)",
45+
},
46+
{
47+
"<leader>fE",
48+
function()
49+
Snacks.picker.explorer()
50+
end,
51+
desc = "Explorer Snacks (cwd)",
52+
},
53+
{ "<leader>e", "<leader>fe", desc = "Explorer Snacks (root dir)", remap = true },
54+
{ "<leader>E", "<leader>fE", desc = "Explorer Snacks (cwd)", remap = true },
55+
},
56+
init = function()
57+
vim.api.nvim_create_autocmd("BufEnter", {
58+
group = vim.api.nvim_create_augroup("snacks_explorer_start_directory", { clear = true }),
59+
desc = "Start Snacks Explorer with directory",
60+
once = true,
61+
callback = function()
62+
local dir = vim.fn.argv(0) --[[@as string]]
63+
if dir ~= "" and vim.fn.isdirectory(dir) == 1 then
64+
Snacks.picker.explorer({ cwd = dir })
65+
end
66+
end,
67+
})
68+
end,
69+
}
70+
```
71+
72+
</TabItem>
73+
74+
</Tabs>
75+
76+
<!-- plugins:end -->

docs/extras/lang/markdown.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ opts = {
189189
enabled = false,
190190
},
191191
},
192-
ft = { "markdown", "norg", "rmd", "org" },
192+
ft = { "markdown", "norg", "rmd", "org", "codecompanion" },
193193
config = function(_, opts)
194194
require("render-markdown").setup(opts)
195195
Snacks.toggle({

docs/keymaps.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,16 @@ Part of [lazyvim.plugins.extras.editor.refactoring](/extras/editor/refactoring)
554554
| <code>&lt;leader&gt;rs</code> | Refactor | **v** |
555555
| <code>&lt;leader&gt;rx</code> | Extract Variable | **v** |
556556

557+
## [snacks.nvim](https://github.com/folke/snacks.nvim.git)
558+
Part of [lazyvim.plugins.extras.editor.snacks_explorer](/extras/editor/snacks_explorer)
559+
560+
| Key | Description | Mode |
561+
| --- | --- | --- |
562+
| <code>&lt;leader&gt;e</code> | Explorer Snacks (root dir) | **n** |
563+
| <code>&lt;leader&gt;E</code> | Explorer Snacks (cwd) | **n** |
564+
| <code>&lt;leader&gt;fe</code> | Explorer Snacks (root dir) | **n** |
565+
| <code>&lt;leader&gt;fE</code> | Explorer Snacks (cwd) | **n** |
566+
557567
## [snacks.nvim](https://github.com/folke/snacks.nvim.git)
558568
Part of [lazyvim.plugins.extras.editor.snacks_picker](/extras/editor/snacks_picker)
559569

0 commit comments

Comments
 (0)