From e6c18f17c8b372b0923603f40fd1d9a47885c99c Mon Sep 17 00:00:00 2001 From: Folke Lemaitre Date: Tue, 5 Nov 2024 22:28:46 +0100 Subject: [PATCH] docs: improve vim help --- ...ks.nvim-bigfile.txt => snacks-bigfile.txt} | 20 +- doc/snacks-bufdelete.txt | 36 ++++ doc/snacks-debug.txt | 53 +++++ doc/{snacks.nvim-git.txt => snacks-git.txt} | 18 +- ...vim-gitbrowse.txt => snacks-gitbrowse.txt} | 26 +-- doc/{snacks.nvim-init.txt => snacks-init.txt} | 21 +- ...ks.nvim-lazygit.txt => snacks-lazygit.txt} | 34 ++-- ....nvim-notifier.txt => snacks-notifier.txt} | 55 +++--- doc/snacks-notify.txt | 76 ++++++++ doc/snacks-quickfile.txt | 39 ++++ doc/snacks-rename.txt | 55 ++++++ doc/snacks-statuscolumn.txt | 119 ++++++++++++ ....nvim-terminal.txt => snacks-terminal.txt} | 26 +-- doc/snacks-toggle.txt | 163 ++++++++++++++++ doc/snacks-win.txt | 182 ++++++++++++++++++ doc/snacks-words.txt | 84 ++++++++ doc/snacks.nvim-bufdelete.txt | 38 ---- doc/snacks.nvim-debug.txt | 53 ----- doc/snacks.nvim-notify.txt | 74 ------- doc/snacks.nvim-quickfile.txt | 41 ---- doc/snacks.nvim-rename.txt | 55 ------ doc/snacks.nvim-statuscolumn.txt | 114 ----------- doc/snacks.nvim-toggle.txt | 153 --------------- doc/snacks.nvim-win.txt | 171 ---------------- doc/snacks.nvim-words.txt | 81 -------- scripts/docs | 2 +- 26 files changed, 911 insertions(+), 878 deletions(-) rename doc/{snacks.nvim-bigfile.txt => snacks-bigfile.txt} (54%) create mode 100644 doc/snacks-bufdelete.txt create mode 100644 doc/snacks-debug.txt rename doc/{snacks.nvim-git.txt => snacks-git.txt} (51%) rename doc/{snacks.nvim-gitbrowse.txt => snacks-gitbrowse.txt} (65%) rename doc/{snacks.nvim-init.txt => snacks-init.txt} (62%) rename doc/{snacks.nvim-lazygit.txt => snacks-lazygit.txt} (64%) rename doc/{snacks.nvim-notifier.txt => snacks-notifier.txt} (57%) create mode 100644 doc/snacks-notify.txt create mode 100644 doc/snacks-quickfile.txt create mode 100644 doc/snacks-rename.txt create mode 100644 doc/snacks-statuscolumn.txt rename doc/{snacks.nvim-terminal.txt => snacks-terminal.txt} (69%) create mode 100644 doc/snacks-toggle.txt create mode 100644 doc/snacks-win.txt create mode 100644 doc/snacks-words.txt delete mode 100644 doc/snacks.nvim-bufdelete.txt delete mode 100644 doc/snacks.nvim-debug.txt delete mode 100644 doc/snacks.nvim-notify.txt delete mode 100644 doc/snacks.nvim-quickfile.txt delete mode 100644 doc/snacks.nvim-rename.txt delete mode 100644 doc/snacks.nvim-statuscolumn.txt delete mode 100644 doc/snacks.nvim-toggle.txt delete mode 100644 doc/snacks.nvim-win.txt delete mode 100644 doc/snacks.nvim-words.txt diff --git a/doc/snacks.nvim-bigfile.txt b/doc/snacks-bigfile.txt similarity index 54% rename from doc/snacks.nvim-bigfile.txt rename to doc/snacks-bigfile.txt index dabed3dd..ac001950 100644 --- a/doc/snacks.nvim-bigfile.txt +++ b/doc/snacks-bigfile.txt @@ -1,17 +1,14 @@ -*snacks.nvim-bigfile.txt* For Neovim Last change: 2024 November 05 +*snacks-bigfile.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-bigfile-table-of-contents* +Table of Contents *snacks-bigfile-table-of-contents* -1. bigfile |snacks.nvim-bigfile-bigfile| - - Config |snacks.nvim-bigfile-bigfile-config| - - Module |snacks.nvim-bigfile-bigfile-module| +1. Config |snacks-bigfile-config| +2. Module |snacks-bigfile-module| + - Snacks.bigfile.setup() |snacks-bigfile-module-snacks.bigfile.setup()| ============================================================================== -1. bigfile *snacks.nvim-bigfile-bigfile* - - -CONFIG *snacks.nvim-bigfile-bigfile-config* +1. Config *snacks-bigfile-config* >lua ---@class snacks.bigfile.Config @@ -28,7 +25,8 @@ CONFIG *snacks.nvim-bigfile-bigfile-config* < -MODULE *snacks.nvim-bigfile-bigfile-module* +============================================================================== +2. Module *snacks-bigfile-module* >lua ---@class snacks.bigfile @@ -36,7 +34,7 @@ MODULE *snacks.nvim-bigfile-bigfile-module* < -SNACKS.BIGFILE.SETUP() ~ +SNACKS.BIGFILE.SETUP() *snacks-bigfile-module-snacks.bigfile.setup()* >lua Snacks.bigfile.setup() diff --git a/doc/snacks-bufdelete.txt b/doc/snacks-bufdelete.txt new file mode 100644 index 00000000..becace2d --- /dev/null +++ b/doc/snacks-bufdelete.txt @@ -0,0 +1,36 @@ +*snacks-bufdelete.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-bufdelete-table-of-contents* + +1. Module |snacks-bufdelete-module| + - Snacks.bufdelete() |snacks-bufdelete-module-snacks.bufdelete()| + - Snacks.bufdelete.delete()|snacks-bufdelete-module-snacks.bufdelete.delete()| + +============================================================================== +1. Module *snacks-bufdelete-module* + +>lua + ---@class snacks.bufdelete + Snacks.bufdelete = {} +< + + +SNACKS.BUFDELETE() *snacks-bufdelete-module-snacks.bufdelete()* + +>lua + ---@type fun(buf?: number) + Snacks.bufdelete() +< + + +SNACKS.BUFDELETE.DELETE() *snacks-bufdelete-module-snacks.bufdelete.delete()* + +>lua + ---@param buf number? + Snacks.bufdelete.delete(buf) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-debug.txt b/doc/snacks-debug.txt new file mode 100644 index 00000000..c7886d6e --- /dev/null +++ b/doc/snacks-debug.txt @@ -0,0 +1,53 @@ +*snacks-debug.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-debug-table-of-contents* + +1. Module |snacks-debug-module| + - Snacks.debug() |snacks-debug-module-snacks.debug()| + - Snacks.debug.backtrace() |snacks-debug-module-snacks.debug.backtrace()| + - Snacks.debug.inspect() |snacks-debug-module-snacks.debug.inspect()| + - Snacks.debug.profile() |snacks-debug-module-snacks.debug.profile()| + +============================================================================== +1. Module *snacks-debug-module* + +>lua + ---@class snacks.debug + Snacks.debug = {} +< + + +SNACKS.DEBUG() *snacks-debug-module-snacks.debug()* + +>lua + ---@type fun(...) + Snacks.debug() +< + + +SNACKS.DEBUG.BACKTRACE() *snacks-debug-module-snacks.debug.backtrace()* + +>lua + Snacks.debug.backtrace() +< + + +SNACKS.DEBUG.INSPECT() *snacks-debug-module-snacks.debug.inspect()* + +>lua + Snacks.debug.inspect(...) +< + + +SNACKS.DEBUG.PROFILE() *snacks-debug-module-snacks.debug.profile()* + +>lua + ---@param fn fun() + ---@param opts? {count?: number, flush?: boolean} + Snacks.debug.profile(fn, opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-git.txt b/doc/snacks-git.txt similarity index 51% rename from doc/snacks.nvim-git.txt rename to doc/snacks-git.txt index a347d0a5..67958554 100644 --- a/doc/snacks.nvim-git.txt +++ b/doc/snacks-git.txt @@ -1,16 +1,14 @@ -*snacks.nvim-git.txt* For Neovim Last change: 2024 November 05 +*snacks-git.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-git-table-of-contents* +Table of Contents *snacks-git-table-of-contents* -1. git |snacks.nvim-git-git| - - Module |snacks.nvim-git-git-module| +1. Module |snacks-git-module| + - Snacks.git.blame_line() |snacks-git-module-snacks.git.blame_line()| + - Snacks.git.get_root() |snacks-git-module-snacks.git.get_root()| ============================================================================== -1. git *snacks.nvim-git-git* - - -MODULE *snacks.nvim-git-git-module* +1. Module *snacks-git-module* >lua ---@class snacks.git @@ -18,7 +16,7 @@ MODULE *snacks.nvim-git-git-module* < -SNACKS.GIT.BLAME_LINE() ~ +SNACKS.GIT.BLAME_LINE() *snacks-git-module-snacks.git.blame_line()* Show git log for the current line. @@ -28,7 +26,7 @@ Show git log for the current line. < -SNACKS.GIT.GET_ROOT() ~ +SNACKS.GIT.GET_ROOT() *snacks-git-module-snacks.git.get_root()* Gets the git root for a buffer or path. Defaults to the current buffer. diff --git a/doc/snacks.nvim-gitbrowse.txt b/doc/snacks-gitbrowse.txt similarity index 65% rename from doc/snacks.nvim-gitbrowse.txt rename to doc/snacks-gitbrowse.txt index 1df3b048..aab76b22 100644 --- a/doc/snacks.nvim-gitbrowse.txt +++ b/doc/snacks-gitbrowse.txt @@ -1,17 +1,16 @@ -*snacks.nvim-gitbrowse.txt* For Neovim Last change: 2024 November 05 +*snacks-gitbrowse.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-gitbrowse-table-of-contents* +Table of Contents *snacks-gitbrowse-table-of-contents* -1. gitbrowse |snacks.nvim-gitbrowse-gitbrowse| - - Config |snacks.nvim-gitbrowse-gitbrowse-config| - - Module |snacks.nvim-gitbrowse-gitbrowse-module| +1. Config |snacks-gitbrowse-config| +2. Module |snacks-gitbrowse-module| + - Snacks.gitbrowse() |snacks-gitbrowse-module-snacks.gitbrowse()| + - Snacks.gitbrowse.get_url()|snacks-gitbrowse-module-snacks.gitbrowse.get_url()| + - Snacks.gitbrowse.open() |snacks-gitbrowse-module-snacks.gitbrowse.open()| ============================================================================== -1. gitbrowse *snacks.nvim-gitbrowse-gitbrowse* - - -CONFIG *snacks.nvim-gitbrowse-gitbrowse-config* +1. Config *snacks-gitbrowse-config* >lua ---@class snacks.gitbrowse.Config @@ -42,7 +41,8 @@ CONFIG *snacks.nvim-gitbrowse-gitbrowse-config* < -MODULE *snacks.nvim-gitbrowse-gitbrowse-module* +============================================================================== +2. Module *snacks-gitbrowse-module* >lua ---@class snacks.gitbrowse @@ -50,7 +50,7 @@ MODULE *snacks.nvim-gitbrowse-gitbrowse-module* < -SNACKS.GITBROWSE() ~ +SNACKS.GITBROWSE() *snacks-gitbrowse-module-snacks.gitbrowse()* >lua ---@type fun(opts?: snacks.gitbrowse.Config) @@ -58,7 +58,7 @@ SNACKS.GITBROWSE() ~ < -SNACKS.GITBROWSE.GET_URL() ~ +SNACKS.GITBROWSE.GET_URL()*snacks-gitbrowse-module-snacks.gitbrowse.get_url()* >lua ---@param remote string @@ -67,7 +67,7 @@ SNACKS.GITBROWSE.GET_URL() ~ < -SNACKS.GITBROWSE.OPEN() ~ +SNACKS.GITBROWSE.OPEN() *snacks-gitbrowse-module-snacks.gitbrowse.open()* >lua ---@param opts? snacks.gitbrowse.Config diff --git a/doc/snacks.nvim-init.txt b/doc/snacks-init.txt similarity index 62% rename from doc/snacks.nvim-init.txt rename to doc/snacks-init.txt index a07cedb1..419d3c2d 100644 --- a/doc/snacks.nvim-init.txt +++ b/doc/snacks-init.txt @@ -1,16 +1,15 @@ -*snacks.nvim-init.txt* For Neovim Last change: 2024 November 05 +*snacks-init.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-init-table-of-contents* +Table of Contents *snacks-init-table-of-contents* -1. init |snacks.nvim-init-init| - - Module |snacks.nvim-init-init-module| +1. Module |snacks-init-module| + - Snacks.config.get() |snacks-init-module-snacks.config.get()| + - Snacks.config.view() |snacks-init-module-snacks.config.view()| + - Snacks.setup() |snacks-init-module-snacks.setup()| ============================================================================== -1. init *snacks.nvim-init-init* - - -MODULE *snacks.nvim-init-init-module* +1. Module *snacks-init-module* >lua ---@class Snacks @@ -33,7 +32,7 @@ MODULE *snacks.nvim-init-init-module* < -SNACKS.CONFIG.GET() ~ +SNACKS.CONFIG.GET() *snacks-init-module-snacks.config.get()* >lua ---@generic T: table @@ -45,7 +44,7 @@ SNACKS.CONFIG.GET() ~ < -SNACKS.CONFIG.VIEW() ~ +SNACKS.CONFIG.VIEW() *snacks-init-module-snacks.config.view()* Register a new window view config. @@ -56,7 +55,7 @@ Register a new window view config. < -SNACKS.SETUP() ~ +SNACKS.SETUP() *snacks-init-module-snacks.setup()* >lua ---@param opts snacks.Opts? diff --git a/doc/snacks.nvim-lazygit.txt b/doc/snacks-lazygit.txt similarity index 64% rename from doc/snacks.nvim-lazygit.txt rename to doc/snacks-lazygit.txt index f6be3492..a87978c0 100644 --- a/doc/snacks.nvim-lazygit.txt +++ b/doc/snacks-lazygit.txt @@ -1,18 +1,18 @@ -*snacks.nvim-lazygit.txt* For Neovim Last change: 2024 November 05 +*snacks-lazygit.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-lazygit-table-of-contents* +Table of Contents *snacks-lazygit-table-of-contents* -1. lazygit |snacks.nvim-lazygit-lazygit| - - Config |snacks.nvim-lazygit-lazygit-config| - - Types |snacks.nvim-lazygit-lazygit-types| - - Module |snacks.nvim-lazygit-lazygit-module| +1. Config |snacks-lazygit-config| +2. Types |snacks-lazygit-types| +3. Module |snacks-lazygit-module| + - Snacks.lazygit() |snacks-lazygit-module-snacks.lazygit()| + - Snacks.lazygit.log() |snacks-lazygit-module-snacks.lazygit.log()| + - Snacks.lazygit.log_file()|snacks-lazygit-module-snacks.lazygit.log_file()| + - Snacks.lazygit.open() |snacks-lazygit-module-snacks.lazygit.open()| ============================================================================== -1. lazygit *snacks.nvim-lazygit-lazygit* - - -CONFIG *snacks.nvim-lazygit-lazygit-config* +1. Config *snacks-lazygit-config* >lua ---@class snacks.lazygit.Config: snacks.terminal.Config @@ -40,7 +40,8 @@ CONFIG *snacks.nvim-lazygit-lazygit-config* < -TYPES *snacks.nvim-lazygit-lazygit-types* +============================================================================== +2. Types *snacks-lazygit-types* >lua ---@alias snacks.lazygit.Color {fg?:string, bg?:string, bold?:boolean} @@ -60,7 +61,8 @@ TYPES *snacks.nvim-lazygit-lazygit-types* < -MODULE *snacks.nvim-lazygit-lazygit-module* +============================================================================== +3. Module *snacks-lazygit-module* >lua ---@class snacks.lazygit @@ -68,7 +70,7 @@ MODULE *snacks.nvim-lazygit-lazygit-module* < -SNACKS.LAZYGIT() ~ +SNACKS.LAZYGIT() *snacks-lazygit-module-snacks.lazygit()* >lua ---@type fun(opts?: snacks.lazygit.Config): snacks.win @@ -76,7 +78,7 @@ SNACKS.LAZYGIT() ~ < -SNACKS.LAZYGIT.LOG() ~ +SNACKS.LAZYGIT.LOG() *snacks-lazygit-module-snacks.lazygit.log()* >lua ---@param opts? snacks.lazygit.Config @@ -84,7 +86,7 @@ SNACKS.LAZYGIT.LOG() ~ < -SNACKS.LAZYGIT.LOG_FILE() ~ +SNACKS.LAZYGIT.LOG_FILE() *snacks-lazygit-module-snacks.lazygit.log_file()* >lua ---@param opts? snacks.lazygit.Config @@ -92,7 +94,7 @@ SNACKS.LAZYGIT.LOG_FILE() ~ < -SNACKS.LAZYGIT.OPEN() ~ +SNACKS.LAZYGIT.OPEN() *snacks-lazygit-module-snacks.lazygit.open()* Opens lazygit diff --git a/doc/snacks.nvim-notifier.txt b/doc/snacks-notifier.txt similarity index 57% rename from doc/snacks.nvim-notifier.txt rename to doc/snacks-notifier.txt index e2e5524f..7f3fdd9b 100644 --- a/doc/snacks.nvim-notifier.txt +++ b/doc/snacks-notifier.txt @@ -1,18 +1,25 @@ -*snacks.nvim-notifier.txt* For Neovim Last change: 2024 November 05 +*snacks-notifier.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-notifier-table-of-contents* +Table of Contents *snacks-notifier-table-of-contents* -1. notifier |snacks.nvim-notifier-notifier| - - Config |snacks.nvim-notifier-notifier-config| - - Types |snacks.nvim-notifier-notifier-types| - - Module |snacks.nvim-notifier-notifier-module| +1. Config |snacks-notifier-config| +2. Types |snacks-notifier-types| +3. Module |snacks-notifier-module| + - Snacks.notifier.new() |snacks-notifier-module-snacks.notifier.new()| + - notifier:add() |snacks-notifier-module-notifier:add()| + - notifier:get_render() |snacks-notifier-module-notifier:get_render()| + - notifier:hide() |snacks-notifier-module-notifier:hide()| + - notifier:init() |snacks-notifier-module-notifier:init()| + - notifier:layout() |snacks-notifier-module-notifier:layout()| + - notifier:notify() |snacks-notifier-module-notifier:notify()| + - notifier:render() |snacks-notifier-module-notifier:render()| + - notifier:sort() |snacks-notifier-module-notifier:sort()| + - notifier:start() |snacks-notifier-module-notifier:start()| + - notifier:update() |snacks-notifier-module-notifier:update()| ============================================================================== -1. notifier *snacks.nvim-notifier-notifier* - - -CONFIG *snacks.nvim-notifier-notifier-config* +1. Config *snacks-notifier-config* >lua ---@class snacks.notifier.Config @@ -35,7 +42,8 @@ CONFIG *snacks.nvim-notifier-notifier-config* < -TYPES *snacks.nvim-notifier-notifier-types* +============================================================================== +2. Types *snacks-notifier-types* >lua ---@alias snacks.notifier.hl "title"|"icon"|"border"|"footer"|"msg" @@ -89,7 +97,8 @@ default nvim-notify style < -MODULE *snacks.nvim-notifier-notifier-module* +============================================================================== +3. Module *snacks-notifier-module* >lua ---@class snacks.notifier @@ -100,7 +109,7 @@ MODULE *snacks.nvim-notifier-notifier-module* < -SNACKS.NOTIFIER.NEW() ~ +SNACKS.NOTIFIER.NEW() *snacks-notifier-module-snacks.notifier.new()* >lua ---@param opts? snacks.notifier.Config @@ -109,7 +118,7 @@ SNACKS.NOTIFIER.NEW() ~ < -NOTIFIER:ADD() ~ +NOTIFIER:ADD() *snacks-notifier-module-notifier:add()* >lua ---@param opts snacks.notifier.Notif.opts @@ -117,7 +126,7 @@ NOTIFIER:ADD() ~ < -NOTIFIER:GET_RENDER() ~ +NOTIFIER:GET_RENDER() *snacks-notifier-module-notifier:get_render()* >lua ---@param style? snacks.notifier.style @@ -126,7 +135,7 @@ NOTIFIER:GET_RENDER() ~ < -NOTIFIER:HIDE() ~ +NOTIFIER:HIDE() *snacks-notifier-module-notifier:hide()* >lua ---@param id? number|string @@ -134,21 +143,21 @@ NOTIFIER:HIDE() ~ < -NOTIFIER:INIT() ~ +NOTIFIER:INIT() *snacks-notifier-module-notifier:init()* >lua notifier:init() < -NOTIFIER:LAYOUT() ~ +NOTIFIER:LAYOUT() *snacks-notifier-module-notifier:layout()* >lua notifier:layout() < -NOTIFIER:NOTIFY() ~ +NOTIFIER:NOTIFY() *snacks-notifier-module-notifier:notify()* >lua ---@param msg string @@ -158,7 +167,7 @@ NOTIFIER:NOTIFY() ~ < -NOTIFIER:RENDER() ~ +NOTIFIER:RENDER() *snacks-notifier-module-notifier:render()* >lua ---@param notif snacks.notifier.Notif @@ -166,21 +175,21 @@ NOTIFIER:RENDER() ~ < -NOTIFIER:SORT() ~ +NOTIFIER:SORT() *snacks-notifier-module-notifier:sort()* >lua notifier:sort() < -NOTIFIER:START() ~ +NOTIFIER:START() *snacks-notifier-module-notifier:start()* >lua notifier:start() < -NOTIFIER:UPDATE() ~ +NOTIFIER:UPDATE() *snacks-notifier-module-notifier:update()* >lua notifier:update() diff --git a/doc/snacks-notify.txt b/doc/snacks-notify.txt new file mode 100644 index 00000000..f577535c --- /dev/null +++ b/doc/snacks-notify.txt @@ -0,0 +1,76 @@ +*snacks-notify.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-notify-table-of-contents* + +1. Types |snacks-notify-types| +2. Module |snacks-notify-module| + - Snacks.notify() |snacks-notify-module-snacks.notify()| + - Snacks.notify.error() |snacks-notify-module-snacks.notify.error()| + - Snacks.notify.info() |snacks-notify-module-snacks.notify.info()| + - Snacks.notify.notify() |snacks-notify-module-snacks.notify.notify()| + - Snacks.notify.warn() |snacks-notify-module-snacks.notify.warn()| + +============================================================================== +1. Types *snacks-notify-types* + +>lua + ---@alias snacks.notify.Opts {level?: number, title?: string, once?: boolean, ft?: string} +< + + +============================================================================== +2. Module *snacks-notify-module* + +>lua + ---@class snacks.notify + Snacks.notify = {} +< + + +SNACKS.NOTIFY() *snacks-notify-module-snacks.notify()* + +>lua + ---@type fun(msg: string|string[], opts?: snacks.notify.Opts) + Snacks.notify() +< + + +SNACKS.NOTIFY.ERROR() *snacks-notify-module-snacks.notify.error()* + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.error(msg, opts) +< + + +SNACKS.NOTIFY.INFO() *snacks-notify-module-snacks.notify.info()* + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.info(msg, opts) +< + + +SNACKS.NOTIFY.NOTIFY() *snacks-notify-module-snacks.notify.notify()* + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.notify(msg, opts) +< + + +SNACKS.NOTIFY.WARN() *snacks-notify-module-snacks.notify.warn()* + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.warn(msg, opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-quickfile.txt b/doc/snacks-quickfile.txt new file mode 100644 index 00000000..c4fec951 --- /dev/null +++ b/doc/snacks-quickfile.txt @@ -0,0 +1,39 @@ +*snacks-quickfile.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-quickfile-table-of-contents* + +1. Config |snacks-quickfile-config| +2. Module |snacks-quickfile-module| + - Snacks.quickfile.setup()|snacks-quickfile-module-snacks.quickfile.setup()| + +============================================================================== +1. Config *snacks-quickfile-config* + +>lua + ---@class snacks.quickfile.Config + { + -- any treesitter langs to exclude + exclude = { "latex" }, + } +< + + +============================================================================== +2. Module *snacks-quickfile-module* + +>lua + ---@class snacks.quickfile + Snacks.quickfile = {} +< + + +SNACKS.QUICKFILE.SETUP() *snacks-quickfile-module-snacks.quickfile.setup()* + +>lua + Snacks.quickfile.setup() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-rename.txt b/doc/snacks-rename.txt new file mode 100644 index 00000000..d8aace91 --- /dev/null +++ b/doc/snacks-rename.txt @@ -0,0 +1,55 @@ +*snacks-rename.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-rename-table-of-contents* + +1. Module |snacks-rename-module| + - Snacks.rename() |snacks-rename-module-snacks.rename()| + - Snacks.rename.on_rename() |snacks-rename-module-snacks.rename.on_rename()| + - Snacks.rename.realpath() |snacks-rename-module-snacks.rename.realpath()| + - Snacks.rename.rename() |snacks-rename-module-snacks.rename.rename()| + +============================================================================== +1. Module *snacks-rename-module* + +>lua + ---@class snacks.rename + Snacks.rename = {} +< + + +SNACKS.RENAME() *snacks-rename-module-snacks.rename()* + +>lua + ---@type fun() + Snacks.rename() +< + + +SNACKS.RENAME.ON_RENAME() *snacks-rename-module-snacks.rename.on_rename()* + +>lua + ---@param from string + ---@param to string + ---@param rename? fun() + Snacks.rename.on_rename(from, to, rename) +< + + +SNACKS.RENAME.REALPATH() *snacks-rename-module-snacks.rename.realpath()* + +>lua + ---@param path string + Snacks.rename.realpath(path) +< + + +SNACKS.RENAME.RENAME() *snacks-rename-module-snacks.rename.rename()* + +>lua + Snacks.rename.rename() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-statuscolumn.txt b/doc/snacks-statuscolumn.txt new file mode 100644 index 00000000..7c7e7630 --- /dev/null +++ b/doc/snacks-statuscolumn.txt @@ -0,0 +1,119 @@ +*snacks-statuscolumn.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-statuscolumn-table-of-contents* + +1. Config |snacks-statuscolumn-config| +2. Types |snacks-statuscolumn-types| +3. Module |snacks-statuscolumn-module| + - Snacks.statuscolumn() |snacks-statuscolumn-module-snacks.statuscolumn()| + - Snacks.statuscolumn.buf_signs()|snacks-statuscolumn-module-snacks.statuscolumn.buf_signs()| + - Snacks.statuscolumn.get()|snacks-statuscolumn-module-snacks.statuscolumn.get()| + - Snacks.statuscolumn.icon()|snacks-statuscolumn-module-snacks.statuscolumn.icon()| + - Snacks.statuscolumn.is_git_sign()|snacks-statuscolumn-module-snacks.statuscolumn.is_git_sign()| + - Snacks.statuscolumn.line_signs()|snacks-statuscolumn-module-snacks.statuscolumn.line_signs()| + - Snacks.statuscolumn.setup()|snacks-statuscolumn-module-snacks.statuscolumn.setup()| + +============================================================================== +1. Config *snacks-statuscolumn-config* + +>lua + ---@class snacks.statuscolumn.Config + { + left = { "mark", "sign" }, + right = { "fold", "git" }, + folds = { + open = false, -- show open fold icons + git_hl = false, -- use Git Signs hl for fold icons + }, + git = { + patterns = { "GitSign", "MiniDiffSign" }, + }, + refresh = 50, -- refresh at most every 50ms + } +< + + +============================================================================== +2. Types *snacks-statuscolumn-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} +< + + +============================================================================== +3. Module *snacks-statuscolumn-module* + +>lua + ---@class snacks.statuscolumn + Snacks.statuscolumn = {} +< + + +SNACKS.STATUSCOLUMN() *snacks-statuscolumn-module-snacks.statuscolumn()* + +>lua + ---@type fun(): string + Snacks.statuscolumn() +< + + +SNACKS.STATUSCOLUMN.BUF_SIGNS()*snacks-statuscolumn-module-snacks.statuscolumn.buf_signs()* + +Returns a list of regular and extmark signs sorted by priority (low to high) + +>lua + ---@return table + ---@param buf number + Snacks.statuscolumn.buf_signs(buf) +< + + +SNACKS.STATUSCOLUMN.GET()*snacks-statuscolumn-module-snacks.statuscolumn.get()* + +>lua + Snacks.statuscolumn.get() +< + + +SNACKS.STATUSCOLUMN.ICON()*snacks-statuscolumn-module-snacks.statuscolumn.icon()* + +>lua + ---@param sign? snacks.statuscolumn.Sign + ---@param len? number + Snacks.statuscolumn.icon(sign, len) +< + + +SNACKS.STATUSCOLUMN.IS_GIT_SIGN()*snacks-statuscolumn-module-snacks.statuscolumn.is_git_sign()* + +>lua + ---@param name string + Snacks.statuscolumn.is_git_sign(name) +< + + +SNACKS.STATUSCOLUMN.LINE_SIGNS()*snacks-statuscolumn-module-snacks.statuscolumn.line_signs()* + +Returns a list of regular and extmark signs sorted by priority (high to low) + +>lua + ---@return snacks.statuscolumn.Sign[] + ---@param win number + ---@param buf number + ---@param lnum number + Snacks.statuscolumn.line_signs(win, buf, lnum) +< + + +SNACKS.STATUSCOLUMN.SETUP()*snacks-statuscolumn-module-snacks.statuscolumn.setup()* + +>lua + Snacks.statuscolumn.setup() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-terminal.txt b/doc/snacks-terminal.txt similarity index 69% rename from doc/snacks.nvim-terminal.txt rename to doc/snacks-terminal.txt index 18f1cbad..c4f557b0 100644 --- a/doc/snacks.nvim-terminal.txt +++ b/doc/snacks-terminal.txt @@ -1,17 +1,16 @@ -*snacks.nvim-terminal.txt* For Neovim Last change: 2024 November 05 +*snacks-terminal.txt* For Neovim Last change: 2024 November 05 ============================================================================== -Table of Contents *snacks.nvim-terminal-table-of-contents* +Table of Contents *snacks-terminal-table-of-contents* -1. terminal |snacks.nvim-terminal-terminal| - - Config |snacks.nvim-terminal-terminal-config| - - Module |snacks.nvim-terminal-terminal-module| +1. Config |snacks-terminal-config| +2. Module |snacks-terminal-module| + - Snacks.terminal() |snacks-terminal-module-snacks.terminal()| + - Snacks.terminal.open() |snacks-terminal-module-snacks.terminal.open()| + - Snacks.terminal.toggle() |snacks-terminal-module-snacks.terminal.toggle()| ============================================================================== -1. terminal *snacks.nvim-terminal-terminal* - - -CONFIG *snacks.nvim-terminal-terminal-config* +1. Config *snacks-terminal-config* >lua ---@class snacks.terminal.Config @@ -56,7 +55,8 @@ CONFIG *snacks.nvim-terminal-terminal-config* < -MODULE *snacks.nvim-terminal-terminal-module* +============================================================================== +2. Module *snacks-terminal-module* >lua ---@class snacks.terminal: snacks.win @@ -66,7 +66,7 @@ MODULE *snacks.nvim-terminal-terminal-module* < -SNACKS.TERMINAL() ~ +SNACKS.TERMINAL() *snacks-terminal-module-snacks.terminal()* >lua ---@type fun(cmd?: string|string[], opts?: snacks.terminal.Config): snacks.terminal @@ -74,7 +74,7 @@ SNACKS.TERMINAL() ~ < -SNACKS.TERMINAL.OPEN() ~ +SNACKS.TERMINAL.OPEN() *snacks-terminal-module-snacks.terminal.open()* >lua ---@param cmd? string | string[] @@ -83,7 +83,7 @@ SNACKS.TERMINAL.OPEN() ~ < -SNACKS.TERMINAL.TOGGLE() ~ +SNACKS.TERMINAL.TOGGLE() *snacks-terminal-module-snacks.terminal.toggle()* >lua ---@param cmd? string | string[] diff --git a/doc/snacks-toggle.txt b/doc/snacks-toggle.txt new file mode 100644 index 00000000..df639ceb --- /dev/null +++ b/doc/snacks-toggle.txt @@ -0,0 +1,163 @@ +*snacks-toggle.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-toggle-table-of-contents* + +1. Config |snacks-toggle-config| +2. Types |snacks-toggle-types| +3. Module |snacks-toggle-module| + - Snacks.toggle() |snacks-toggle-module-snacks.toggle()| + - Snacks.toggle.diagnostics()|snacks-toggle-module-snacks.toggle.diagnostics()| + - Snacks.toggle.inlay_hints()|snacks-toggle-module-snacks.toggle.inlay_hints()| + - Snacks.toggle.line_number()|snacks-toggle-module-snacks.toggle.line_number()| + - Snacks.toggle.new() |snacks-toggle-module-snacks.toggle.new()| + - Snacks.toggle.option() |snacks-toggle-module-snacks.toggle.option()| + - Snacks.toggle.treesitter()|snacks-toggle-module-snacks.toggle.treesitter()| + - toggle:_wk() |snacks-toggle-module-toggle:_wk()| + - toggle:get() |snacks-toggle-module-toggle:get()| + - toggle:map() |snacks-toggle-module-toggle:map()| + - toggle:set() |snacks-toggle-module-toggle:set()| + - toggle:toggle() |snacks-toggle-module-toggle:toggle()| + +============================================================================== +1. Config *snacks-toggle-config* + +>lua + ---@class snacks.toggle.Config + ---@field icon? string|{ enabled: string, disabled: string } + ---@field color? string|{ enabled: string, disabled: string } + { + map = vim.keymap.set, + which_key = true, + notify = true, + icon = { + enabled = " ", + disabled = " ", + }, + color = { + enabled = "green", + disabled = "yellow", + }, + } +< + + +============================================================================== +2. Types *snacks-toggle-types* + +>lua + ---@class snacks.toggle.Opts: snacks.toggle.Config + ---@field name string + ---@field get fun():boolean + ---@field set fun(state:boolean) +< + + +============================================================================== +3. Module *snacks-toggle-module* + +>lua + ---@class snacks.toggle + ---@field opts snacks.toggle.Opts + Snacks.toggle = {} +< + + +SNACKS.TOGGLE() *snacks-toggle-module-snacks.toggle()* + +>lua + ---@type fun(... :snacks.toggle.Opts): snacks.toggle + Snacks.toggle() +< + + +SNACKS.TOGGLE.DIAGNOSTICS() *snacks-toggle-module-snacks.toggle.diagnostics()* + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.diagnostics(opts) +< + + +SNACKS.TOGGLE.INLAY_HINTS() *snacks-toggle-module-snacks.toggle.inlay_hints()* + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.inlay_hints(opts) +< + + +SNACKS.TOGGLE.LINE_NUMBER() *snacks-toggle-module-snacks.toggle.line_number()* + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.line_number(opts) +< + + +SNACKS.TOGGLE.NEW() *snacks-toggle-module-snacks.toggle.new()* + +>lua + ---@param ... snacks.toggle.Opts + ---@return snacks.toggle + Snacks.toggle.new(...) +< + + +SNACKS.TOGGLE.OPTION() *snacks-toggle-module-snacks.toggle.option()* + +>lua + ---@param option string + ---@param opts? snacks.toggle.Config | {on?: unknown, off?: unknown} + Snacks.toggle.option(option, opts) +< + + +SNACKS.TOGGLE.TREESITTER() *snacks-toggle-module-snacks.toggle.treesitter()* + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.treesitter(opts) +< + + +TOGGLE:_WK() *snacks-toggle-module-toggle:_wk()* + +>lua + toggle:_wk(keys, mode) +< + + +TOGGLE:GET() *snacks-toggle-module-toggle:get()* + +>lua + toggle:get() +< + + +TOGGLE:MAP() *snacks-toggle-module-toggle:map()* + +>lua + ---@param keys string + ---@param opts? vim.keymap.set.Opts | { mode: string|string[]} + toggle:map(keys, opts) +< + + +TOGGLE:SET() *snacks-toggle-module-toggle:set()* + +>lua + ---@param state boolean + toggle:set(state) +< + + +TOGGLE:TOGGLE() *snacks-toggle-module-toggle:toggle()* + +>lua + toggle:toggle() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-win.txt b/doc/snacks-win.txt new file mode 100644 index 00000000..7c39421e --- /dev/null +++ b/doc/snacks-win.txt @@ -0,0 +1,182 @@ +*snacks-win.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-win-table-of-contents* + +1. Config |snacks-win-config| +2. Types |snacks-win-types| +3. Module |snacks-win-module| + - Snacks.win() |snacks-win-module-snacks.win()| + - Snacks.win.new() |snacks-win-module-snacks.win.new()| + - Snacks.win.resolve() |snacks-win-module-snacks.win.resolve()| + - win:buf_valid() |snacks-win-module-win:buf_valid()| + - win:close() |snacks-win-module-win:close()| + - win:hide() |snacks-win-module-win:hide()| + - win:is_floating() |snacks-win-module-win:is_floating()| + - win:show() |snacks-win-module-win:show()| + - win:size() |snacks-win-module-win:size()| + - win:toggle() |snacks-win-module-win:toggle()| + - win:update() |snacks-win-module-win:update()| + - win:valid() |snacks-win-module-win:valid()| + - win:win_valid() |snacks-win-module-win:win_valid()| + +============================================================================== +1. Config *snacks-win-config* + +>lua + ---@class snacks.win.Config + ---@field view? string merges with config from `Snacks.config.views[view]` + ---@field position? "float"|"bottom"|"top"|"left"|"right" + ---@field buf? number + ---@field file? string + ---@field enter? boolean + ---@field backdrop? number|false + ---@field win? vim.api.keyset.win_config + ---@field wo? vim.wo + ---@field bo? vim.bo + ---@field keys? table + ---@field on_buf? fun(self: snacks.win) + ---@field on_win? fun(self: snacks.win) + { + position = "float", + win = { + relative = "editor", + style = "minimal", + }, + wo = { + winhighlight = "Normal:NormalFloat,NormalNC:NormalFloat", + }, + bo = {}, + keys = { + q = "close", + }, + } +< + + +============================================================================== +2. Types *snacks-win-types* + +>lua + ---@class snacks.win.Keys: vim.api.keyset.keymap + ---@field [1]? string + ---@field [2]? string|fun(self: snacks.win): any + ---@field mode? string|string[] +< + + +============================================================================== +3. Module *snacks-win-module* + +>lua + ---@class snacks.win + ---@field id number + ---@field buf? number + ---@field win? number + ---@field opts snacks.win.Config + ---@field augroup? number + ---@field backdrop? snacks.win + Snacks.win = {} +< + + +SNACKS.WIN() *snacks-win-module-snacks.win()* + +>lua + ---@type fun(opts? :snacks.win.Config): snacks.win + Snacks.win() +< + + +SNACKS.WIN.NEW() *snacks-win-module-snacks.win.new()* + +>lua + ---@param opts? snacks.win.Config | { show?: boolean } + ---@return snacks.win + Snacks.win.new(opts) +< + + +SNACKS.WIN.RESOLVE() *snacks-win-module-snacks.win.resolve()* + +>lua + ---@param opts? snacks.win.Config + ---@return snacks.win.Config + Snacks.win.resolve(opts) +< + + +WIN:BUF_VALID() *snacks-win-module-win:buf_valid()* + +>lua + win:buf_valid() +< + + +WIN:CLOSE() *snacks-win-module-win:close()* + +>lua + ---@param opts? { buf: boolean } + win:close(opts) +< + + +WIN:HIDE() *snacks-win-module-win:hide()* + +>lua + win:hide() +< + + +WIN:IS_FLOATING() *snacks-win-module-win:is_floating()* + +>lua + win:is_floating() +< + + +WIN:SHOW() *snacks-win-module-win:show()* + +>lua + win:show() +< + + +WIN:SIZE() *snacks-win-module-win:size()* + +>lua + ---@return { height: number, width: number } + win:size() +< + + +WIN:TOGGLE() *snacks-win-module-win:toggle()* + +>lua + win:toggle() +< + + +WIN:UPDATE() *snacks-win-module-win:update()* + +>lua + win:update() +< + + +WIN:VALID() *snacks-win-module-win:valid()* + +>lua + win:valid() +< + + +WIN:WIN_VALID() *snacks-win-module-win:win_valid()* + +>lua + win:win_valid() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks-words.txt b/doc/snacks-words.txt new file mode 100644 index 00000000..086479e3 --- /dev/null +++ b/doc/snacks-words.txt @@ -0,0 +1,84 @@ +*snacks-words.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks-words-table-of-contents* + +1. Config |snacks-words-config| +2. Types |snacks-words-types| +3. Module |snacks-words-module| + - Snacks.words.get() |snacks-words-module-snacks.words.get()| + - Snacks.words.is_enabled() |snacks-words-module-snacks.words.is_enabled()| + - Snacks.words.jump() |snacks-words-module-snacks.words.jump()| + - Snacks.words.setup() |snacks-words-module-snacks.words.setup()| + - Snacks.words.update() |snacks-words-module-snacks.words.update()| + +============================================================================== +1. Config *snacks-words-config* + +>lua + ---@class snacks.words.Config + { + enabled = true, + debounce = 200, + } +< + + +============================================================================== +2. Types *snacks-words-types* + +>lua + ---@alias LspWord {from:{[1]:number, [2]:number}, to:{[1]:number, [2]:number}} 1-0 indexed +< + + +============================================================================== +3. Module *snacks-words-module* + +>lua + ---@class snacks.words + Snacks.words = {} +< + + +SNACKS.WORDS.GET() *snacks-words-module-snacks.words.get()* + +>lua + ---@return LspWord[] words, number? current + Snacks.words.get() +< + + +SNACKS.WORDS.IS_ENABLED() *snacks-words-module-snacks.words.is_enabled()* + +>lua + ---@param buf number? + Snacks.words.is_enabled(buf) +< + + +SNACKS.WORDS.JUMP() *snacks-words-module-snacks.words.jump()* + +>lua + ---@param count number + ---@param cycle? boolean + Snacks.words.jump(count, cycle) +< + + +SNACKS.WORDS.SETUP() *snacks-words-module-snacks.words.setup()* + +>lua + Snacks.words.setup() +< + + +SNACKS.WORDS.UPDATE() *snacks-words-module-snacks.words.update()* + +>lua + Snacks.words.update() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-bufdelete.txt b/doc/snacks.nvim-bufdelete.txt deleted file mode 100644 index b342dd09..00000000 --- a/doc/snacks.nvim-bufdelete.txt +++ /dev/null @@ -1,38 +0,0 @@ -*snacks.nvim-bufdelete.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-bufdelete-table-of-contents* - -1. bufdelete |snacks.nvim-bufdelete-bufdelete| - - Module |snacks.nvim-bufdelete-bufdelete-module| - -============================================================================== -1. bufdelete *snacks.nvim-bufdelete-bufdelete* - - -MODULE *snacks.nvim-bufdelete-bufdelete-module* - ->lua - ---@class snacks.bufdelete - Snacks.bufdelete = {} -< - - -SNACKS.BUFDELETE() ~ - ->lua - ---@type fun(buf?: number) - Snacks.bufdelete() -< - - -SNACKS.BUFDELETE.DELETE() ~ - ->lua - ---@param buf number? - Snacks.bufdelete.delete(buf) -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-debug.txt b/doc/snacks.nvim-debug.txt deleted file mode 100644 index eb91ccc1..00000000 --- a/doc/snacks.nvim-debug.txt +++ /dev/null @@ -1,53 +0,0 @@ -*snacks.nvim-debug.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-debug-table-of-contents* - -1. debug |snacks.nvim-debug-debug| - - Module |snacks.nvim-debug-debug-module| - -============================================================================== -1. debug *snacks.nvim-debug-debug* - - -MODULE *snacks.nvim-debug-debug-module* - ->lua - ---@class snacks.debug - Snacks.debug = {} -< - - -SNACKS.DEBUG() ~ - ->lua - ---@type fun(...) - Snacks.debug() -< - - -SNACKS.DEBUG.BACKTRACE() ~ - ->lua - Snacks.debug.backtrace() -< - - -SNACKS.DEBUG.INSPECT() ~ - ->lua - Snacks.debug.inspect(...) -< - - -SNACKS.DEBUG.PROFILE() ~ - ->lua - ---@param fn fun() - ---@param opts? {count?: number, flush?: boolean} - Snacks.debug.profile(fn, opts) -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-notify.txt b/doc/snacks.nvim-notify.txt deleted file mode 100644 index b4d0ec9b..00000000 --- a/doc/snacks.nvim-notify.txt +++ /dev/null @@ -1,74 +0,0 @@ -*snacks.nvim-notify.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-notify-table-of-contents* - -1. notify |snacks.nvim-notify-notify| - - Types |snacks.nvim-notify-notify-types| - - Module |snacks.nvim-notify-notify-module| - -============================================================================== -1. notify *snacks.nvim-notify-notify* - - -TYPES *snacks.nvim-notify-notify-types* - ->lua - ---@alias snacks.notify.Opts {level?: number, title?: string, once?: boolean, ft?: string} -< - - -MODULE *snacks.nvim-notify-notify-module* - ->lua - ---@class snacks.notify - Snacks.notify = {} -< - - -SNACKS.NOTIFY() ~ - ->lua - ---@type fun(msg: string|string[], opts?: snacks.notify.Opts) - Snacks.notify() -< - - -SNACKS.NOTIFY.ERROR() ~ - ->lua - ---@param msg string|string[] - ---@param opts? snacks.notify.Opts - Snacks.notify.error(msg, opts) -< - - -SNACKS.NOTIFY.INFO() ~ - ->lua - ---@param msg string|string[] - ---@param opts? snacks.notify.Opts - Snacks.notify.info(msg, opts) -< - - -SNACKS.NOTIFY.NOTIFY() ~ - ->lua - ---@param msg string|string[] - ---@param opts? snacks.notify.Opts - Snacks.notify.notify(msg, opts) -< - - -SNACKS.NOTIFY.WARN() ~ - ->lua - ---@param msg string|string[] - ---@param opts? snacks.notify.Opts - Snacks.notify.warn(msg, opts) -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-quickfile.txt b/doc/snacks.nvim-quickfile.txt deleted file mode 100644 index 27c3047b..00000000 --- a/doc/snacks.nvim-quickfile.txt +++ /dev/null @@ -1,41 +0,0 @@ -*snacks.nvim-quickfile.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-quickfile-table-of-contents* - -1. quickfile |snacks.nvim-quickfile-quickfile| - - Config |snacks.nvim-quickfile-quickfile-config| - - Module |snacks.nvim-quickfile-quickfile-module| - -============================================================================== -1. quickfile *snacks.nvim-quickfile-quickfile* - - -CONFIG *snacks.nvim-quickfile-quickfile-config* - ->lua - ---@class snacks.quickfile.Config - { - -- any treesitter langs to exclude - exclude = { "latex" }, - } -< - - -MODULE *snacks.nvim-quickfile-quickfile-module* - ->lua - ---@class snacks.quickfile - Snacks.quickfile = {} -< - - -SNACKS.QUICKFILE.SETUP() ~ - ->lua - Snacks.quickfile.setup() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-rename.txt b/doc/snacks.nvim-rename.txt deleted file mode 100644 index 722dbcfc..00000000 --- a/doc/snacks.nvim-rename.txt +++ /dev/null @@ -1,55 +0,0 @@ -*snacks.nvim-rename.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-rename-table-of-contents* - -1. rename |snacks.nvim-rename-rename| - - Module |snacks.nvim-rename-rename-module| - -============================================================================== -1. rename *snacks.nvim-rename-rename* - - -MODULE *snacks.nvim-rename-rename-module* - ->lua - ---@class snacks.rename - Snacks.rename = {} -< - - -SNACKS.RENAME() ~ - ->lua - ---@type fun() - Snacks.rename() -< - - -SNACKS.RENAME.ON_RENAME() ~ - ->lua - ---@param from string - ---@param to string - ---@param rename? fun() - Snacks.rename.on_rename(from, to, rename) -< - - -SNACKS.RENAME.REALPATH() ~ - ->lua - ---@param path string - Snacks.rename.realpath(path) -< - - -SNACKS.RENAME.RENAME() ~ - ->lua - Snacks.rename.rename() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-statuscolumn.txt b/doc/snacks.nvim-statuscolumn.txt deleted file mode 100644 index 818114a7..00000000 --- a/doc/snacks.nvim-statuscolumn.txt +++ /dev/null @@ -1,114 +0,0 @@ -*snacks.nvim-statuscolumn.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-statuscolumn-table-of-contents* - -1. statuscolumn |snacks.nvim-statuscolumn-statuscolumn| - - Config |snacks.nvim-statuscolumn-statuscolumn-config| - - Types |snacks.nvim-statuscolumn-statuscolumn-types| - - Module |snacks.nvim-statuscolumn-statuscolumn-module| - -============================================================================== -1. statuscolumn *snacks.nvim-statuscolumn-statuscolumn* - - -CONFIG *snacks.nvim-statuscolumn-statuscolumn-config* - ->lua - ---@class snacks.statuscolumn.Config - { - left = { "mark", "sign" }, - right = { "fold", "git" }, - folds = { - open = false, -- show open fold icons - git_hl = false, -- use Git Signs hl for fold icons - }, - git = { - patterns = { "GitSign", "MiniDiffSign" }, - }, - refresh = 50, -- refresh at most every 50ms - } -< - - -TYPES *snacks.nvim-statuscolumn-statuscolumn-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 *snacks.nvim-statuscolumn-statuscolumn-module* - ->lua - ---@class snacks.statuscolumn - Snacks.statuscolumn = {} -< - - -SNACKS.STATUSCOLUMN() ~ - ->lua - ---@type fun(): string - Snacks.statuscolumn() -< - - -SNACKS.STATUSCOLUMN.BUF_SIGNS() ~ - -Returns a list of regular and extmark signs sorted by priority (low to high) - ->lua - ---@return table - ---@param buf number - Snacks.statuscolumn.buf_signs(buf) -< - - -SNACKS.STATUSCOLUMN.GET() ~ - ->lua - Snacks.statuscolumn.get() -< - - -SNACKS.STATUSCOLUMN.ICON() ~ - ->lua - ---@param sign? snacks.statuscolumn.Sign - ---@param len? number - Snacks.statuscolumn.icon(sign, len) -< - - -SNACKS.STATUSCOLUMN.IS_GIT_SIGN() ~ - ->lua - ---@param name string - Snacks.statuscolumn.is_git_sign(name) -< - - -SNACKS.STATUSCOLUMN.LINE_SIGNS() ~ - -Returns a list of regular and extmark signs sorted by priority (high to low) - ->lua - ---@return snacks.statuscolumn.Sign[] - ---@param win number - ---@param buf number - ---@param lnum number - Snacks.statuscolumn.line_signs(win, buf, lnum) -< - - -SNACKS.STATUSCOLUMN.SETUP() ~ - ->lua - Snacks.statuscolumn.setup() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-toggle.txt b/doc/snacks.nvim-toggle.txt deleted file mode 100644 index e0c5492e..00000000 --- a/doc/snacks.nvim-toggle.txt +++ /dev/null @@ -1,153 +0,0 @@ -*snacks.nvim-toggle.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-toggle-table-of-contents* - -1. toggle |snacks.nvim-toggle-toggle| - - Config |snacks.nvim-toggle-toggle-config| - - Types |snacks.nvim-toggle-toggle-types| - - Module |snacks.nvim-toggle-toggle-module| - -============================================================================== -1. toggle *snacks.nvim-toggle-toggle* - - -CONFIG *snacks.nvim-toggle-toggle-config* - ->lua - ---@class snacks.toggle.Config - ---@field icon? string|{ enabled: string, disabled: string } - ---@field color? string|{ enabled: string, disabled: string } - { - map = vim.keymap.set, - which_key = true, - notify = true, - icon = { - enabled = " ", - disabled = " ", - }, - color = { - enabled = "green", - disabled = "yellow", - }, - } -< - - -TYPES *snacks.nvim-toggle-toggle-types* - ->lua - ---@class snacks.toggle.Opts: snacks.toggle.Config - ---@field name string - ---@field get fun():boolean - ---@field set fun(state:boolean) -< - - -MODULE *snacks.nvim-toggle-toggle-module* - ->lua - ---@class snacks.toggle - ---@field opts snacks.toggle.Opts - Snacks.toggle = {} -< - - -SNACKS.TOGGLE() ~ - ->lua - ---@type fun(... :snacks.toggle.Opts): snacks.toggle - Snacks.toggle() -< - - -SNACKS.TOGGLE.DIAGNOSTICS() ~ - ->lua - ---@param opts? snacks.toggle.Config - Snacks.toggle.diagnostics(opts) -< - - -SNACKS.TOGGLE.INLAY_HINTS() ~ - ->lua - ---@param opts? snacks.toggle.Config - Snacks.toggle.inlay_hints(opts) -< - - -SNACKS.TOGGLE.LINE_NUMBER() ~ - ->lua - ---@param opts? snacks.toggle.Config - Snacks.toggle.line_number(opts) -< - - -SNACKS.TOGGLE.NEW() ~ - ->lua - ---@param ... snacks.toggle.Opts - ---@return snacks.toggle - Snacks.toggle.new(...) -< - - -SNACKS.TOGGLE.OPTION() ~ - ->lua - ---@param option string - ---@param opts? snacks.toggle.Config | {on?: unknown, off?: unknown} - Snacks.toggle.option(option, opts) -< - - -SNACKS.TOGGLE.TREESITTER() ~ - ->lua - ---@param opts? snacks.toggle.Config - Snacks.toggle.treesitter(opts) -< - - -TOGGLE:_WK() ~ - ->lua - toggle:_wk(keys, mode) -< - - -TOGGLE:GET() ~ - ->lua - toggle:get() -< - - -TOGGLE:MAP() ~ - ->lua - ---@param keys string - ---@param opts? vim.keymap.set.Opts | { mode: string|string[]} - toggle:map(keys, opts) -< - - -TOGGLE:SET() ~ - ->lua - ---@param state boolean - toggle:set(state) -< - - -TOGGLE:TOGGLE() ~ - ->lua - toggle:toggle() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-win.txt b/doc/snacks.nvim-win.txt deleted file mode 100644 index 8d572873..00000000 --- a/doc/snacks.nvim-win.txt +++ /dev/null @@ -1,171 +0,0 @@ -*snacks.nvim-win.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-win-table-of-contents* - -1. win |snacks.nvim-win-win| - - Config |snacks.nvim-win-win-config| - - Types |snacks.nvim-win-win-types| - - Module |snacks.nvim-win-win-module| - -============================================================================== -1. win *snacks.nvim-win-win* - - -CONFIG *snacks.nvim-win-win-config* - ->lua - ---@class snacks.win.Config - ---@field view? string merges with config from `Snacks.config.views[view]` - ---@field position? "float"|"bottom"|"top"|"left"|"right" - ---@field buf? number - ---@field file? string - ---@field enter? boolean - ---@field backdrop? number|false - ---@field win? vim.api.keyset.win_config - ---@field wo? vim.wo - ---@field bo? vim.bo - ---@field keys? table - ---@field on_buf? fun(self: snacks.win) - ---@field on_win? fun(self: snacks.win) - { - position = "float", - win = { - relative = "editor", - style = "minimal", - }, - wo = { - winhighlight = "Normal:NormalFloat,NormalNC:NormalFloat", - }, - bo = {}, - keys = { - q = "close", - }, - } -< - - -TYPES *snacks.nvim-win-win-types* - ->lua - ---@class snacks.win.Keys: vim.api.keyset.keymap - ---@field [1]? string - ---@field [2]? string|fun(self: snacks.win): any - ---@field mode? string|string[] -< - - -MODULE *snacks.nvim-win-win-module* - ->lua - ---@class snacks.win - ---@field id number - ---@field buf? number - ---@field win? number - ---@field opts snacks.win.Config - ---@field augroup? number - ---@field backdrop? snacks.win - Snacks.win = {} -< - - -SNACKS.WIN() ~ - ->lua - ---@type fun(opts? :snacks.win.Config): snacks.win - Snacks.win() -< - - -SNACKS.WIN.NEW() ~ - ->lua - ---@param opts? snacks.win.Config | { show?: boolean } - ---@return snacks.win - Snacks.win.new(opts) -< - - -SNACKS.WIN.RESOLVE() ~ - ->lua - ---@param opts? snacks.win.Config - ---@return snacks.win.Config - Snacks.win.resolve(opts) -< - - -WIN:BUF_VALID() ~ - ->lua - win:buf_valid() -< - - -WIN:CLOSE() ~ - ->lua - ---@param opts? { buf: boolean } - win:close(opts) -< - - -WIN:HIDE() ~ - ->lua - win:hide() -< - - -WIN:IS_FLOATING() ~ - ->lua - win:is_floating() -< - - -WIN:SHOW() ~ - ->lua - win:show() -< - - -WIN:SIZE() ~ - ->lua - ---@return { height: number, width: number } - win:size() -< - - -WIN:TOGGLE() ~ - ->lua - win:toggle() -< - - -WIN:UPDATE() ~ - ->lua - win:update() -< - - -WIN:VALID() ~ - ->lua - win:valid() -< - - -WIN:WIN_VALID() ~ - ->lua - win:win_valid() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-words.txt b/doc/snacks.nvim-words.txt deleted file mode 100644 index ef74065a..00000000 --- a/doc/snacks.nvim-words.txt +++ /dev/null @@ -1,81 +0,0 @@ -*snacks.nvim-words.txt* For Neovim Last change: 2024 November 05 - -============================================================================== -Table of Contents *snacks.nvim-words-table-of-contents* - -1. words |snacks.nvim-words-words| - - Config |snacks.nvim-words-words-config| - - Types |snacks.nvim-words-words-types| - - Module |snacks.nvim-words-words-module| - -============================================================================== -1. words *snacks.nvim-words-words* - - -CONFIG *snacks.nvim-words-words-config* - ->lua - ---@class snacks.words.Config - { - enabled = true, - debounce = 200, - } -< - - -TYPES *snacks.nvim-words-words-types* - ->lua - ---@alias LspWord {from:{[1]:number, [2]:number}, to:{[1]:number, [2]:number}} 1-0 indexed -< - - -MODULE *snacks.nvim-words-words-module* - ->lua - ---@class snacks.words - Snacks.words = {} -< - - -SNACKS.WORDS.GET() ~ - ->lua - ---@return LspWord[] words, number? current - Snacks.words.get() -< - - -SNACKS.WORDS.IS_ENABLED() ~ - ->lua - ---@param buf number? - Snacks.words.is_enabled(buf) -< - - -SNACKS.WORDS.JUMP() ~ - ->lua - ---@param count number - ---@param cycle? boolean - Snacks.words.jump(count, cycle) -< - - -SNACKS.WORDS.SETUP() ~ - ->lua - Snacks.words.setup() -< - - -SNACKS.WORDS.UPDATE() ~ - ->lua - Snacks.words.update() -< - -Generated by panvimdoc - -vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/scripts/docs b/scripts/docs index cacb2de8..e8fa4886 100755 --- a/scripts/docs +++ b/scripts/docs @@ -11,5 +11,5 @@ fi PANVIMDOC=~/projects/panvimdoc for f in docs/*.md; do - $PANVIMDOC/panvimdoc.sh --project-name "snacks.nvim-$(basename "$f" .md)" --input-file "$f" --vim-version "Neovim" --demojify "true" + $PANVIMDOC/panvimdoc.sh --project-name "snacks-$(basename "$f" .md)" --input-file "$f" --vim-version "Neovim" --demojify "true" --shift-heading-level-by -1 done