Skip to content

Document markdown support in Frame captions #2825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ruhanponnada merged 3 commits into from
Jan 23, 2026
Merged

Document markdown support in Frame captions #2825

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8296a60
Update components/frames.mdx
hahnbeelee Jan 23, 2026
a400056
Update components/frames.mdx
hahnbeelee Jan 23, 2026
01c92e1
Update components/frames.mdx
hahnbeelee Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion components/frames.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,21 @@
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
</Frame>

### Markdown in captions

Captions support markdown formatting, including links and bold text.

<Frame caption="Learn more about [Yosemite National Park](https://www.nps.gov/yose/index.htm) and plan your visit.">
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
</Frame>

<Frame caption="**Important:** Check the [park website](https://www.nps.gov/yose/index.htm) for current conditions.">
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
</Frame>

## Hints

Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.

Check warning on line 35 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L35 

Use 'preceding' instead of 'above'.

<Frame hint="If you plan to visit Yosemite National Park, secure your permits before you go." caption="Yosemite National Park is visited by over 3.5 million people every year.">
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
Expand All @@ -29,7 +41,7 @@
## Properties

<ResponseField name="caption" type="string">
Text that appears as part of the frame, centered below the content.
Text that appears as part of the frame, centered below the content. Supports markdown formatting including links and bold text.
</ResponseField>

<ResponseField name="hint" type="string">
Expand All @@ -50,6 +62,18 @@
</Frame>
```

```mdx Frame with markdown in caption
<Frame caption="Visit the [documentation](/docs) for more details">
<img src="/path/image.jpg" alt="Descriptive alt text" />
</Frame>
```

```mdx Frame with bold text and links in caption
<Frame caption="**Note:** See the [official guide](https://example.com) for setup instructions">
<img src="/path/image.jpg" alt="Descriptive alt text" />
</Frame>
```

```mdx Frame with a hint
<Frame hint="Hint text">
<img src="/path/image.jpg" alt="Descriptive alt text" />
Expand Down