img-clip.nvim
A Neovim plugin to embed images from clipboard, drag-and-drop, or URLs into markup languages like LaTeX, Markdown, and Typst.
What is img-clip.nvim?
img-clip.nvim is a Neovim plugin that automates embedding images into markup languages like LaTeX, Markdown, and Typst. It eliminates manual steps like saving images and writing syntax by allowing users to paste from the clipboard, drag and drop, or use URLs, then automatically generates the correct markup. The plugin handles image processing, file management, and offers extensive customization for different workflows.
Neovim users who write documentation, academic papers, or technical content in markup languages and need to efficiently include images. This includes researchers, technical writers, and developers maintaining project documentation.
Developers choose img-clip.nvim for its deep integration with Neovim workflows, offering granular configuration per filetype, project, or directory, and support for multiple embedding methods (local files, URLs, Base64). Its flexibility, including custom templates and image processing, sets it apart from simpler paste tools.
Overview
Embed images into any markup language, like LaTeX, Markdown or Typst
Use Cases
Best For
- Writing academic papers in LaTeX with automated figure insertion and captioning
- Creating Markdown documentation with embedded images from clipboard or drag-and-drop
- Managing image assets in project-specific directories with custom naming conventions
- Embedding web images directly into documents without manual download steps
- Using Base64-encoded images for portable documents like HTML emails
- Integrating with Neovim plugins like telescope.nvim for image selection and embedding
Not Ideal For
- Users on terminal emulators with poor drag-and-drop support like XTerm or Hyper
- Teams using GUI-based editors (e.g., VSCode, Sublime Text) rather than Neovim
- Projects needing out-of-the-box image pasting without any configuration or external tool installation
- Environments where installing OS-specific clipboard tools (xclip, pngpaste) is restricted or impractical
Pros & Cons
Pros
Supports per-filetype, per-project, per-directory, and even per-file settings, with dynamic options via Lua functions and .img-clip.lua files for project-specific overrides.
Allows embedding images as local files, web URLs, or Base64-encoded data, with automatic downloading and configurable image processing via shell commands.
Includes example integrations with popular Neovim plugins like telescope.nvim and oil.nvim for enhanced image selection and workflow streamlining.
Works on Linux, macOS, and Windows (including WSL), with tailored requirements for each OS, though it relies on external tools for clipboard access on some platforms.
Cons
Requires installing separate tools like xclip on Linux or pngpaste on Mac, adding setup complexity and potential failure points if not available.
Drag-and-drop functionality is highly dependent on terminal emulator support, with many popular terminals (e.g., Alacritty, Wezterm) lacking full URL or file drag support, as detailed in the compatibility table.
The extensive, layered configuration system (default, filetypes, files, dirs, custom) can be daunting for users seeking a quick, simple setup, risking misconfiguration.
Frequently Asked Questions
Related Projects
image.nvim🖼️ Bringing images to Neovim.
hologram.nvim👻 A cross platform terminal image viewer for Neovim. Extensible and fast, written in Lua and C. Works on macOS and Linux.
cord.nvim🚀 Discord Rich Presence for Neovim
clipboard-image.nvimNeovim Lua plugin to paste image from clipboard.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.