Skip to content

Commit

Permalink
adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ramojus committed Jan 20, 2024
1 parent 377e4f1 commit 8da3bc5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ require 'mellifluous'.setup({
})
```

For further instructions, refer to [Overriding highlights](#overriding-highlights) section
For further instructions, refer to [overriding highlights](#overriding-highlights) section

##### Extra colors
In addition to the colors listed in [Available colors](available-colors) section, some color sets may have more colors available (`cyan` and/or `yellow`). To check your color set, refer to [the source code for color sets](lua/mellifluous/colors/sets/) and see if `get_colors_*` functions return any extra (optional) colors.
In addition to the colors listed in [available colors](#available-colors) section, some color sets may have more colors available (`cyan` and/or `yellow`). To check your color set, refer to [the source code for color sets](lua/mellifluous/colors/sets/) and see if `get_colors_*` functions return any extra (optional) colors.

### Overriding highlights
The following snippet shows how global (for any color set) highlight overrides can be defined:
Expand All @@ -214,8 +214,8 @@ highlighter.set(name, definition_map)
```

Parameters:
- {name} -- Highlight group name in string format
- {val} -- Highlight definition map in table format, the supported keys can be found in `:h nvim_set_hl`. Keys `fg`, `bg` and `sp` can also be set to any of the available colors (see [available colors](available-colors)).
- name -- Highlight group name in string format
- val -- Highlight definition map in table format, the supported keys can be found in `:h nvim_set_hl`. Keys `fg`, `bg` and `sp` can also be set to any of the available colors (see [available colors](#available-colors)).

To get an existing highlight, use this function:

Expand Down Expand Up @@ -253,10 +253,10 @@ Available colors:
- `ui_blue` (used to indicate information, new files)
- `ui_purple` (used to indicate hints, merge)

NOTE: some color sets may have more colors available, see [extra colors](extra-colors) section.
NOTE: some color sets may have more colors available. See [extra colors](#extra-colors) section.

#### Color functions
Every color from [available colors](available-colors) has the following meta functions (accessed with `:` operator):
Every color from [available colors](#available-colors) has the following meta functions (accessed with `:` operator):
- `lightened(val)` (returns color with `val` added current to lightness)
- `darkened(val)` (returns color with `val` subtracted from current lightness)
- `with_lightness(val)` (returns color with specified lightness, where `val` can be from 0 to 100)
Expand Down

0 comments on commit 8da3bc5

Please sign in to comment.