Skip to content

Research on providing a glossary #550

@chartgerink

Description

@chartgerink

Recently, a request came in to provide a reusable glossary across the handbook. This issue summarizes some of my initial research on how to make this happen.

quarto-glossary

Using the quarto extension quarto-glossary (repo), we can add a general glossary.

The defined terms can be inserted anywhere using {{< glossary TERM >}}. The definition is displayed as long as the term is clicked, or in a hover box.

Image

Note that neither of these options is particularly mobile friendly. I tried it on my phone and it is hard to see the definitions there. As such, I would consider this to be a desktop only feature if we implement it using quarto glossary, which may or may not be reasonable.


cc @Jolien-S what do you think?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions