Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neviraide/nekifoch.nvim
Neovim Kitty Font Changer
https://github.com/neviraide/nekifoch.nvim
changefont kitty-terminal neovim neovim-lua-plugin neovim-plugin
Last synced: about 1 month ago
JSON representation
Neovim Kitty Font Changer
- Host: GitHub
- URL: https://github.com/neviraide/nekifoch.nvim
- Owner: NeViRAIDE
- License: apache-2.0
- Created: 2023-08-31T08:09:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-20T03:05:39.000Z (6 months ago)
- Last Synced: 2024-05-22T13:44:12.665Z (6 months ago)
- Topics: changefont, kitty-terminal, neovim, neovim-lua-plugin, neovim-plugin
- Language: Lua
- Homepage:
- Size: 43 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NeKiFoCh
*Neovim Kitty Font Changer*
[](https://github.com/NeViRAIDE/nekifoch.nvim/actions/workflows/ci.yml)
- [NeKiFoCh](#nekifoch)
- [Installation](#installation)
- [Default config values](#default-config-values)
- [Usage](#usage)
- [Examples:](#examples)
- [Configuration](#configuration)
- [Credits](#credits)
- [License](#license)
---
**Neovim plugin for managing Kitty terminal font settings.**
---
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](https://github.com/folke/lazy.nvim):
```lua
{
'NeViRAIDE/nekifoch.nvim',
build = 'chmod +x ./install.sh && ./install.sh',
cmd = 'Nekifoch',
config = true,
}
```
## Default config values
```lua
{
kitty_conf_path = '~/.config/kitty/kitty.conf',
borders = 'single', --available values are: 'rounded', 'single', 'double', 'shadow', 'solid', 'none'
}
```
## Usage
Nekifoch provides the `:Nekifoch` command with the following syntax:
```vim
:Nekifoch [action] [font_family/font_size]
```
- `[action]` (optional) can be one of:
- `check`,
- `set_font`,
- `set_size`,
- `list`.
- `[font_family/font_size]`: New font family/size for the `set_font`/`set_size` action.
#### Examples:
- Open NeKiFoCh main menu:
```vim
:Nekifoch
```
- Check the current font family and size:
```vim
:Nekifoch check
```
- Check the current font family and size in float window:
```vim
:Nekifoch float_check
```
- Replace the font family with "DejaVu Sans Mono":
```vim
:Nekifoch set_font DejaVuSansMono
```
- Open float window to set font family:
```vim
:Nekifoch set_font
```
- Replace the font size with "14":
```vim
:Nekifoch set_size 14
```
- Open float window to set font size:
```vim
:Nekifoch set_size
```
- List available fonts compatible with Kitty:
```vim
:Nekifoch list
```
- List available fonts compatible with Kitty in float window:
```vim
:Nekifoch float_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:
```lua
require('nekifoch').setup({
kitty_conf_path = vim.fn.expand('~/.config/kitty/kitty.conf')
})
```
or
```lua
{
'NeViRAIDE/nekifoch.nvim',
build = 'chmod +x ./install.sh && ./install.sh',
cmd = 'Nekifoch', -- to add lazy loading
opts = {
kitty_conf_path = vim.fn.expand('~/.config/kitty/kitty.conf'), -- your kitty config path
}
}
```
Replace '~/.config/kitty/kitty.conf' with the actual path to your Kitty terminal configuration.
## Credits
Developed by [RAprogramm](https://github.com/RAprogramm). Contributions are welcome.
## License
[APACHE 2.0](https://github.com/NeViRAIDE/nekifoch.nvim/blob/main/LICENSE)
For in-depth details and usage instructions, refer to the documentation.
---
Enhance your Kitty terminal experience with Nekifoch