Skip to content

Commit

Permalink
doc: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ficcdaf committed Jan 15, 2025
1 parent 324d78b commit d471408
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@ provided settings will be merged with the defaults.
---Merge fields with defaults
---@type HighlightMap
merge_override = {},
---Link Highlight1 -> Highlight2
---Overrides all default links
---@type table<HighlightName, HighlightName>
link = {},
},
-- use transparent background
-- (requires terminal support)
Expand Down Expand Up @@ -265,6 +269,10 @@ that highlight group.
The latter will _merge_ properties: it will override _only_ the properties you
specify, and keep non-conflicting Ashen defaults.

You can also _link_ arbitrary highlight groups. Links defined in `hl.link` take
priority over all other links set by Ashen. `hl.link` must be a key-value table
in which the key is the link's _origin_ and the value is its _target_.

```Lua
-- full example
hl = {
Expand All @@ -278,6 +286,11 @@ hl = {
merge_override = {
["@function.macro"] = { "#B14242" },
},
---@type table<HighlightName, HighlightName>
link = {
-- link FlashBackdrop to Normal
FlashBackdrop = "Normal",
},
},
```

Expand Down

0 comments on commit d471408

Please sign in to comment.