clipboard-image.nvim 使用教程

clipboard-image.nvim 使用教程

clipboard-image.nvimNeovim Lua plugin to paste image from clipboard.项目地址:https://gitcode.com/gh_mirrors/cl/clipboard-image.nvim

1. 项目的目录结构及介绍

clipboard-image.nvim/
├── doc/
│   └── clipboard-image.txt
├── lua/
│   └── clipboard-image/
│       ├── init.lua
│       └── ...
├── plugin/
│   └── clipboard-image.vim
├── test/
│   └── ...
├── .gitignore
├── .luacheckrc
├── .stylua.toml
├── API.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md

• doc/: 包含插件的文档文件。
• lua/: 包含插件的主要Lua代码。
• plugin/: 包含插件的Vim脚本文件。
• test/: 包含插件的测试文件。
• .gitignore: Git忽略文件配置。
• .luacheckrc: Lua代码检查配置。
• .stylua.toml: Lua代码格式化配置。
• API.md: API文档。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• Makefile: 构建文件。
• README.md: 项目介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件位于 lua/clipboard-image/init.lua。这个文件是插件的入口点，负责初始化插件并加载必要的配置。

3. 项目的配置文件介绍

插件的配置可以通过 setup 函数进行自定义。以下是一个示例配置：

require'clipboard-image'.setup {
  -- 默认配置适用于所有文件类型
  default = {
    img_dir = "images",
    img_name = function()
      return os.date('%Y-%m-%d-%H-%M-%S')
    end,
    affix = "%s"
  },
  -- 可以为特定文件类型创建配置
  markdown = {
    img_dir = "assets/images",
    img_name = function()
      return os.date('%Y-%m-%d-%H-%M-%S')
    end,
    affix = "![](%s)"
  }
}

• img_dir: 图片保存的目录。
• img_name: 图片文件名的生成函数。
• affix: 图片标签的前缀和后缀。

通过这些配置，可以自定义图片的保存路径、文件名格式以及在文档中的引用方式。

clipboard-image.nvimNeovim Lua plugin to paste image from clipboard.项目地址:https://gitcode.com/gh_mirrors/cl/clipboard-image.nvim