Glossary tooltip

Use this component to add tooltips to words in your markdown files. The info for the tooltips is pulled in from the glossary yaml file.

term specifies which glossary entry you want to pull information from. The text between the opening and closing components is the word or words that you want to define with the glossary entry.

Component

Hover over me!

import { GlossaryTooltip } from "~/components"

<GlossaryTooltip term="example">Hover over me!</GlossaryTooltip>

Glossary

/src/content/glossary/style-guide.yaml

productName: Style Guide
entries:
  - term: example
    general_definition: |-
      Hello, world! You can use **Markdown** features inside of your `tooltips`.