Skip to content

Commit

Permalink
add docs for variant option
Browse files Browse the repository at this point in the history
  • Loading branch information
williamhCode committed Sep 15, 2024
1 parent 83238ce commit 6d87ada
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Run `:NvimWebDeviconsHiTest` to see all icons and their highlighting.

### Variants

Light or dark color variants of the icons depend on `&background`.
Light or dark color variants of the icons depend on `&background`.
The variant can also be set manually in `setup` with the `variant` option.

The variant is updated:
- on `OptionSet` event for `background`, or
Expand Down Expand Up @@ -75,6 +76,9 @@ require'nvim-web-devicons'.setup {
-- prevents cases when file doesn't have any extension but still gets some icon
-- because its name happened to match some extension (default to false)
strict = true;
-- set the light or dark variant manually, instead of relying on `background`
-- (default to "auto")
variant = "light|dark";
-- same as `override` but specifically for overrides by filename
-- takes effect when `strict` is true
override_by_filename = {
Expand Down

0 comments on commit 6d87ada

Please sign in to comment.