Glossary
The Glossary lets you define a term once and have it highlighted wherever it appears in your published docs. Readers see the definition in a tooltip on hover, so acronyms and jargon get context without anyone leaving the page.
Glossary terms are workspace-level: defined once, reused and updated across every project in the workspace.
How it works
A marked term renders with a subtle underline. Hovering or focusing it opens a tooltip with its definition. Editing a term's definition updates every occurrence across the workspace immediately. Deleting a term reverts all occurrences to plain text — the words themselves are never removed.
Marking a term
1
Select the text
A floating toolbar appears above your selection.
2
Click the Glossary icon
Located next to the Link icon.
3
Match check
If the text matches an existing workspace term (case-insensitive), its definition auto-fills and locks for reuse.
4
Define
For a new term, write a definition and save.
Example: "Requests to the API are capped by a rate limit enforced per API key."
rate limit | The maximum number of requests an API key can make in a given time window. |
Mark "rate limit" once with this definition. Marking the same text anywhere else in the workspace reuses it automatically instead of prompting you to write it again.
Editing, unlinking, and deleting
Click into a marked term, update the definition, and save. The change applies to every occurrence of that term, in every project, in the workspace.
Removes the glossary mark from one occurrence only. The text remains; other occurrences of the term are unaffected.
Removes the term from the workspace via "Manage glossary." Every occurrence reverts to plain text; no words are deleted.
Good to know
Scope | Workspace-wide, not per-project |
Term length | Up to 200 characters |
Definition length | Up to 2,000 characters |
Matching | Case-insensitive, exact text |
Markdown syntax
For content authored outside the editor (CLI, SDK, GitHub sync), a glossary term is a <Glossary> tag wrapping the term text, with the definition as an attribute:
<Glossary definition="The maximum number of requests an API key can make in a given time window.">rate limit</Glossary>On import, Theneo matches the wrapped text against existing workspace terms. A match with a different definition overwrites the existing one everywhere it's already used — not only in the imported file.
Can I reuse a term across projects?
Can I reuse a term across projects?
Yes. Terms belong to the workspace, not a single project.
What's the difference between Unlink and Delete?
What's the difference between Unlink and Delete?
Unlink affects one occurrence. Delete removes the term from the workspace and reverts every occurrence.
Does deleting a term delete the text?
Does deleting a term delete the text?
No — only the underline and tooltip are removed.
On this page
- Glossary