Skip to content

[Feature Request]: Add preview hovercards for internal links #1838

@theletterf

Description

@theletterf

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

GitHub's documentation show hovercards with a preview of internal links when hovering over an internal docs link. The preview looks as follows:

Image

I think we should add this to our docs, too.

Proposed Solution

We could generate a page-metadata.json file at build that we could then access/read through the hovercard JS code. The JSON file would map links to their metadata.

Examples and Research

GH seems to use an API for this, with calls to https://docs.github.com/api/article/meta?pathname=

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions