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.
63 lines
1.7 KiB
Plaintext
63 lines
1.7 KiB
Plaintext
---
|
|
title: "Callouts"
|
|
description: "Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation."
|
|
keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"]
|
|
boost: 3
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Style callouts as Note, Warning, Info, Tip, Check, Danger, or create your own callout:
|
|
|
|
<Note>This adds a note in the content</Note>
|
|
|
|
```mdx
|
|
<Note>This adds a note in the content</Note>
|
|
```
|
|
|
|
<Warning>This raises a warning to watch out for</Warning>
|
|
|
|
```mdx
|
|
<Warning>This raises a warning to watch out for</Warning>
|
|
```
|
|
|
|
<Info>This draws attention to important information</Info>
|
|
|
|
```mdx
|
|
<Info>This draws attention to important information</Info>
|
|
```
|
|
|
|
<Tip>This suggests a helpful tip</Tip>
|
|
|
|
```mdx
|
|
<Tip>This suggests a helpful tip</Tip>
|
|
```
|
|
|
|
<Check>This brings us a checked status</Check>
|
|
|
|
```mdx
|
|
<Check>This brings us a checked status</Check>
|
|
```
|
|
|
|
<Danger>This is a danger callout</Danger>
|
|
|
|
```mdx
|
|
<Danger>This is a danger callout</Danger>
|
|
```
|
|
|
|
<Callout icon="key" color="#FFC107" iconType="regular"> This is a custom callout</Callout>
|
|
|
|
```mdx wrap
|
|
<Callout icon="key" color="#FFC107" iconType="regular">This is a custom callout</Callout>
|
|
```
|
|
|
|
## Custom callout properties
|
|
|
|
The generic `Callout` component supports custom icons and colors. The typed callouts (`Note`, `Warning`, `Info`, `Tip`, `Check`, `Danger`) use preset icons and colors and only accept `children`.
|
|
|
|
<IconsOptional />
|
|
|
|
<ResponseField name="color" type="string">
|
|
Custom color as a hex code (for example, `#FFC107`). Sets the border, background tint, and text color of the callout.
|
|
</ResponseField>
|