mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 10:49:08 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
304a8c7d25
commit
135f5f95d2
7 changed files with 21 additions and 7 deletions
|
@ -29,7 +29,7 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@alias snacks.lazygit.Color {fg?:string, bg?:string, bold?:boolean}
|
||||
|
@ -48,6 +48,8 @@
|
|||
---@field unstagedChangesColor snacks.lazygit.Color
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.lazygit
|
||||
Snacks.lazygit = {}
|
||||
|
|
|
@ -24,7 +24,7 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@alias snacks.notifier.hl "title"|"icon"|"border"|"footer"|"msg"
|
||||
|
@ -78,6 +78,8 @@ Render styles:
|
|||
---@field layout? { width: number, height: number, top?: number }
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.notifier
|
||||
---@field queue snacks.notifier.Notif[]
|
||||
|
|
|
@ -2,12 +2,14 @@
|
|||
|
||||
<!-- docgen -->
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@alias snacks.notify.Opts {level?: number, title?: string, once?: boolean, ft?: string}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.notify
|
||||
Snacks.notify = {}
|
||||
|
|
|
@ -20,13 +20,15 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@alias snacks.statuscolumn.Sign.type "mark"|"sign"|"fold"|"git"
|
||||
---@alias snacks.statuscolumn.Sign {name:string, text:string, texthl:string, priority:number, type:snacks.statuscolumn.Sign.type}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.statuscolumn
|
||||
Snacks.statuscolumn = {}
|
||||
|
|
|
@ -23,7 +23,7 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@class snacks.toggle.Opts: snacks.toggle.Config
|
||||
|
@ -32,6 +32,8 @@
|
|||
---@field set fun(state:boolean)
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.toggle
|
||||
---@field opts snacks.toggle.Opts
|
||||
|
|
|
@ -34,7 +34,7 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@class snacks.win.Keys: vim.api.keyset.keymap
|
||||
|
@ -43,6 +43,8 @@
|
|||
---@field mode? string|string[]
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.win
|
||||
---@field id number
|
||||
|
|
|
@ -12,12 +12,14 @@
|
|||
}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
## 📚 Types
|
||||
|
||||
```lua
|
||||
---@alias LspWord {from:{[1]:number, [2]:number}, to:{[1]:number, [2]:number}} 1-0 indexed
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
---@class snacks.words
|
||||
Snacks.words = {}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue