diff --git a/README.md b/README.md index 3f70a7f3..c84b5680 100644 --- a/README.md +++ b/README.md @@ -479,10 +479,10 @@ The `paige/gallery` shortcode provides a figure with a collection of images. ``` {{< paige/gallery align="center" - caption="My caption" height="10rem" images="*.jpg" justify="center" + maxheight="10rem" maxwidth="10rem" method="resize" options="550x webp picture Lanczos" @@ -491,62 +491,39 @@ The `paige/gallery` shortcode provides a figure with a collection of images. />}} {{< paige/gallery >}} - {{< paige/gallery - caption="My caption" - height="10rem" - image="me.jpg" - maxwidth="10rem" - method="resize" - options="550x webp picture Lanczos" - raw=false - width="10rem" - />}} - {{< paige/gallery - caption="My caption" - height="10rem" - image="you.jpg" - maxwidth="10rem" - method="resize" - options="550x webp picture Lanczos" - raw=false - width="10rem" - />}} +{{< paige/image src="1.jpg" >}} +{{< paige/image src="2.jpg" >}} +{{< paige/image src="3.jpg" >}} {{< /paige/gallery >}} ``` -Inner content: Optional. String. HTML. Must be other uses of this shortcode. +Inner content: Optional. String. HTML. Parameters:
align
Optional. String. Cross axis alignment. Must be baseline, center, end, start, or stretch. Must not be used when nested.
-
caption
-
Optional. String. Markdown. Descriptive text below the image or images.
height
Optional. String. CSS value. Image height.
-
image
-
Optional. String. Page, site, or remote image glob. Only used in the inner content of this shortcode.
images
Optional. Position 0. String. Page, site, or remote images glob. Default is all image page resources.
justify
Optional. String. Main axis space distribution. Must be around, between, center, end, evenly, or start. Must not be used when nested.
+
maxheight
+
Optional. String. CSS value. Maximum image height.
maxwidth
Optional. String. CSS value. Maximum image width.
method
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Default is resize. See the methods.
options
Optional. String. Hugo image processing options. Default is 550x webp picture Lanczos. See the options.
-
raw
-
Optional. Boolean. Whether to reference an image without copying it. Default is false.
type
Optional. String. Type of layout. Grid and list layouts use the horizontal axis as the main axis, and the vertical axis as the cross axis. Must be grid or list. Default is list.
width
Optional. String. CSS value. Image width.
-It has the other parameters of the `paige/figure` shortcode. - ### Vimeo The `paige/vimeo` shortcode provides a responsive Vimeo video.