Skip to content

Conversation

zahidalidev
Copy link
Contributor

@zahidalidev zahidalidev commented Sep 17, 2024

Add hoverCard component with usage guidelines

Description:

This commit introduces the hoverCard component and includes guidelines for using it effectively in .mdx files.

Usage Guidelines

To use the hoverCard component in an .mdx file, simply link text as follows:

- Make sure you have the [Cody extension installed](/cody/clients/install-vscode, 'Here we can add more context to show in the hover card.')

Notes:

  • URL: The first parameter is the link to the relevant documentation or external resource.
  • Hover Text: The second parameter provides additional context that will display in the hover card when users hover over the link.

Before Using hoverCard (on hover):

- Make sure you have the [Cody extension installed](/cody/clients/install-vscode)
image

After Adding hoverCard (on hover):

- Make sure you have the [Cody extension installed](/cody/clients/install-vscode, 'Here we can add more context to show in the hover card.')
image

Copy link

vercel bot commented Sep 17, 2024

@zahidalidev is attempting to deploy a commit to the Sourcegraph Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Sep 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 17, 2024 7:16pm

@MaedahBatool MaedahBatool merged commit 4aa889c into sourcegraph:main Sep 17, 2024
4 checks passed
@MaedahBatool
Copy link
Contributor

@zahidalidev, can you please add usage guidelines in the description?

@zahidalidev
Copy link
Contributor Author

@zahidalidev, can you please add usage guidelines in the description?

I've added the usage guidelines.

@MaedahBatool
Copy link
Contributor

@zahidalidev, thank you. Can this hover icon be added to any text, or does it have to be a link? If it works only on links, can we make it flexible? I mostly want to add it to the text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants