From 0d858e9b614539cdb8119a0c7c925860b816a4e1 Mon Sep 17 00:00:00 2001 From: Will Faught Date: Thu, 19 Jan 2023 20:38:35 -0800 Subject: [PATCH] Refer to figure shortcode doc in other shortcode doc --- README.md | 161 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 83 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 6c28e569..c703ec0d 100644 --- a/README.md +++ b/README.md @@ -508,62 +508,72 @@ title: Search ### Figure -The `paige/figure` shortcode provides a figure with centered content. +The `paige/figure` shortcode provides a figure with content. ``` -{{< paige/figure align="center" caption="My caption" float="left" justify="center" >}} +{{< paige/figure + align="center" + caption="My caption" + float="left" + height="10rem" + justify="center" + maxheight="10rem" + maxwidth="10rem" + width="10rem" +>}} My content {{< /paige/figure >}} ``` +Inner content: Required. String. Markdown. The content. + Parameters:
-
.Inner
-
Required. String. Markdown. The inner content.
align
Optional. String. Horizontal alignment of the figure and caption. Must be start, center, or end. Default is center.
caption
-
Optional. Position 0. String. Markdown. Descriptive text that appears centered below the content.
+
Optional. Position 0. String. Markdown. Descriptive text below the content.
float
Optional. String. Float to one side of its container. Must be start or end.
+
height
+
Optional. String. CSS value. Total height.
justify
-
Optional. String. Vertical spacing of the figure and caption. Must be start, center, or end. Default is center.
+
Optional. String. Vertical alignment of the figure and caption. Must be start, center, or end. Default is center.
+
maxheight
+
Optional. String. CSS value. Maximum total height.
+
maxwidth
+
Optional. String. CSS value. Maximum total width.
+
width
+
Optional. String. CSS value. Total width.
### Quote -The `paige/quote` shortcode provides a figure with a centered quotation. +The `paige/quote` shortcode provides a figure with a quotation. ``` -{{< paige/quote align="center" caption="My caption" cite="My citation" float="left" justify="center" >}} +{{< paige/quote >}} My content {{< /paige/quote >}} ``` +Inner content: Required. String. Markdown. The quotation. + Parameters: -
-
.Inner
-
Required. String. Markdown. The inner content.
-
align
-
Optional. String. Horizontal alignment of the figure and caption. Must be start, center, or end. Default is center.
-
caption
-
Optional. String. Markdown. Descriptive text that appears centered below the quotation. Must not be used with cite.
-
cite
-
Optional. Position 0. String. Markdown. Citation text that appears centered below the quotation. Must not be used with caption.
-
float
-
Optional. String. Float to one side of its container. Must be start or end.
-
justify
-
Optional. String. Vertical spacing of the figure and caption. Must be start, center, or end. Default is center.
-
+It has the parameters of the `paige/figure` shortcode. ### Code -The `paige/code` shortcode provides a figure with centered code. +The `paige/code` shortcode provides a figure with code. ``` -{{< paige/code align="center" caption="My caption" float="left" justify="center" lang="html" options="linenos=true" >}} +{{< paige/code + caption="My caption" + lang="html" + options="linenos=true" +>}} @@ -573,91 +583,70 @@ The `paige/code` shortcode provides a figure with centered code. {{< /paige/code >}} ``` +Inner content: Required. String. The code. + Parameters:
-
.Inner
-
Required. String. Markdown. The inner content.
-
align
-
Optional. String. Horizontal alignment of the figure and caption. Must be start, center, or end. Default is center.
caption
-
Optional. String. Markdown. Descriptive text that appears centered below the code.
-
float
-
Optional. String. Float to one side of its container. Must be start or end.
-
justify
-
Optional. String. Vertical spacing of the figure and caption. Must be start, center, or end. Default is center.
+
Optional. String. Markdown. Descriptive text below the code.
lang
Optional. Position 0. String. Chroma language code. Defaults to plaintext. See available codes.
options
Optional. String. Hugo highlight options. See options.
+It has the other parameters of the `paige/figure` shortcode. + ### Image -The `paige/image` shortcode provides a figure with a centered image. +The `paige/image` shortcode provides a figure with an image. ``` {{< paige/image - align="center" alt="My alt" >}} caption="My caption" - float="left" - height="10rem" - justify="center" link="https://github.com/willfaught/paige" - maxheight="10rem" - maxwidth="10rem" method="resize" options="550x webp picture Lanczos" raw=false src="me.jpg" title="My title" - width="10rem" >}} +>}} ``` +Inner content: None. + Parameters:
-
align
-
Optional. String. Horizontal alignment of the figure and caption. Must be start, center, or end. Default is center.
alt
Optional. String. Plain text. Image alt.
caption
-
Optional. String. Markdown. Descriptive text that appears centered below the image.
-
float
-
Optional. String. Float to one side of its container. Must be start or end.
-
height
-
Optional. String. Image height.
-
justify
-
Optional. String. Vertical spacing of the figure and caption. Must be start, center, or end. Default is center.
+
Optional. String. Markdown. Descriptive text below the image.
link
Optional. String. URL. Image link.
-
maxheight
-
Optional. String. Maximum image height.
-
maxwidth
-
Optional. String. Maximum image width.
method
-
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See Image Processing Methods.
+
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See methods.
options
-
Optional. String. Hugo image processing options. Must be specified with method. See Image Processing Options.
+
Optional. String. Hugo image processing options. Must be specified with method. See options.
raw
Optional. Boolean. Whether to reference an image without copying it. Default is false.
src
-
Required. Position 0. String. URL. Image URL.
+
Required. Position 0. String. URL. Image source.
title
Optional. String. Plain text. Image title.
-
width
-
Optional. String. Image width.
+It has the other parameters of the `paige/figure` shortcode. + ### Gallery -The `paige/gallery` shortcode provides a figure with a centered list of images. +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" @@ -671,51 +660,67 @@ The `paige/gallery` shortcode provides a figure with a centered list of images. {{< paige/gallery >}} {{< paige/gallery - image="me.jpg" + align="center" caption="My caption" + height="10rem" + image="me.jpg" + justify="center" + maxheight="10rem" + maxwidth="10rem" + method="resize" + options="550x webp picture Lanczos" raw=false - >}} + width="10rem" + />}} {{< paige/gallery - image="you.jpg" + align="center" caption="My caption" + height="10rem" + image="you.jpg" + justify="center" + maxheight="10rem" + maxwidth="10rem" + method="resize" + options="550x webp picture Lanczos" raw=false - >}} + width="10rem" + />}} {{< /paige/gallery >}} ``` +Inner content: Optional. String. HTML. Must be other invocations of this shortcode. + Parameters:
-
.Inner
-
Optional. String. Markdown. The inner content. Must be other invocations of the same shortcode.
align
-
Optional. String. Flexbox cross axis alignment. Must be start, center, end, etc. See align-items.
-
caption
-
Optional. String. Markdown. Descriptive text that appears centered below the images.
+
Optional. String. Cross axis alignment. Must be start, center, end, etc. See align-items.
height
-
Optional. String. Image 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. Flexbox main axis space distribution. Must be start, center, end, etc. See justify-content.
+
Optional. String. Main axis space distribution. Must be start, center, end, etc. See justify-content.
maxheight
-
Optional. String. Maximum image height.
+
Optional. String. CSS value. Maximum image height.
maxwidth
-
Optional. String. Maximum image width.
+
Optional. String. CSS value. Maximum image width.
method
-
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Default is resize. Must be specified with options. See Image Processing Methods.
+
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Default is resize. See methods.
options
-
Optional. String. Hugo image processing options. Default is 550x webp picture Lanczos. Must be specified with method. See Image Processing Options.
+
Optional. String. Hugo image processing options. Default is 550x webp picture Lanczos. See options.
raw
Optional. Boolean. Whether to reference an image without copying it. Default is false.
type
-
Optional. String. Type of layout. Must be grid or list. Default is list.
+
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. Image width.
+
Optional. String. CSS value. Image width.
+It has the other parameters of the `paige/figure` shortcode. + ## Customization If `partials/paige/head-last.html` exists in the site, it is included at the end of the head tag.