https://github.com/nvimdev/nerdicons.nvim
get the nerdfont icons inside neovim
https://github.com/nvimdev/nerdicons.nvim
Last synced: 9 months ago
JSON representation
get the nerdfont icons inside neovim
- Host: GitHub
- URL: https://github.com/nvimdev/nerdicons.nvim
- Owner: nvimdev
- License: mit
- Created: 2023-03-07T12:20:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T06:21:49.000Z (12 months ago)
- Last Synced: 2025-03-24T14:09:24.163Z (9 months ago)
- Language: Lua
- Size: 822 KB
- Stars: 59
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nerdicons.nvim
get the nerdfont icons inside neovim . no need open nerdfont website to search icons anymore.
## Install
- lazy.nvim
```lua
require('lazy').setup({
{'glepnir/nerdicons.nvim', cmd = 'NerdIcons', config = function() require('nerdicons').setup({}) end}
})
```
- packer
```lua
use({'glepnir/nerdicons.nvim', cmd = 'NerdIcons', config = function() require('nerdicons').setup({}) end})
```
## Options
available options in setup params table
```lua
{
border = 'single', -- Border
prompt = ' ', -- Prompt Icon
preview_prompt = ' ', -- Preview Prompt Icon
width = 0.5 -- flaot window width
down = '', -- Move down in preview
up = '', -- Move up in preview
copy = '', -- Copy to the clipboard
}
```
close the nerdicons window in prompt buffer you can exit to normal mode then press `` or
`Ctrl-c`
## Usage
- call the command `NerdIcons` or with an argument like `NerdIcons linux`
- input the keyword of icon name
- `Ctrl n` or `Ctrl p` to move in preview
- `Ctrl y` to copy the icon
## Highlight
all the highlight groups
```
NerdIconPrompt NerdIconPreviewPrompt NerdIconNormal NerdIconBorder
```
## License MIT