From 8beeb81c8ad4aba37dd9c8f7fa046e02355b48ac Mon Sep 17 00:00:00 2001
From: samatt14 <54123654+samatt14@users.noreply.github.com>
Date: Wed, 3 May 2023 12:38:05 -0500
Subject: [PATCH] docs(plugin-ideal-image): mention plugin changes type of
 imported images (#8948)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
---
 website/docs/api/plugins/plugin-ideal-image.mdx | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/website/docs/api/plugins/plugin-ideal-image.mdx b/website/docs/api/plugins/plugin-ideal-image.mdx
index e682c3943a..53564895d8 100644
--- a/website/docs/api/plugins/plugin-ideal-image.mdx
+++ b/website/docs/api/plugins/plugin-ideal-image.mdx
@@ -36,6 +36,15 @@ import thumbnail from './path/to/img.png';
 <Image img={require('./path/to/img.png')} />
 ```
 
+:::caution
+
+This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that changes the type of imported/require images:
+
+- Before: `string`
+- After: `{preSrc: string, src: import("@theme/IdealImage").SrcImage}`
+
+:::
+
 ## Configuration {#configuration}
 
 Accepted fields: