Skip to content

Add ImageKit media hosting guide#13836

Merged
ArmandPhilippot merged 19 commits into
withastro:mainfrom
imagekitio:add-imagekit-media-guide
May 30, 2026
Merged

Add ImageKit media hosting guide#13836
ArmandPhilippot merged 19 commits into
withastro:mainfrom
imagekitio:add-imagekit-media-guide

Conversation

@imagekitio

Copy link
Copy Markdown
Contributor

Adds a new media hosting guide for ImageKit alongside the existing Cloudinary and Mux guides.

What's added

  • src/content/docs/en/guides/media/imagekit.mdx — full guide covering installation, configuration, the image service, <Image /> / <Picture /> usage, AI-powered transformations (background removal, upscale, generative fill, drop shadow), the <Video /> component, the <OgImage /> component and getOgImageUrl() helper, client-side uploads (getUploadAuthParams + @imagekit/javascript), loading from the ImageKit Media Library via Astro Content Collections + @imagekit/nodejs, and Node.js asset management.
  • public/logos/imagekit.svg and a new entry in src/data/logos.ts (alphabetical, between image and juno).
  • Auto-registered in MediaGuidesNav via type: media frontmatter — no nav file edits needed.
  • i18nReady: false so the page is queued for translation by the community translators.

Small mentions added alongside Cloudinary

  • src/content/docs/en/guides/images.mdx — added a bullet under "Using Images from a CMS or CDN" mentioning the ImageKit Astro integration as a peer to the existing Cloudinary mention.
  • src/content/docs/en/reference/image-service-reference.mdx — added "ImageKit" to the list of example external image services (Cloudinary, Vercel, RIAPI).

Verification

  • pnpm astro check → 0 errors, 0 warnings on the new file.
  • pnpm build → 6268 pages built successfully.
  • Verified locally at /en/guides/media/ (card appears alphabetically) and /en/guides/media/imagekit/.
  • API surface (@imagekit/astro/integration, @imagekit/astro/server, getUploadAuthParams, OgImage, getOgImageUrl, Video, @imagekit/nodejs) cross-checked against the published ImageKit Astro integration docs.

manu4543 and others added 3 commits May 5, 2026 16:16
- Adds src/content/docs/en/guides/media/imagekit.mdx with setup, image/video, OG image, client uploads, content-collection loader, and Node.js usage- Adds public/logos/imagekit.svg and registers it in src/data/logos.ts (alphabetically between image and juno)- Mentions ImageKit alongside Cloudinary in guides/images.mdx and reference/image-service-reference.mdx- Auto-registered in MediaGuidesNav via type: media frontmatter- i18nReady: false (translations to follow)
Co-authored-by: Copilot <copilot@github.com>
… to ImageKit guide

Co-authored-by: Copilot <copilot@github.com>
@netlify

netlify Bot commented May 5, 2026

Copy link
Copy Markdown

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0945061
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6a1add1f0a10840008cdb9df
😎 Deploy Preview https://deploy-preview-13836--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston

Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston

astrobot-houston commented May 5, 2026

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/images.mdx Source changed, localizations will be marked as outdated.
en/guides/media/imagekit.mdx Localization added, will be marked as complete.
en/reference/image-service-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution, and for your patience! Between the minor releases and planning Astro 7, we're falling a bit behind on the reviews...

I left a few suggestions to match our writing style (i.e. too much "so", we try to be more direct) and to be clearer when the user is redirected to an external website. But, overall, this looks good to me!

Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread public/logos/imagekit.svg Outdated
Comment thread src/content/docs/en/guides/images.mdx Outdated
@ArmandPhilippot ArmandPhilippot added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. 3rd-party guide Community submitted CMS, deploy, backend etc. guide labels May 15, 2026
imagekitio and others added 14 commits May 21, 2026 15:43
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
@imagekitio

Copy link
Copy Markdown
Contributor Author

Thank you for your contribution, and for your patience! Between the minor releases and planning Astro 7, we're falling a bit behind on the reviews...

I left a few suggestions to match our writing style (i.e. too much "so", we try to be more direct) and to be clearer when the user is redirected to an external website. But, overall, this looks good to me!

Thanks @ArmandPhilippot for taking the time to review this and suggest edits. I’ve applied all the suggestions and also added a new section about the ImageKit Video Player. We recently introduced an Astro-specific export for that package, so I included it as well.

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! I left two suggestions: one nit and a paragraph that I find too long to be easy to read. But, otherwise this looks good to me!

cc @yanthomasdev when you have the time, I think this is ready for another look!

Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated

@yanthomasdev yanthomasdev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I have one small nit. Once Armand's suggestions are applied as well this should be good to go.

Comment thread src/content/docs/en/guides/media/imagekit.mdx Outdated
@manu4543

Copy link
Copy Markdown
Contributor

@yanthomasdev @ArmandPhilippot Thanks for the inputs and help so far. Accepted all edits.

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this new guide and your support! 💜

@ArmandPhilippot ArmandPhilippot merged commit 19549bc into withastro:main May 30, 2026
12 checks passed
tarikrital pushed a commit to tarikrital/astro-docs that referenced this pull request Jul 6, 2026
Co-authored-by: Manu Chaudhary <manu@imagekit.io>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3rd-party guide Community submitted CMS, deploy, backend etc. guide add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants