aboutsummaryrefslogtreecommitdiff
path: root/book/src
diff options
context:
space:
mode:
authorA-Walrus2022-09-04 14:57:14 +0000
committerPascal Kuthe2022-10-01 15:00:36 +0000
commitde72b9c04caf1fe12fd6076646657c456403c229 (patch)
tree4271b489e5246316cccba43af1e74f35bdc08104 /book/src
parent79a39c1063eca995bf75694743dc5eb3c905fa9c (diff)
Update theme documentation
Diffstat (limited to 'book/src')
-rw-r--r--book/src/themes.md30
1 files changed, 17 insertions, 13 deletions
diff --git a/book/src/themes.md b/book/src/themes.md
index 9908456f..32ff2498 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 = "#ff0000", modifiers = ["bold", "italic", "undercurled"] }
```
-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 color (only meaningful if an underline modifier is enabled), 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,21 @@ 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` |
+| Modifier |
+| --- |
+| `bold` |
+| `dim` |
+| `italic` |
+| `underlined` |
+| `undercurled` |
+| `underdashed` |
+| `underdotted` |
+| `double-underlined` |
+| `slow_blink` |
+| `rapid_blink` |
+| `reversed` |
+| `hidden` |
+| `crossed_out` |
### Scopes