{"id":27111812,"url":"https://github.com/akutchi/imagepreview.nvim","last_synced_at":"2025-10-11T02:15:13.521Z","repository":{"id":286190273,"uuid":"960661694","full_name":"Akutchi/imagepreview.nvim","owner":"Akutchi","description":"A simple colored braille image preview for NeoVim","archived":false,"fork":false,"pushed_at":"2025-04-07T20:05:50.000Z","size":20846,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:57:16.386Z","etag":null,"topics":["ascii-art","image","lua","lunarvim","neovim","neovim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Akutchi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-04T20:34:05.000Z","updated_at":"2025-04-07T20:05:53.000Z","dependencies_parsed_at":"2025-04-04T21:46:44.232Z","dependency_job_id":null,"html_url":"https://github.com/Akutchi/imagepreview.nvim","commit_stats":null,"previous_names":["akutchi/imagepreview","akutchi/imagepreview.nvim"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Akutchi/imagepreview.nvim","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Akutchi%2Fimagepreview.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Akutchi%2Fimagepreview.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Akutchi%2Fimagepreview.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Akutchi%2Fimagepreview.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Akutchi","download_url":"https://codeload.github.com/Akutchi/imagepreview.nvim/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Akutchi%2Fimagepreview.nvim/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005922,"owners_count":26083997,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii-art","image","lua","lunarvim","neovim","neovim-plugin"],"created_at":"2025-04-07T01:24:53.805Z","updated_at":"2025-10-11T02:15:13.488Z","avatar_url":"https://github.com/Akutchi.png","language":"Lua","readme":"# ImagePreview\n\n## Description\n\nImagePreview is a plugin that helps display preview of images in a neovim environnement.\nIf you're like me and you don't want to use Xterm, Kitty etc. for whatever reason, you\ncan't really preview full blown images in your basic terminal.\\\nThis is why I decided to create a program that could display ascii rendering of images.\nAs such, I'm fully conscious of the fact that it is what it is. The resolution depending\nlargely on the original image's details.\n\nThe plugin is currently checking for .png, .jpg, .jpeg and .webp images.\n\n## 📦 Installation\n\n### Requirements\n\n- Imagemagick (I used 6.9.11 but older versions should be good)\n- Neovim \u003e= 0.5.0\n- [nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua) (I should be using 1.11.0 but older versions should be good)\n- [nui.nvim](https://github.com/MunifTanjim/nui.nvim) (already marked as a dependency in lazy.nvim)\n\n### Supported distributions\nWhile the plugin should theorically work on gnome-based distributions, I did not test it on other distro than Ubuntu 22.04.05\\\nIf you're interested, don't hesitate to apply for a merge request to add your distro to the list of supported ones.\n\n#### Gnome-Based Distributions\nI suppose that you have a /etc/default/console-setup file that configure your ttys. This file must have those\nlines, which describe the current font in use for them.\n```shell\nFONTFACE=\"\\[FONT\\]-\\[TYPE\\]\"\nFONTSIZE=\"8x[SIZE]\"\n```\n\n⚠️ Beware : for this to work, I'm using the system-wide font. Please uncheck the \"custom font\" option in your gnome terminal\npreferences. (Don't worry, the plugin revert back to the custom font when it's done).\n\n### ⚙️ Configuration\n\n#### [Lazy.nvim](https://github.com/folke/lazy.nvim)\n\n```lua\n{\n    \"Akutchi/ImagePreview\",\n    dependencies = { \"MunifTanjim/nui.nvim\" }    \n}\n```\nTo create the key binding, copy/paste this in your config.lua file, or wherever your config is :\n##### Neovim\n```lua\nvim.keymap.set('n', '\u003cleader\u003eip', require('imagepreview').Preview, { noremap = true, desc = \"Preview an image\" })\n```\n##### Lunarvim\n```lua\nlvim.builtin.which_key.mappings[\"i\"] = {\n  name = \"Image\",\n  p = { \"\u003ccmd\u003elua require('imagepreview').Preview()\u003ccr\u003e\", \"Preview an image\" }\n}\n```\n\n## Usage\n\nIts usage is pretty basic. First, open the tree explorer with \\\u003cleader\u003ee, and place the cursor on\nthe image you want to preview. Then, use \\\u003cleader\u003eip to preview your image. Clicking anywhere else\nthe ascii rendering close the preview.\n\n![gif](./doc/visual.gif)\n\n## Credits\n\nThis is my first neovim plugin. It was _hell_ to create, and as such, I'd like to thank some people\nthat helped me create my plugin (without them knowing, ofc). Those are,\n- [m4xshen](https://m4xshen.dev/posts/develop-a-neovim-plugin-in-lua) for the general idea on how to create a \nlocal plugin.\n- [D029](https://vi.stackexchange.com/a/46098) and\n[Folke](https://www.reddit.com/r/neovim/comments/13rshwo/cant_get_lazynvim_to_load_local_dev_plugins_for/)\nfor understanding lua modules and the require function and how to add my local plugin to the lua path.\n- [Gonçalo Alves](https://dev.to/iamgoncaloalves/how-i-developed-my-first-neovim-plugin-a-step-by-step-guide-1lcb)\nfor knowing how to locally reload my plugin using lazy.nvim.\n- [TheZoraiz](https://github.com/TheZoraiz/ascii-image-converter) for their code which first allowed me to create\nmy plugin with an external dependency, and later on which code I partly took to port it from go to lua.\n- In all of this fucking mess that is my browser history, to whomever got me the solution to change this fucking terminal\nfont family and size with gsetting.\n- [Sunjon](https://github.com/sunjon/Shade.nvim/) which helped me understand that, in neovim, dimming is not done \nby actually dimming your font, but by creating an opaque overlay (there may be other methods tho).\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakutchi%2Fimagepreview.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakutchi%2Fimagepreview.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakutchi%2Fimagepreview.nvim/lists"}