Skip to content

Added image path tip #637

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
merged 2 commits into from
Apr 15, 2025
Merged

Added image path tip #637

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
728f751
Added image path tip
ruhanponnada Apr 11, 2025
fa09e36
Update image-embeds.mdx
hahnbeelee Apr 15, 2025
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
4 changes: 3 additions & 1 deletion image-embeds.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
```md
![title](/path/image.jpg)
```

<Tip>
To make sure images are displayed correctly in production, add a forward slash to the image path (e.g. `/path/image.jpg`).
</Tip>
Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.

### Using Embeds
Expand All @@ -36,7 +38,7 @@

### Disable Image Zoom

To disable the default zoom on click for images, add the noZoom property to image embeds.

Check warning on line 41 in image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

image-embeds.mdx#L41 

Did you really mean 'noZoom'?

```html
<img height="200" noZoom src="/path/image.jpg" />
Expand Down Expand Up @@ -131,7 +133,7 @@

<Warning>
Since Mintlify needs to adhere to the JSX syntax, double word attributes will need to
be written in camelCase: autoPlay, playsInline.

Check warning on line 136 in image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

image-embeds.mdx#L136 

Did you really mean 'camelCase'?

Check warning on line 136 in image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

image-embeds.mdx#L136 

Did you really mean 'playsInline'?
</Warning>

## iFrames
Expand All @@ -144,6 +146,6 @@

<Tip>
Although not required, we recommend adding the `alt` and `title` attributes to
images for better SEO and accessability. Learn more at [image

Check warning on line 149 in image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

image-embeds.mdx#L149 

Did you really mean 'accessability'?
SEO](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/).
</Tip>