https://github.com/mskelton/termicons.nvim
Alternative set of icons for nvim-web-devicons using termicons.
https://github.com/mskelton/termicons.nvim
icons nvim nvim-plugin nvim-web-devicons
Last synced: about 1 year ago
JSON representation
Alternative set of icons for nvim-web-devicons using termicons.
- Host: GitHub
- URL: https://github.com/mskelton/termicons.nvim
- Owner: mskelton
- License: isc
- Created: 2023-02-22T14:17:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-05T11:54:16.000Z (over 1 year ago)
- Last Synced: 2024-10-07T14:52:33.128Z (over 1 year ago)
- Topics: icons, nvim, nvim-plugin, nvim-web-devicons
- Language: Lua
- Homepage: https://mskelton.github.io/termicons/
- Size: 235 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# termicons.nvim
Alternative set of icons for [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) using [termicons](https://github.com/mskelton/termicons).
## Requirements
* [termicons](https://termicons.mskelton.dev)
## Installation
Install with your favorite package manager (e.g. [lazy.nvim](https://github.com/folke/lazy.nvim)).
```lua
{
"mskelton/termicons.nvim",
requires = { "nvim-tree/nvim-web-devicons" },
build = false,
}
```
## Setup
This plugin works alongside [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) and simply provides an alternative set of icons.
```lua
require("termicons").setup()
```
### Kitty
To setup termicons with [Kitty](https://sw.kovidgoyal.net/kitty), add the
following to your `kitty.conf` file.
```kitty
symbol_map U+D000-U+D200 termicons
```
### iTerm
Usage of termicons in iTerm is limited given that iTerm only supports a single
"non-ASCII" font. If you don't already have a "non-ASCII" font specified in your
iTerm preferences, set it to "termicons". Sadly, termicons does not support
patched fonts, so this does not work alongside an existing "non-ASCII" font.
## API
### `icons.get()`
The `icons.get()` method can be used to get an icon by name.
```lua
local icons = require('termicons')
icons.get('javascript')
```