From a34601c61ef8a05b551736f4824dc17ea965525e Mon Sep 17 00:00:00 2001 From: Will Faught Date: Tue, 10 Jan 2023 21:15:24 -0800 Subject: [PATCH] Add string type to shortcode param doc --- README.md | 68 +++++++++++++++++++++++++++---------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index fcf1050d..e450833b 100644 --- a/README.md +++ b/README.md @@ -520,9 +520,9 @@ Parameters:
.Inner
-
Required. Markdown. The inner content.
+
Required. String. Markdown. The inner content.
caption
-
Optional. Unnamed argument. Markdown. Descriptive text that appears centered below the content.
+
Optional. Unnamed argument. String. Markdown. Descriptive text that appears centered below the content.
### Quote @@ -539,13 +539,13 @@ Parameters:
.Inner
-
Required. Markdown. The inner content.
+
Required. String. Markdown. The inner content.
align
-
Optional. Aligns text horizontally. Must be start, center, or end.
+
Optional. String. Aligns text horizontally. Must be start, center, or end.
caption
-
Optional. Markdown. Descriptive text that appears centered below the quotation. Must not be used with cite.
+
Optional. String. Markdown. Descriptive text that appears centered below the quotation. Must not be used with cite.
cite
-
Optional. Unnamed argument. Markdown. Must not be used with caption.
+
Optional. Unnamed argument. String. Markdown. Must not be used with caption.
### Code @@ -567,13 +567,13 @@ Parameters:
.Inner
-
Required. Markdown. The inner content.
+
Required. String. Markdown. The inner content.
caption
-
Optional. Markdown. Descriptive text that appears centered below the code.
+
Optional. String. Markdown. Descriptive text that appears centered below the code.
lang
-
Required. Unnamed argument. Chroma language code. See available codes.
+
Required. Unnamed argument. String. Chroma language code. See available codes.
options
-
Optional. Hugo highlight options. See options.
+
Optional. String. Hugo highlight options. See options.
### Image @@ -599,27 +599,27 @@ Parameters:
alt
-
Optional. Plain text. Image alt.
+
Optional. String. Plain text. Image alt.
caption
-
Optional. Markdown. Descriptive text that appears centered below the image.
+
Optional. String. Markdown. Descriptive text that appears centered below the image.
height
-
Optional. Image height in pixels.
+
Optional. String. Image height in pixels.
link
-
Optional. URL. Image link.
+
Optional. String. URL. Image link.
maxheight
-
Optional. Maximum image height.
+
Optional. String. Maximum image height.
maxwidth
-
Optional. Maximum image width.
+
Optional. String. Maximum image width.
method
-
Optional. 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 Image Processing Methods.
options
-
Optional. 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 Image Processing Options.
src
-
Required. Unnamed argument. URL. Image URL.
+
Required. Unnamed argument. String. URL. Image URL.
title
-
Optional. Plain text. Image title.
+
Optional. String. Plain text. Image title.
width
-
Optional. Image width in pixels.
+
Optional. String. Image width in pixels.
### Gallery @@ -657,31 +657,31 @@ Parameters:
.Inner
-
Optional. Markdown. The inner content. Must be other invocations of the same shortcode.
+
Optional. String. Markdown. The inner content. Must be other invocations of the same shortcode.
align
-
Optional. Flexbox cross axis alignment. Must be start, center, end, etc. See align-items.
+
Optional. String. Flexbox cross axis alignment. Must be start, center, end, etc. See align-items.
caption
-
Optional. Markdown. Descriptive text that appears centered below the images.
+
Optional. String. Markdown. Descriptive text that appears centered below the images.
height
-
Optional. Height of the image or images in pixels.
+
Optional. String. Height of the image or images in pixels.
image
-
Optional. Page, site, or remote image glob. Only used in the inner content of this shortcode.
+
Optional. String. Page, site, or remote image glob. Only used in the inner content of this shortcode.
images
-
Optional. Unnamed argument. Page, site, or remote images glob. Defaults to all image page resources.
+
Optional. Unnamed argument. String. 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.
+
Optional. String. Flexbox main axis space distribution. Must be start, center, end, etc. See justify-content.
maxheight
-
Optional. Maximum height of the image or images.
+
Optional. String. Maximum height of the image or images.
maxwidth
-
Optional. Maximum width of the image or images.
+
Optional. String. Maximum width of the image or images.
method
-
Optional. 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. Must be specified with options. See Image Processing Methods.
options
-
Optional. 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. Must be specified with method. See Image Processing Options.
type
-
Optional. Type of layout. Must be grid or list. Default is list.
+
Optional. String. Type of layout. Must be grid or list. Default is list.
width
-
Optional. Width of the image or images in pixels.
+
Optional. String. Width of the image or images in pixels.
## Customization