chore(build): auto-generate docs
Some checks failed
CI / ci (push) Failing after 0s

This commit is contained in:
folke 2025-02-16 13:17:05 +00:00 committed by github-actions[bot]
parent a596f8a9ea
commit 55ffbcd645
2 changed files with 26 additions and 20 deletions

View file

@ -84,7 +84,6 @@ In case of issues, make sure to run `:checkhealth snacks`.
-- a treesitter parser must be available for the enabled languages. -- a treesitter parser must be available for the enabled languages.
-- supported language injections: markdown, html -- supported language injections: markdown, html
enabled = true, enabled = true,
lang = { "markdown", "html", "norg", "tsx", "javascript", "css", "vue", "angular" },
-- render the image inline in the buffer -- render the image inline in the buffer
-- if your env doesn't support unicode placeholders, this will be disabled -- if your env doesn't support unicode placeholders, this will be disabled
-- takes precedence over `opts.float` on supported terminals -- takes precedence over `opts.float` on supported terminals
@ -187,6 +186,13 @@ Show the image at the cursor in a floating window
Snacks.image.hover() Snacks.image.hover()
``` ```
### `Snacks.image.langs()`
```lua
---@return string[]
Snacks.image.langs()
```
### `Snacks.image.supports()` ### `Snacks.image.supports()`
Check if the file format is supported and the terminal supports the kitty graphics protocol Check if the file format is supported and the terminal supports the kitty graphics protocol

View file

@ -605,23 +605,6 @@ Snacks.picker.pick({source = "files", ...})
---@field notify? boolean ---@field notify? boolean
``` ```
```lua
---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker}
```
```lua
---@class snacks.picker.Last
---@field cursor number
---@field topline number
---@field opts? snacks.picker.Config
---@field selected snacks.picker.Item[]
---@field filter snacks.picker.Filter
```
```lua
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
```
```lua ```lua
---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string}
---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string} ---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string}
@ -700,6 +683,23 @@ It's a previewer that shows a preview based on the item data.
---@field preview? snacks.win.Config|{} preview window config ---@field preview? snacks.win.Config|{} preview window config
``` ```
```lua
---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker}
```
```lua
---@class snacks.picker.Last
---@field cursor number
---@field topline number
---@field opts? snacks.picker.Config
---@field selected snacks.picker.Item[]
---@field filter snacks.picker.Filter
```
```lua
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
```
## 📦 Module ## 📦 Module
```lua ```lua
@ -2693,6 +2693,8 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(picker, item, action) Snacks.picker.actions.yank(picker, item, action)
``` ```
## 📦 `snacks.picker.core.picker` ## 📦 `snacks.picker.core.picker`
```lua ```lua
@ -2947,5 +2949,3 @@ Get the word under the cursor or the current visual selection
```lua ```lua
picker:word() picker:word()
``` ```