mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 18:58:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs

Browse source
This commit is contained in:
folke 2024-12-02 07:36:48 +00:00 • committed by github-actions[bot]
parent f8949523ed
commit 6b98aa11d3
1 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/gitbrowse.md
View file

@ -24,6 +24,7 @@ Open the repo of the active file in the browser (e.g., GitHub)
```lua
---@class snacks.gitbrowse.Config
---@field url_patterns? table<string, table<string, string|fun(fields:snacks.gitbrowse.Fields):string>>
{
-- Handler to open the url in a browser
---@param url string
@ -36,12 +37,9 @@ Open the repo of the active file in the browser (e.g., GitHub)
end,
---@type "repo" | "branch" | "file" | "commit"
what = "file", -- what to open. not all remotes support all types
---@type string?
branch = nil,
---@type string?
line_start = nil,
---@type string?
line_end = nil,
branch = nil, ---@type string?
line_start = nil, ---@type number?
line_end = nil, ---@type number?
-- patterns to transform remotes to an actual URL
remote_patterns = {
{ "^(https?://.*)%.git$" , "%1" },
@ -77,6 +75,18 @@ Open the repo of the active file in the browser (e.g., GitHub)
}
```
## 📚 Types
```lua
---@class snacks.gitbrowse.Fields
---@field branch? string
---@field file? string
---@field line_start? number
---@field line_end? number
---@field commit? string
---@field line_count? number
```
## 📦 Module
### `Snacks.gitbrowse()`
@ -90,8 +100,9 @@ Snacks.gitbrowse()
```lua
---@param repo string
---@param fields snacks.gitbrowse.Fields
---@param opts? snacks.gitbrowse.Config
Snacks.gitbrowse.get_url(repo, opts)
Snacks.gitbrowse.get_url(repo, fields, opts)
```
### `Snacks.gitbrowse.open()`