diff --git a/README.md b/README.md index 1ed9934e..d24b3e2c 100644 --- a/README.md +++ b/README.md @@ -516,6 +516,13 @@ My content {{< /paige/figure >}} ``` +Parameters: + +
+
caption
+
Optional. Descriptive text that appears centered below the images. Markdown.
+
+ ### Quote The `paige/quote` shortcode provides a figure with centered content and an optional, centered caption. @@ -526,11 +533,13 @@ My content {{< /paige/quote >}} ``` +Parameters: +
align
Optional. Aligns text horizontally. Must be start, center, or end.
caption
-
Optional. Markdown. Must not be used with cite.
+
Optional. Descriptive text that appears centered below the images. Markdown. Must not be used with cite.
cite
Optional. Markdown. Must not be used with caption.
@@ -542,7 +551,7 @@ The `paige/code` shortcode provides a figure with centered, highlighted code and These are the the named parameters with positions: ``` -{{< paige/code lang="go" caption="My caption" options="linenos=true" >}} +{{< paige/code caption="My caption" lang="html" options="linenos=true" >}} @@ -552,6 +561,17 @@ These are the the named parameters with positions: {{< /paige/code >}} ``` +Parameters: + +
+
caption
+
Optional. Descriptive text that appears centered below the images. Markdown.
+
lang
+
Required. Chroma language code.
+
options
+
Optional. Hugo highlight options.
+
+ ### Image The `paige/image` shortcode provides a figure with a centered image and an optional, centered caption. @@ -560,17 +580,27 @@ These are the the named parameters with positions: ``` {{< paige/image - src="https://imgs.xkcd.com/comics/sandwich.png" + alt="My alt" >}} caption="My caption" link="https://xkcd.com/149" title="My title" - alt="My alt" >}} + src="https://imgs.xkcd.com/comics/sandwich.png" ``` -Only the image source parameter is required. -If the image source argument is a relative path, it must be a page resource. +Parameters: -These are the named parameters without positions: +
+
alt
+
Optional. Plain text. Image alt.
+
caption
+
Optional. Descriptive text that appears centered below the images. Markdown.
+
link
+
Optional. URL. Image link.
+
title
+
Optional. Plain text. Image title.
+
src
+
Required. URL. Image URL.
+
``` {{< paige/image height=500 width=500 >}} @@ -579,58 +609,53 @@ These are the named parameters without positions: ### Gallery The `paige/gallery` shortcode provides a figure with a set of images and an optional, centered caption. +Since it can have inner content, it must always be closed or self-closed. ``` {{< paige/gallery - - // Page resource image file name or pattern; optional; defaults to all images - images="birthday*.jpg" - - // Optional + align="center" caption="My caption" - - // Hugo image processing method; optional; values are "crop", "fill", "fit", "resize"; default is "resize" + height="10rem" + images="*.jpg" + justify="center" method="resize" - - // Hugo image processing options; optional; default is "550x webp picture Lanczos" - options="550x webp picture Lanczos" - - // Display images in a grid or list; optional; values are "grid", "list"; default is "grid" - display="grid" - + options="550x jpg picture Lanczos" + type="list" + width="10rem" />}} -``` - -The `paige/gallery/item` shortcode is nested within the `paige/gallery` shortcode to provide a caption and customization per image. -The display type is automatically list, and cannot be overridden. - -``` -{{< paige/gallery caption="My caption" method="resize" options="550x webp picture Lanczos" >}} - {{< paige/gallery/item - - // Page resource image file name or pattern - image="birthday1.jpg" - - // Optional +{{< paige/gallery >}} + {{< paige/gallery + image="me.jpg" caption="My caption" - - // Optional - method="resize" - - // Optional - options="550x webp picture Lanczos" - >}} - {{< /paige/gallery >}} ``` -The `paige/gallery` shortcode must be self-closing if the `paige/gallery/item` shortcode is not used. +Parameters: -``` -{{< paige/gallery />}} -``` +
+
align
+
Optional. Flexbox cross axis alignment. Must be start, center, end, etc. See align-items.
+
caption
+
Optional. Descriptive text that appears centered below the images. Markdown.
+
height
+
Optional. Height of the image or images.
+
image
+
Optional. Page, site, or remote image glob. Only used in the inner content of this shortcode.
+
images
+
Optional. Page, site, or remote images glob. Defaults to all image page resources.
+
justify
+
Optional. Flexbox main axis space distribution. Must be start, center, end, etc. See justify-content.
+
method
+
Optional. Hugo image processing method. Must be crop, fill, fit, or resize. Default is resize. See Image Processing Methods.
+
options
+
Optional. Hugo image processing options. Default is 550x webp picture Lanczos. See Image Processing Options.
+
type
+
Optional. Type of layout. Must be grid or list. Default is list.
+
width
+
Optional. Width of the image or images.
+
## Customization