Home

Awesome

<h1 align="center">NeKiFoCh</h1> <h3 align="center">Neovim Kitty Font Changer</h3> <hr> <p align="center"> <strong>Neovim plugin for managing Kitty terminal font settings.</strong> </p> <p align="center"> <a href="#installation">Installation</a> • <a href="#defaults">Defaults</a> • <a href="#usage">Usage</a> • <a href="#configuration">Configuration</a> • <a href="#whichkey">WhichKey</a> • <a href="#credits">Credits</a> • <a href="#license">License</a> • <a href="#donations">Donations</a> </p>

https://github.com/RAprogramm/nekifoch/assets/70325462/04a0d7e7-a42e-4588-a926-0945adacb3f0

Installation

Install Nekifoch using your favorite plugin manager. For example, with lazy.nvim:

{
    'NeViRAIDE/nekifoch.nvim',
    cmd = 'Nekifoch',
    opts = {}
}
<h2 id='defaults'>Default config values</h2>
{
    kitty_conf_path = vim.env.HOME .. '~/.config/kitty/kitty.conf',
    which_key = {
        enable = false
    },
    borders = 'rounded'
}

Usage

Nekifoch provides the :Nekifoch command with the following syntax:

:Nekifoch [action] [font_family]

Examples:

:Nekifoch check
:Nekifoch set_font DejaVu Sans Mono
:Nekifoch set_size 14
:Nekifoch list

Configuration

Configure Nekifoch using the FontReplaceConfig dictionary:

Nekifoch can be configured by adding a Lua configuration to your Neovim configuration file (init.lua).

Here's an example configuration using Lua:

require('nekifoch').setup({
  kitty_conf_path = vim.fn.expand('~/.config/kitty/kitty.conf')
})

or

{
    'NeViRAIDE/nekifoch.nvim',
    cmd = 'Nekifoch', -- to add lazy loading
    opts = {
        kitty_conf_path = vim.fn.expand('~/.config/kitty/kitty.conf') -- your kitty config path
        which_key = {
            enable = false -- without which_key and nui
        }
    }
}

Replace '~/.config/kitty/kitty.conf' with the actual path to your Kitty terminal configuration.

<h2 id='whichkey'>WhichKey and Nui UI</h2>

https://github.com/RAprogramm/nekifoch/assets/70325462/eb418579-7ef1-4d14-83cb-f9baf2e68b52

[!IMPORTANT] Nui and WhichKey must be installed

Here's an example configuration using Lua:

require('nekifoch').setup({
    which_key = {
        enable = true
    }
})

or

{
  'NeViRAIDE/nekifoch.nvim',
  event = 'VeryLazy',
  dependencies = {
    { 'nvim-lua/plenary.nvim' },
    { 'MunifTanjim/nui.nvim' },
    {
      "folke/which-key.nvim",
      event = "VeryLazy",
      init = function()
        vim.o.timeout = true
        vim.o.timeoutlen = 300
      end,
      opts = {
        -- your configuration comes here
        -- or leave it empty to use the default settings
        -- refer to the configuration section below
      }
    }
  }
  opts = {
    which_key = {
      enable = true
    }
  }
}

Credits

Developed by RAprogramm. Contributions are welcome.

License

Distributed under the ... (not chosen yet).

For in-depth details and usage instructions, refer to the documentation.

<hr>

Enhance your Kitty terminal experience with Nekifoch

Donations

If you find this plugin helpful and would like to support its development, you can buy me a coffee through the following platforms:

ko-fi

buymeacoffee

Your support is greatly appreciated!