aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2024-06-13 12:52:44 +0100
committerMichael Williamson <mike@zwobble.org>2024-06-13 12:52:44 +0100
commit5edcc79c02f0bc597f91b525107b1407eeffe288 (patch)
tree421b1c96793ebfef10d436bcf0020efd1be3f022 /README.md
parent43f5e189cb5cc4aa98932726b17319147c0ae742 (diff)
Support style mapping for highlights
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2f60c8d..8574f83 100644
--- a/README.md
+++ b/README.md
@@ -460,6 +460,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.