From 164287bd45a45adea8984a5974c282e66b4b400d Mon Sep 17 00:00:00 2001 From: Will Faught Date: Wed, 5 Mar 2025 16:10:11 -0800 Subject: [PATCH] Limit image shortcode processing params to raster images --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ce6c630..ed37155c 100644 --- a/README.md +++ b/README.md @@ -578,11 +578,11 @@ Parameters:
alt
Optional. String. Plain text. Image alt.
breakpoints
-
Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with densities, sizes, or srcset.
+
Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with densities, sizes, or srcset. Only applies to raster images.
class
Optional. String. Class attribute value.
densities
-
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are "1x 2x", "1x 1.5x 2x 2.5x 3x", and "0.5x 1.33x 6x 10x". Must not use with breakpoints, sizes, or srcset.
+
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are "1x 2x", "1x 1.5x 2x 2.5x 3x", and "0.5x 1.33x 6x 10x". Must not use with breakpoints, sizes, or srcset. Only applies to raster images.
fetchpriority
Optional. String. Must be "high" or "low".
height
@@ -598,7 +598,7 @@ Parameters:
maxwidth
Optional. String. CSS value. Image maximum width.
process
-
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is "default", the default options are used.
+
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is "default", the default options are used. Only applies to raster images.
sizes
Optional. String. Image sizes. Must not use with breakpoints or densities.
src