Skip to content
This repository was archived by the owner on Mar 13, 2026. It is now read-only.

Tooltips Do Not Respect Frontmatter slug #29

@osterman

Description

@osterman

Using slug in the frontmatter is a nice way to shorten URLs, without needing to put
categories at the root of the documentation tree.

We would prefer to keep all glossary terms in the reference/glossary/ folder, but
on the web show them as /terms/<something>. We can accomplish this natively in
Docusarus by setting the frontmatter like this:

---
id: stack
slug: /terms/stack
...
---

Problem

  1. The tooltip feature seems to render the slug based on the id, not taking into account the slug parameter.
  2. Using the slug in the markdown link, does not trigger tooltip behavior. E.g. [Stack](/terms/stack) generates a working link, but hovering over it will not produce a tooltip. Changing this to [Stack](/reference/glossary/stack) works.

Expected Behavior

If the slug exists, use it. Otherwise, default to the current behavior.

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