https://github.com/charm-and-friends/freeze.nvim

A wrapper for charm's freeze cli tool for usage in neovim
https://github.com/charm-and-friends/freeze.nvim

neovim neovim-plugin nvim nvim-plugin

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/charm-and-friends/freeze.nvim
• Owner: charm-and-friends
• License: mit
• Created: 2024-03-27T10:34:31.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:15:53.000Z (2 months ago)
• Last Synced: 2024-09-05T00:04:10.772Z (2 months ago)
• Topics: neovim, neovim-plugin, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 40 KB
• Stars: 59
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• charm-in-the-wild - freeze.nvim - A wrapper for charm's freeze cli tool for usage in neovim. (Editor Plugins / Finance)

README

        


    
freeze.nvim




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



### Installation

1) Ensure that you have installed the [`freeze`][freeze] cli tool.

2) Follow the example below. It uses [lazy.nvim](https://github.com/folke/lazy.nvim), so you may have to adjust it to your plugin manager.

```lua

{

  'charm-and-friends/freeze.nvim',

  config = function()

    require('freeze').setup({

        command = "freeze",

        output = function()

            return "./" .. os.date("%Y-%m-%d") .. "_freeze.png"

        end,

        theme = "catppuccin-mocha",

    })

  end

}

```

For a full list of options, see [here](https://github.com/isabelroses/charm-freeze.nvim/blob/b4c80e67e8a9fc525bd10633d04b5bfca2f2862e/lua/charm-freeze/init.lua#L17-L44).

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

```lua

vim.api.nvim_set_keymap('v', 'sc', 'Freeze', {})

```

### Thanks

This project is heavily inspired by [nvim-silicon](https://github.com/michaelrommel/nvim-silicon).

This would not be possible without [charmbracelet/freeze][freeze].

[freeze]: https://github.com/charmbracelet/freeze

---

Part of the [Charm](https://charm.sh) Community.



  



Charm热爱开源 • Charm loves open source