Glossary

Glossary helps readers understand terms in-page in the context of your product. Glossary contains terms and definitions that you define. When these terms appear in a page, they're automatically underlined. Readers can hover over these underlined terms to view their definitions, providing contextual clarity without navigating away.

How to use Glossary

To use glossary:

1. Define the terms and their definitions in the glossary.

2. Add the term to the page.

Defining Glossary

To define terms in the glossary:

• Open Project Settings → Content → Glossary.

• Click Add glossary term.

• Write the term (word or phrase, case sensitive).

• Write the definition (one liner).

• Click Save.

Adding Glossary to Page

To add the glossary term to a page, open up the inline block menu by typing /, and selecting the term from the list. You may type to search for the term.

Example Glossary

Here you can find a glossary term that we have defined.

Known Limitations of Glossary

• Only applies in documentation pages.

• Does not apply in code blocks.

• Might be out of view on mobile.