Reader experience¶

Terms about what readers see when a glossary is active on a site.

Glossary entry¶

A glossary entry is a term and definition pair in a glossary source file. Each entry gets an anchor that other pages can link to.

Tooltip¶

A tooltip is the compact definition shown when a reader hovers or focuses a glossary term.

Admonition¶

An admonition is a callout block, such as a note, warning, or tip, used to draw attention to a piece of content.

Sectioned glossary¶

A sectioned glossary uses shallower headings to organize related terms while a configured heading level identifies the terms themselves.

Multi-page glossary¶

A multi-page glossary spreads terms across several Markdown files, each focused on one domain, which the extension merges into a single term index at build time.