Hextra v0.11 is here! 🎉 Discover what’s new

Glossary

Hextra supports building a site-wide terminology glossary.

For more information about Hugo’s built-in glossary support, see the Hugo Glossary Quick Reference.

Source Data File

Term definitions are centrally stored in a termbase.yaml data file for each supported language.

      • termbase.yaml
      • termbase.yaml
      • termbase.yaml
  • Each YAML data file contains a list of glossary entries. Every entry includes:

    • term: The full name of the concept or phrase.
    • definition: A brief explanation or description of the term.
    • abbr (optional): A commonly used abbreviation or acronym for the term.
    data/en/termbase.yaml
    - term: seo
      abbr: SEO
      definition: "Search engine optimization – improving the visibility of a web page in search engines"
    - term: static site generator
      definition: "Software engines processing text input to generate static web pages"

    Glossary Page

    To render the glossary index page (listing all defined terms along with their descriptions and abbreviations), a language-specific glossary content file must be defined for each supported language. Use the language code suffix in the filename, for example content/glossary/_index.en.md.

    content/glossary/_index.en.md
    ---
    title: Glossary
    layout: glossary
    ---

    An example glossary page is available at Glossary.

    Last updated on