feat(doc): fix phrasing (#5)

This commit is contained in:
Barrett Ruth 2026-02-17 20:46:28 -05:00 committed by GitHub
parent a31bc21def
commit 6b4f5cf150
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -19,14 +19,14 @@ REQUIREMENTS *nonicons-requirements*
============================================================================== ==============================================================================
SETUP *nonicons-setup* SETUP *nonicons-setup*
Using lazy.nvim: >lua Load nvim-web-devicons before nonicons.nvim. For example, with lazy.nvim: >lua
{ {
'barrettruth/nonicons.nvim', 'barrettruth/nonicons.nvim',
dependencies = { 'nvim-tree/nvim-web-devicons' }, dependencies = { 'nvim-tree/nvim-web-devicons' },
} }
< <
The plugin applies overrides automatically via `plugin/nonicons.lua`. No The plugin works automatically with no configuration required. For
`setup()` call is needed. customization, see |nonicons-config|.
============================================================================== ==============================================================================
CONFIGURATION *nonicons-config* CONFIGURATION *nonicons-config*
@ -66,6 +66,10 @@ API *nonicons-api*
============================================================================== ==============================================================================
RECIPES *nonicons-recipes* RECIPES *nonicons-recipes*
Plugins that call nvim-web-devicons functions (oil.nvim, telescope.nvim,
fzf-lua, etc.) pick up nonicons glyphs automatically. The recipes below are
for plugins that accept icon configuration directly.
lualine ~ lualine ~
>lua >lua
local get = require('nonicons').get local get = require('nonicons').get
@ -127,13 +131,24 @@ oil.nvim ~
tables directly, which nonicons.nvim mutates on load. tables directly, which nonicons.nvim mutates on load.
fzf-lua ~ fzf-lua ~
>lua
No configuration needed. fzf-lua calls `get_icon()` from devicons, which require('fzf-lua').setup({
nonicons.nvim wraps automatically. file_icon_padding = ' ',
})
<
telescope.nvim ~ telescope.nvim ~
>lua
local get = require('nonicons').get
No configuration needed. telescope.nvim calls `get_icon()` from devicons. require('telescope').setup({
defaults = {
prompt_prefix = ' ' .. get('telescope') .. ' ',
selection_caret = ' > ',
entry_prefix = ' ',
},
})
<
nvim-tree ~ nvim-tree ~
>lua >lua