Glossary¶
The MkDocs ezglossary plugin exists, but the syntax is unintuitive (for example, the semicolon separator) and does not handle spaced or formatted entries well. Ideally, readers should be able to access the glossary as a popup, tooltip, or link.
LATEX glossaries usually rely on the glossaries package and definitions declared in the preamble via \newglossaryentry:
\newglossaryentry{key}{
name={singular form},
plural={plural form},
description={descriptive text},
first={special form for first use},
text={normal form (if you want to force it)},
}
\gls uses the standard form, \Gls capitalizes the first letter, \glspl gives the plural, and \Glspl capitalizes the plural. The first use of the term falls back to the first form when present, otherwise name. Markdown alone cannot express all of that. One option is to define glossary entries in front matter:
glossary:
html:
name: HTML
plural: HTMLs
description: >
HyperText Markup Language, the standard markup language for
documents designed to be displayed in a web browser.
first: HyperText Markup Language (HTML)
Place an anchor where the term is defined:
The **HTML**{#gls-html} is the standard markup language for web pages...