Using your plugin manager at your disposal, in the example lazy is going to be used.

• Default installation:

return {
    "AlejandroSuero/freeze-code.nvim",
    config = function()
        require("freeze-code").setup()
    end,
}

• Customizable installation:

return {
    "AlejandroSuero/freeze-code.nvim",
    config = function()
        require("freeze-code.nvim").setup({
            -- your configuration goes here
        })
    end,
}

local opts = {
  freeze_path = vim.fn.exepath("freeze"), -- where is freeze installed
  copy_cmd = "", -- the default copy command is native to your OS (see below)
  copy = false, -- copy after screenshot option
  open = false, -- open after screenshot option
  dir = vim.env.PWD, -- where is the image going to be saved "." as default
  freeze_config = { -- configuration options for `freeze` command
    output = "freeze.png",
    config = "base",
    theme = "default",
  },
}

If you specify a copy_cmd in the configuration, it will be used instead of the default one. To use the custom command, you need to specify "filename" in the command, where the image will be saved.

Once you have it installed, you can use :checkhealt freeze-code to see if there are any problems with the installation or you need to install additional tools.

To use this plugin, simply call :Freeze and it will take a screenshot of the current buffer and save it in the dir path you have configured.

If you want to take a screenshot of a specific line, you can use the :Freeze in visual mode, and it will take a screenshot of the selected lines.

local fz_api = require("freeze-code.utils.api")
vim.keymap.set("n", "<leader>fz", fz_api.freeze)
vim.keymap.set("v", "<leader>fz", function()
  fz_api.freeze(vim.fn.line("'<"), vim.fn.line("'>"))
end)
-- or using `<cmd>Freeze<cr>`
vim.keymap.set("n", "<leader>fl", fz.freeze_line)
-- or using `<cmd>FreezeLine<cr>`

Thank you to everyone that is contributing and to those who want to contribute. Any contribution is welcomed!

Quick guide:

1. Fork this project.
2. Clone your fork (git clone <fork-URL>).
3. Add main repo as remote (git remote add upstream <main-repo-URL>).
4. Create a branch for your changes (git switch -c feature/your-feature or git switch -c fix/your-fix).
5. Commit your changes (git commit -m "feat(...): ...").
6. Push to your fork (git push origin <branch-name>).
7. Open a PR.

For more information, check CONTRIBUTING.md.

Thanks goes to these wonderful people that have contributed to this project: