Skip to content

A wrapper for charm's freeze cli tool for usage in neovim

License

Notifications You must be signed in to change notification settings

charm-and-friends/freeze.nvim

Repository files navigation

freeze.nvim

A wrapper around charm's freeze cli tool for Neovim.

Installation

  1. Ensure that you have installed the freeze cli tool.

  2. Follow the example below. It uses lazy.nvim, so you may have to adjust it to your plugin manager.

{
  'charm-and-friends/freeze.nvim',
  config = function()
    require('freeze').setup({
        command = "freeze",
        open = true, -- Open the generated image after running the command
        output = function()
            return "./" .. os.date("%Y-%m-%d") .. "_freeze.png"
        end,
        theme = "catppuccin-mocha",
    })
  end
}

For a full list of options, see here.

You might also want to add a keybinding to call the Freeze command.

vim.api.nvim_set_keymap('v', '<leader>sc', '<cmd>Freeze<cr>', {})

You can also use the Freeze command to open the generated image.

vim.api.nvim_set_keymap('n', '<leader>so', '<cmd>Freeze open<cr>', {})

Thanks

This project is heavily inspired by nvim-silicon.

This would not be possible without charmbracelet/freeze.


Part of the Charm and Friends.

The Charm logo

Charm热爱开源 • Charm loves open source

About

A wrapper for charm's freeze cli tool for usage in neovim

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published