docs(image): screenshot and docs

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

View file

@ -17,6 +17,30 @@ Table of Contents *snacks-image-table-of-contents*
- image:render() |snacks-image-module-image:render()|
- image:request() |snacks-image-module-image:request()|
- image:update() |snacks-image-module-image:update()|
5. Links |snacks-image-links|
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).
==============================================================================
1. Setup *snacks-image-setup*
@ -147,6 +171,11 @@ IMAGE:UPDATE() *snacks-image-module-image:update()*
image:update()
<
==============================================================================
5. Links *snacks-image-links*
1. *Image*: https://github.com/user-attachments/assets/4e8a686c-bf41-4989-9d74-1641ecf2835f
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl:

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