aboutsummaryrefslogtreecommitdiff
path: root/book
diff options
context:
space:
mode:
authorBlaž Hrastnik2022-10-19 04:51:13 +0000
committerGitHub2022-10-19 04:51:13 +0000
commit418a622db9d957d09e10ccbc3897d8ac9268dc8e (patch)
tree6e69857287580ab24c1e60ac199138ac23dc37df /book
parentfaf0c521d15c314f411cc6178024c5d3310212da (diff)
parent66a49080bc7e492c37f9cd10ed36a696de1787a3 (diff)
Merge pull request #4061 from pascalkuthe/undercurl-modifier
Support different kinds of underline rendering (updated)
Diffstat (limited to 'book')
-rw-r--r--book/src/themes.md40
1 files changed, 29 insertions, 11 deletions
diff --git a/book/src/themes.md b/book/src/themes.md
index d1244596..392b5f8c 100644
--- a/book/src/themes.md
+++ b/book/src/themes.md
@@ -13,10 +13,10 @@ The default theme.toml can be found [here](https://github.com/helix-editor/helix
Each line in the theme file is specified as below:
```toml
-key = { fg = "#ffffff", bg = "#000000", modifiers = ["bold", "italic"] }
+key = { fg = "#ffffff", bg = "#000000", underline = { color = "#ff0000", style = "curl"}, modifiers = ["bold", "italic"] }
```
-where `key` represents what you want to style, `fg` specifies the foreground color, `bg` the background color, and `modifiers` is a list of style modifiers. `bg` and `modifiers` can be omitted to defer to the defaults.
+where `key` represents what you want to style, `fg` specifies the foreground color, `bg` the background color, `underline` the underline `style`/`color`, and `modifiers` is a list of style modifiers. `bg`, `underline` and `modifiers` can be omitted to defer to the defaults.
To specify only the foreground color:
@@ -77,17 +77,35 @@ The following values may be used as modifiers.
Less common modifiers might not be supported by your terminal emulator.
+| Modifier |
+| --- |
+| `bold` |
+| `dim` |
+| `italic` |
+| `underlined` |
+| `slow_blink` |
+| `rapid_blink` |
+| `reversed` |
+| `hidden` |
+| `crossed_out` |
+
+> Note: The `underlined` modifier is deprecated and only available for backwards compatibility.
+> Its behavior is equivalent to setting `underline.style="line"`.
+
+### Underline Style
+
+One of the following values may be used as a value for `underline.style`.
+
+Some styles might not be supported by your terminal emulator.
+
| Modifier |
| --- |
-| `bold` |
-| `dim` |
-| `italic` |
-| `underlined` |
-| `slow_blink` |
-| `rapid_blink` |
-| `reversed` |
-| `hidden` |
-| `crossed_out` |
+| `line` |
+| `curl` |
+| `dashed` |
+| `dot` |
+| `double_line` |
+
### Inheritance