> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pocketsflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Images & embeds

> How to add images, videos, frames, and embedded HTML to Pocketsflow documentation pages.

This page shows how to add images, video, and other embedded elements to
documentation pages. It's a **contributor reference** for editing these docs.

<Frame>
  <img style={{ borderRadius: '0.5rem' }} src="https://mintlify-assets.b-cdn.net/bigbend.jpg" alt="Example banner image rendered in a Frame" />
</Frame>

## Adding an image

### Markdown syntax

The simplest way — good for inline content:

```md theme={null}
![Alt text describing the image](/images/example.png)
```

Store local images under `apps/docs/images/` and reference them with an
absolute-from-root path (`/images/...`).

<Note>
  Local image files must be **under 5 MB**. For larger assets, host them on a
  CDN or object store (Cloudinary, S3, or the Pocketsflow CDN) and embed the
  URL.
</Note>

### HTML for more control

Use an `<img>` tag when you need sizing, rounded corners, or other attributes:

```html theme={null}
<img
  src="/images/dashboard.png"
  alt="Creator dashboard showing recent orders"
  height="300"
  style={{ borderRadius: '0.5rem' }}
/>
```

### Wrap images in a Frame

Prefer `<Frame>` for screenshots and diagrams — it adds consistent padding, a
border, and an optional caption:

```jsx theme={null}
<Frame caption="The orders list in the creator dashboard">
  <img src="/images/orders.png" alt="Orders list with status and amount columns" />
</Frame>
```

<Frame caption="A Frame gives images a consistent, bordered presentation">
  <img style={{ borderRadius: '0.5rem' }} src="https://mintlify-assets.b-cdn.net/bigbend.jpg" alt="Landscape example inside a captioned Frame" />
</Frame>

## Accessibility & style

* **Always write descriptive `alt` text.** Say what the image shows, not "image".
* Match the flat Pocketsflow style: rounded corners are fine; avoid heavy drop
  shadows.
* Use light-and-dark-friendly screenshots where possible, or provide both.
* Keep file names lowercase and hyphenated (`orders-list.png`).

## Light & dark variants

To swap an image by theme, provide both and let Mintlify pick, or use HTML
classes:

```html theme={null}
<img className="block dark:hidden" src="/images/diagram-light.png" alt="Architecture diagram" />
<img className="hidden dark:block" src="/images/diagram-dark.png" alt="Architecture diagram" />
```

## Videos

Self-hosted video:

```html theme={null}
<video
  controls
  className="w-full aspect-video rounded-xl"
  src="https://cdn.example.com/walkthrough.mp4"
></video>
```

Embedded YouTube:

```html theme={null}
<iframe
  className="w-full aspect-video rounded-xl"
  src="https://www.youtube.com/embed/4KzFe50RQkQ"
  title="Pocketsflow walkthrough"
  frameBorder="0"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
  allowFullScreen
></iframe>
```

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/4KzFe50RQkQ" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen style={{ width: '100%', borderRadius: '0.5rem' }} />

## Other embeds (iframes)

Any HTML iframe works — dashboards, forms, or interactive demos:

```html theme={null}
<iframe
  src="https://example.com/embed"
  style={{ width: '100%', height: '480px', borderRadius: '0.5rem', border: '1px solid #e5e7eb' }}
></iframe>
```

<Tip>
  Mintlify supports HTML tags directly in MDX, so you can mix Markdown and HTML
  freely for full flexibility.
</Tip>

## Related topics

* [Docs configuration](/essentials/settings)
* [Code blocks](/essentials/code)
