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

docs: readme

Browse source
This commit is contained in:
Folke Lemaitre 2024-11-06 00:08:45 +01:00
parent 82b2e83dd5
commit bd5acea753
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
1 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -7,23 +7,23 @@ A collection of small QoL plugins for Neovim.
## ✨ Features
| Module | Description | Readme |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
| [bigfile](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/bigfile.lua) | Deal with big files | [README](https://github.com/folke/snacks.nvim/blob/main/docs/bigfile.md) |
| [bufdelete](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/bufdelete.lua) | Delete buffers without disrupting window layout | [README](https://github.com/folke/snacks.nvim/blob/main/docs/bufdelete.md) |
| [debug](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/debug.lua) | Pretty inspect & backtraces for debugging | [README](https://github.com/folke/snacks.nvim/blob/main/docs/debug.md) |
| [git](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/git.lua) | Useful tools for Git | [README](https://github.com/folke/snacks.nvim/blob/main/docs/git.md) |
| [gitbrowse](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/gitbrowse.lua) | Open the repo of the active file in the browser (e.g., GitHub) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/gitbrowse.md) |
| [lazygit](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/lazygit.lua) | Open LazyGit in a float, auto-configure colorscheme and integration with Neovim | [README](https://github.com/folke/snacks.nvim/blob/main/docs/lazygit.md) |
| [notify](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/notify.lua) | Small wrapper around Neovim's `vim.notify` | [README](https://github.com/folke/snacks.nvim/blob/main/docs/notify.md) |
| [notifier](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/notifier.lua) | Better `vim.notify` | [README](https://github.com/folke/snacks.nvim/blob/main/docs/notifier.md) |
| [quickfile](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/quickfile.lua) | Render a file as quickly as possible before loading all plugins (progressive rendering) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/quickfile.md) |
| [rename](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/rename.lua) | LSP-integrated renaming with support for plugins like neo-tree, nvim-tree, oil, mini.files | [README](https://github.com/folke/snacks.nvim/blob/main/docs/rename.md) |
| [statuscolumn](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/statuscolumn.lua) | Customizable statuscolumn | [README](https://github.com/folke/snacks.nvim/blob/main/docs/statuscolumn.md) |
| [terminal](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/terminal.lua) | Create and toggle floating/sp. Uses **float**. | [README](https://github.com/folke/snacks.nvim/blob/main/docs/terminal.md) |
| [toggle](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/toggle.lua) | Toggle keymaps integrated with which-key icons / colors | [README](https://github.com/folke/snacks.nvim/blob/main/docs/toggle.md) |
| [win](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/win.lua) | Easily create and manage floating windows or splits | [README](https://github.com/folke/snacks.nvim/blob/main/docs/win.md) |
| [words](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/words.lua) | Auto-show LSP references, auto-show and quick navigation between them | [README](https://github.com/folke/snacks.nvim/blob/main/docs/words.md) |
| Module | Description | Readme |
| ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [bigfile](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/bigfile.lua) | Deal with big files (**requires** `setup`) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/bigfile.md) |
| [bufdelete](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/bufdelete.lua) | Delete buffers without disrupting window layout | [README](https://github.com/folke/snacks.nvim/blob/main/docs/bufdelete.md) |
| [debug](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/debug.lua) | Pretty inspect & backtraces for debugging | [README](https://github.com/folke/snacks.nvim/blob/main/docs/debug.md) |
| [git](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/git.lua) | Useful functions for Git | [README](https://github.com/folke/snacks.nvim/blob/main/docs/git.md) |
| [gitbrowse](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/gitbrowse.lua) | Open the repo of the active file in the browser (e.g., GitHub) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/gitbrowse.md) |
| [lazygit](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/lazygit.lua) | Open LazyGit in a float, auto-configure colorscheme and integration with Neovim | [README](https://github.com/folke/snacks.nvim/blob/main/docs/lazygit.md) |
| [notify](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/notify.lua) | Utility functions to work with Neovim's `vim.notify` | [README](https://github.com/folke/snacks.nvim/blob/main/docs/notify.md) |
| [notifier](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/notifier.lua) | Better and prettier `vim.notify` (**requires** `setup`) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/notifier.md) |
| [quickfile](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/quickfile.lua) | When doing `nvim somefile.txt`, it will render the file as quickly as possible, before loading your plugins. (**requires** `setup`) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/quickfile.md) |
| [rename](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/rename.lua) | LSP-integrated renaming with support for plugins like neo-tree, nvim-tree, oil, mini.files | [README](https://github.com/folke/snacks.nvim/blob/main/docs/rename.md) |
| [statuscolumn](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/statuscolumn.lua) | Pretty statuscolumn (**requires** `setup`) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/statuscolumn.md) |
| [terminal](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/terminal.lua) | Create and toggle floating/sp. Uses **float**. | [README](https://github.com/folke/snacks.nvim/blob/main/docs/terminal.md) |
| [toggle](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/toggle.lua) | Toggle keymaps integrated with which-key icons / colors | [README](https://github.com/folke/snacks.nvim/blob/main/docs/toggle.md) |
| [win](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/win.lua) | Easily create and manage floating windows or splits | [README](https://github.com/folke/snacks.nvim/blob/main/docs/win.md) |
| [words](https://github.com/folke/snacks.nvim/blob/main/lua/snacks/words.lua) | Auto-show LSP references and quickly navigate between them (**requires** `setup`) | [README](https://github.com/folke/snacks.nvim/blob/main/docs/words.md) |
## ⚡️ Requirements