Skip to content

Glossary

Use the glossary definition shortcode to render the defined glossary definition. Additionally, you can include a prepend value to add words to the start of the definition.

Create the glossary entries in a file dedicated to your product. These YAML files live in /src/content/glossary/<YOUR-PRODUCT>.yaml

Component

import { Glossary } from "~/components"
<Glossary />

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`.