mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-07-24 05:25:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs(image): screenshot and docs

Browse source
This commit is contained in:
Folke Lemaitre 2025-02-09 22:39:13 +01:00
parent 56b432ffea
commit 9ba7abb855
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
2 changed files with 53 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/image.md
View file

@ -1,5 +1,29 @@
# 🍿 image
![Image](https://github.com/user-attachments/assets/4e8a686c-bf41-4989-9d74-1641ecf2835f)
Image viewer using the [Kitty Graphics Protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/).
Supported terminals:
- [kitty](https://sw.kovidgoyal.net/kitty/)
- [wezterm](https://wezfurlong.org/wezterm/)
- [ghostty](https://ghostty.org/)
In order to automatically display the image when openinng an image file,
you need to enable the `image` plugin in your `snacks` config.
Supported image formats:
- PNG
- JPEG/JPG
- GIF
- BMP
- WEBP
[ImageMagick](https://imagemagick.org/index.php) is required to convert images
to the supported formats (all except PNG).
<!-- docgen -->
## 📦 Setup