Skip to content

Markdown versions of all docs pages are available by appending .md to any docs URL.

gloss

Page as Markdown

Renders an inline glossary term with a tooltip carrying its definition

Either call form works, and both produce identical HTML.

Parameters

Positional

NameTypeRequiredDefaultDescription
0stringyesThe glossary key to look up, for example MCP.

Example

{{< gloss "MCP" >}}custom display text{{< /gloss >}}
Rendered output
custom display text

Notes

Looks the key up in the consumer’s data/glossary.yaml. The tooltip shows the definition and an optional “Learn more” link.

The inner content is optional. When present it becomes the display text, overriding the key itself — useful when the prose needs “the Model Context Protocol” but the glossary key is MCP.

Tooltip positioning and behavior come from this module’s glossary.js, which uses position: fixed so a tooltip escapes an overflow: auto ancestor such as .table-wrapper. Styling lives in glossary.css. Both are loaded by themeExtras/head-end.html, so a consumer that wires the module bootstrap gets them with no extra configuration.


Source: layouts/_shortcodes/gloss.html

Was this page helpful?