aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2025-09-19 14:22:10 +0100
committerMichael Williamson <mike@zwobble.org>2025-09-19 14:23:10 +0100
commitdd1e824216f29bb23235d92dffd1a22506387748 (patch)
tree5d82894d7f427ff305579efb0af312b9197d7044
parent2d226bd2a8b2100d67a29f1696d35abcd290bc33 (diff)
Add docs for highlight style mapping
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8235b6e..093403a 100644
--- a/README.md
+++ b/README.md
@@ -484,6 +484,43 @@ small-caps
Note that this matches text that has had small caps explicitly applied to it.
It will not match any text that is small caps because of its paragraph or run style.
+#### Highlight
+
+Match explicitly highlighted text:
+
+```
+highlight
+```
+
+Note that this matches text that has had a highlight explicitly applied to it.
+It will not match any text that is highlighted because of its paragraph or run style.
+
+It's also possible to match specific colours.
+For instance, to match yellow highlights:
+
+```
+highlight[color='yellow']
+```
+
+The set of colours typically used are:
+
+* `black`
+* `blue`
+* `cyan`
+* `green`
+* `magenta`
+* `red`
+* `yellow`
+* `white`
+* `darkBlue`
+* `darkCyan`
+* `darkGreen`
+* `darkMagenta`
+* `darkRed`
+* `darkYellow`
+* `darkGray`
+* `lightGray`
+
#### Ignoring document elements
Use `!` to ignore a document element.