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'; ``` +:::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: