ekickx/clipboard-image.nvim

github github
media
star 147
stars
alert-circle 2
open issues
users 3
subscribers
git-branch 13
forks
CREATED

2021-01-12

UPDATED

2 months ago


Clipboard Image šŸ“‹šŸ–¼ļø

License

Installation ā€¢ Usage & Demo ā€¢ Config


Install

ā— Requirement: xclip (X11), wl-clipboard (Wayland), pngpaste (MacOS)

ā„¹ļø Run :checkhealth clipboard-image to check a missing dependency

Plugin manager Script
vim-plug Plug 'ekickx/clipboard-image.nvim'
packer.nvim use 'ekickx/clipboard-image.nvim'

Usage

This is the basic usage. If you want to see more you can read API

Command Demo
PasteImg

Config

This plugin is zero config, means you don't need to configure anything to works. But if you want to, you can configure it like this:

require'clipboard-image'.setup {
  -- Default configuration for all filetype
  default = {
    img_dir = "images",
    img_name = function() return os.date('%Y-%m-%d-%H-%M-%S') end, -- Example result: "2021-04-13-10-04-18"
    affix = "<\n  %s\n>" -- Multi lines affix
  },
  -- You can create configuration for ceartain filetype by creating another field (markdown, in this case)
  -- If you're uncertain what to name your field to, you can run `lua print(vim.bo.filetype)`
  -- Missing options from `markdown` field will be replaced by options from `default` field
  markdown = {
    img_dir = {"src", "assets", "img"}, -- Use table for nested dir (New feature form PR #20)
    img_dir_txt = "/assets/img",
    img_handler = function(img) -- New feature from PR #22
      local script = string.format('./image_compressor.sh "%s"', img.path)
      os.execute(script)
    end,
  }
}

See also API

{
  default = {
    <options>
  },
  <filetype> = {
    <options>
  },
}
Options Default Description
img_dir "img" Directory where the image from clipboard will be copied to
img_dir_txt "img" Directory that will be inserted to buffer. Example: Your actual dir is src/assets/img but your dir on text or buffer is /assets/img
img_name function() return os.date('%Y-%m-%d-%H-%M-%S') end Image's name
img_handler function(img) end Function that will handle image after pasted.img is a table that contain pasted image's name and path
affix default: "%s"markdown: "![](%s)"asciidoc: "image::%s[]" String that sandwiched the image's path

Tips

Share your tips here

Questions

You can ask your questions on discussions

Contribute

Read the contribution guide here

Credits

Thanks to:

  • ferrine/md-img-paste.vim, I look some of its code
  • elianiva for giving me feedback on Vim Indonesia (Telegram group)
  • all neovim lua plugin creators and its contributors, I get some inspiration from reading their code