highlightElementElementElement functions can be customized with set and show rules.
set and show rules.Highlights text with a background color.
Example
This is #highlight[important].
ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.
fill
The color to highlight the text with.
Default value: rgb("#fffd11a1")
Show example
This is #highlight(
fill: blue
)[highlighted with blue].
stroke
The highlight's border color. See the rectangle's documentation for more details.
Default value: (:)
Show example
This is a #highlight(
stroke: fuchsia
)[stroked highlighting].
top-edge
The top end of the background rectangle.
Available string values:
ascenderThe font's ascender, which typically exceeds the height of all glyphs.
cap-heightThe approximate height of uppercase letters.
x-heightThe approximate height of non-ascending lowercase letters.
baselineThe baseline on which the letters rest.
boundsThe top edge of the glyph's bounding box.
Default value: "ascender"
Show example
#set highlight(top-edge: "ascender")
#highlight[a] #highlight[aib]
#set highlight(top-edge: "x-height")
#highlight[a] #highlight[aib]
bottom-edge
The bottom end of the background rectangle.
Available string values:
baselineThe baseline on which the letters rest.
descenderThe font's descender, which typically exceeds the depth of all glyphs.
boundsThe bottom edge of the glyph's bounding box.
Default value: "descender"
Show example
#set highlight(bottom-edge: "descender")
#highlight[a] #highlight[ap]
#set highlight(bottom-edge: "baseline")
#highlight[a] #highlight[ap]
extentSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.The amount by which to extend the background to the sides beyond (or within if negative) the content.
Default value: 0pt
Show example
A long #highlight(extent: 4pt)[background].
radiusSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.How much to round the highlight's corners. See the rectangle's documentation for more details.
Default value: (:)
Show example
Listen #highlight(
radius: 5pt, extent: 2pt
)[carefully], it will be on the test.
bodyRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
The content that should be highlighted.