RAprogramm/nekifoch

github github
terminal-integration
stars 8
issues 0
subscribers 1
forks 0
CREATED

2023-08-31

UPDATED

16 days ago



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:

{
    'RAprogramm/nekifoch',
    cmd = 'Nekifoch',
    opts = {}
}
{
    kitty_conf_path = vim.fn.expand('~/.config/kitty/kitty.conf')
    which_key = {
        enable = false
    }
}

Usage

Nekifoch provides the :Nekifoch command with the following syntax:

:Nekifoch [action] [font_family]
  • [action] can be one of:
    • check,
    • set_font,
    • set_size,
    • list.
  • [font_family]: New font family for the set_font action.

Examples:

  • Check the current font family and size:
:Nekifoch check
  • Replace the font family with "DejaVu Sans Mono":
:Nekifoch set_font DejaVu Sans Mono
  • Replace the font size with "14":
:Nekifoch set_size 14
  • List available fonts compatible with Kitty:
: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

{
    'RAprogramm/nekifoch',
    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.

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

{
  'RAprogramm/nekifoch',
  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.

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!