mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d6960c72bf
* Improve SEO metadata: fix titles, descriptions, and remove redundant OpenAPI descriptions - Remove description frontmatter from 19 API pages where the OpenAPI spec already supplies the description - Fix 2 titles that exceeded 60 characters (content-templates, content-types) - Improve 15 descriptions that were too short (<130 chars) or too long (>160 chars) to target 130-155 characters - All descriptions are unique and include relevant search terms Generated-By: mintlify-agent * re-add API descriptions * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
62 lines
1.7 KiB
Plaintext
62 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"]
|
|
---
|
|
|
|
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>
|