mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
33 lines
1.5 KiB
Plaintext
33 lines
1.5 KiB
Plaintext
---
|
|
title: "Tooltips"
|
|
description: "Add tooltips to display contextual definitions and explanations when users hover over terms, abbreviations, or technical concepts in your documentation."
|
|
keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"]
|
|
boost: 3
|
|
---
|
|
|
|
Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links.
|
|
|
|
**Example**: <Tooltip headline="API" tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.
|
|
|
|
```mdx Tooltip example wrap
|
|
<Tooltip headline="API" tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.
|
|
```
|
|
|
|
## Properties
|
|
|
|
<ResponseField name="tip" type="string" required>
|
|
The text displayed in the tooltip.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="headline" type="string">
|
|
Text displayed before the `tip` text.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="cta" type="string">
|
|
The call-to-action text for a link within the tooltip.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="href" type="string">
|
|
URL for the call-to-action link. Required when using `cta`.
|
|
</ResponseField>
|