underlineElementElement functions can be customized with set and show rules.
Element functions can be customized with
set and show rules.Underlines text.
Example
This is #underline[important].
ParametersParameters are the inputs to a function. They are specified in parentheses after the function name.
Parameters are the inputs to a function. They are specified in parentheses after the function name.
underline(
stroke: autolengthcolorgradientstrokepatterndictionary,offset: autolength,extent: length,evade: bool,background: bool,content,
) -> contentstroke
How to stroke the line.
If set to auto, takes on the text's color and a thickness defined in the current font.
Default: auto
View example
Take #underline(
stroke: 1.5pt + red,
offset: 2pt,
[care],
)
offsetauto or lengthSettableSettable parameters can be customized for all following uses of the function with a set rule.
auto or length
SettableSettable parameters can be customized for all following uses of the function with a
set rule.The position of the line relative to the baseline, read from the font tables if auto.
Default: auto
View example
#underline(offset: 5pt)[
The Tale Of A Faraway Line I
]
extentSettableSettable parameters can be customized for all following uses of the function with a set rule.
Settable parameters can be customized for all following uses of the function with a
set rule.The amount by which to extend the line beyond (or within if negative) the content.
Default: 0pt
View example
#align(center,
underline(extent: 2pt)[Chapter 1]
)
evadeSettableSettable parameters can be customized for all following uses of the function with a set rule.
Settable parameters can be customized for all following uses of the function with a
set rule.Whether the line skips sections in which it would collide with the glyphs.
Default: true
View example
This #underline(evade: true)[is great].
This #underline(evade: false)[is less great].
backgroundSettableSettable parameters can be customized for all following uses of the function with a set rule.
Settable parameters can be customized for all following uses of the function with a
set rule.Whether the line is placed behind the content it underlines.
Default: false
View example
#set underline(stroke: (thickness: 1em, paint: maroon, cap: "round"))
#underline(background: true)[This is stylized.] \
#underline(background: false)[This is partially hidden.]
body
The content to underline.