From eed809fae4f9f9c246d8c1caa2761cbcfe55a2d2 Mon Sep 17 00:00:00 2001 From: Will Faught Date: Sun, 8 Jan 2023 23:15:56 -0800 Subject: [PATCH] Document rest of image shortcode params --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c440519..a9157be0 100644 --- a/README.md +++ b/README.md @@ -584,9 +584,13 @@ The `paige/image` shortcode provides a figure with a centered image. {{< paige/image alt="My alt" >}} caption="My caption" - link="https://xkcd.com/149" - src="https://imgs.xkcd.com/comics/sandwich.png" + height="10rem" + link="https://github.com/willfaught/paige" + method="resize" + options="550x webp picture Lanczos" + src="me.jpg" title="My title" + width="10rem" >}} ``` Parameters: @@ -596,12 +600,20 @@ Parameters:
Optional. Plain text. Image alt.
caption
Optional. Descriptive text that appears centered below the image. Markdown.
+
height
+
Optional. Image height in pixels.
link
Optional. URL. Image link.
-
title
-
Optional. Plain text. Image title.
+
method
+
Optional. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See Image Processing Methods.
+
options
+
Optional. Hugo image processing options. Must be specified with method. See Image Processing Options.
src
Required. Unnamed argument. URL. Image URL.
+
title
+
Optional. Plain text. Image title.
+
width
+
Optional. Image width in pixels.
```