diff --git a/README.md b/README.md index b132576f..b2d0b8c4 100644 --- a/README.md +++ b/README.md @@ -457,7 +457,7 @@ Parameters:
lang
-
Optional. Position 0. String. Chroma language code. Default is plaintext.
+
Optional. Position 0. String. Chroma language code. Default is "plaintext".
options
Optional. String. Hugo highlight options.
unescape
@@ -489,11 +489,11 @@ Parameters:
caption
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.
+
Optional. String. Float to one side of its container. Must be "start" or "end".
height
Optional. String. CSS value. Total height.
horizontal
-
Optional. String. Horizontal alignment. Must be start, center, or end. Default is center.
+
Optional. String. Horizontal alignment. Must be "start", "center", or "end". Default is "center".
maxwidth
Optional. String. CSS value. Maximum total width.
number
@@ -501,7 +501,7 @@ Parameters:
numbered
Optional. Boolean. Number the figure automatically. Displayed with the caption.
vertical
-
Optional. String. Vertical alignment. Must be start, center, or end. Default is center.
+
Optional. String. Vertical alignment. Must be "start", "center", or "end". Default is "center".
width
Optional. String. CSS value. Total width.
@@ -516,35 +516,35 @@ Parameters:
align
-
Optional. String. Cross axis alignment. Must be baseline, center, end, start, or stretch.
+
Optional. String. Cross axis alignment. Must be "baseline", "center", "end", "start", or "stretch".
breakpoints
Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with densities. Only applies to raster images.
class
Optional. String. Image class. Merged with implementation.
densities
-
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are 1x 2x, 1x 1.5x 2x 2.5x 3x, and 0.5x 1.33x 6x 10x. Must not use with breakpoints. Only applies to raster images.
+
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are "1x 2x", "1x 1.5x 2x 2.5x 3x", and "0.5x 1.33x 6x 10x". Must not use with breakpoints. Only applies to raster images.
fetchpriority
-
Optional. String. Must be high or low.
+
Optional. String. Must be "high" or "low".
height
Optional. String. CSS value. Image height.
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.
+
Optional. String. Main axis space distribution. Must be "around", "between", "center", "end", "evenly", or "start".
linked
Optional. Boolean or string. Wraps the image in an anchor. If it is a string, it is Hugo image processing methods and options, mixed together, for the linked image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is default, the default options are used. If it is a Boolean, it is unprocessed. Must be a Boolean for raster images.
loading
-
Optional. String. Must be eager (default) or lazy.
+
Optional. String. Must be "eager" (default) or "lazy".
maxheight
Optional. String. CSS value. Maximum image height.
maxwidth
Optional. String. CSS value. Maximum image width.
process
-
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is default, the default options are used. Only applies to raster images.
+
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is "default", the default options are used. Only applies to raster images.
style
Optional. String. CSS. Image style. Merged with implementation.
type
-
Optional. String. Type of layout. Must be grid or rows (default).
+
Optional. String. Type of layout. Must be "grid" or "rows" (default).
width
Optional. String. CSS value. Image width.
@@ -559,11 +559,11 @@ Parameters:
class
-
Required. Position 0. String. <i> class. Example: bi bi-github.
+
Required. Position 0. String. Container class. Example: "bi bi-github".
title
-
Optional. String. The screen reader description and anchor title. Example: GitHub.
+
Optional. String. The screen reader description and anchor title. Example: "GitHub".
url
-
Optional. String. URL. Example: https://github.com/account/project. E-mails in URLs with a mailto: scheme are protected from web crawlers.
+
Optional. String. URL. Example: "https://github.com/account/project". E-mails in URLs with a mailto: scheme are protected from web crawlers.
Body: None. @@ -582,23 +582,23 @@ Parameters:
class
Optional. String. Class attribute value.
densities
-
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are 1x 2x, 1x 1.5x 2x 2.5x 3x, and 0.5x 1.33x 6x 10x. Must not use with breakpoints, sizes, or srcset.
+
Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are "1x 2x", "1x 1.5x 2x 2.5x 3x", and "0.5x 1.33x 6x 10x". Must not use with breakpoints, sizes, or srcset.
fetchpriority
-
Optional. String. Must be high or low.
+
Optional. String. Must be "high" or "low".
height
Optional. String. CSS value. Image height.
link
Optional. String. URL. Image link. Must not use with linked.
linked
-
Optional. Boolean or string. Wraps the image in an anchor. If it is a string, it is Hugo image processing methods and options, mixed together, for the linked image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is default, the default options are used. If it is a Boolean, it is unprocessed. Must be a Boolean for raster images. Must not use with link.
+
Optional. Boolean or string. Wraps the image in an anchor. If it is a string, it is Hugo image processing methods and options, mixed together, for the linked image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is "default", the default options are used. If it is a Boolean, it is unprocessed. Must be a Boolean for raster images. Must not use with link.
loading
-
Optional. String. Must be eager (default) or lazy.
+
Optional. String. Must be "eager" (default) or "lazy".
maxheight
Optional. String. CSS value. Image maximum height.
maxwidth
Optional. String. CSS value. Image maximum width.
process
-
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is default, the default options are used.
+
Optional. String. Hugo image processing methods and options, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is "default", the default options are used.
sizes
Optional. String. Image sizes. Must not be set with breakpoints or densities.
src
@@ -636,7 +636,7 @@ Parameters:
method
-
Optional. String. HTTP method. Default is get.
+
Optional. String. HTTP method. Default is "get".
url
Required. String. URL.
@@ -696,11 +696,11 @@ Parameters:
byline
Optional. Boolean. Show the author. Default is configured per video.
color
-
Optional. String. Hex code. Control color. Default is 00adef.
+
Optional. String. Hex code. Control color. Default is "00adef".
controls
Optional. Boolean. Show the controls. Default is true.
description
-
Optional. String. Plain text. Screen reader content. Default is Vimeo video.
+
Optional. String. Plain text. Screen reader content. Default is "Vimeo video".
dnt
Optional. Boolean. Do not track session data. Default is false.
fullscreen
@@ -724,13 +724,13 @@ Parameters:
portrait
Optional. Boolean. Show the author's profile image. Default is configured per video.
quality
-
Optional. String. The resolution. Must be auto, 240p, 360p, 540p, 720p, 1080p, 2k, or 4k. Default is auto.
+
Optional. String. The resolution. Must be "auto", "240p", "360p", "540p", "720p", "1080p", "2k", or "4k". Default is "auto".
speed
Optional. Boolean. Show the speed controls. Default is false.
texttrack
-
Optional. String. Language code and optionally a locale code (e.g. en, en-US). Use the corresponding subtitles. Default is false.
+
Optional. String. Language code and optionally a locale code (e.g. "en", "en-US"). Use the corresponding subtitles. Default is false.
time
-
Optional. String. Duration (e.g. 0m, 1m2s). Start time. Default is 0m.
+
Optional. String. Duration (e.g. "0m", "1m2s"). Start time. Default is "0m".
title
Optional. Boolean. Show the title. Default is configured per video.
transparent
@@ -757,7 +757,7 @@ Parameters:
controls
Optional. Boolean. Show video controls. Default is true.
description
-
Optional. String. Plain text. Screen reader content. Default is YouTube video.
+
Optional. String. Plain text. Screen reader content. Default is "YouTube video".
end
Optional. Integer. Elapsed seconds. Stop the video here.
fullscreen
@@ -1017,23 +1017,23 @@ Shortcode classes:
.paige-shortcode-code
-
The container of paige/code shortcodes.
+
The container of "paige/code" shortcodes.
.paige-shortcode-email
-
The container of paige/email shortcodes.
+
The container of "paige/email" shortcodes.
.paige-shortcode-figure
-
The container of paige/figure shortcodes.
+
The container of "paige/figure" shortcodes.
.paige-shortcode-gallery
-
The container of paige/gallery shortcodes.
+
The container of "paige/gallery" shortcodes.
.paige-shortcode-icon
-
The container of paige/icon shortcodes.
+
The container of "paige/icon" shortcodes.
.paige-shortcode-image
-
The container of paige/image shortcodes.
+
The container of "paige/image" shortcodes.
.paige-shortcode-quote
-
The container of paige/quote shortcodes.
+
The container of "paige/quote" shortcodes.
.paige-shortcode-vimeo
-
The container of paige/vimeo shortcodes.
+
The container of "paige/vimeo" shortcodes.
.paige-shortcode-youtube
-
The container of paige/youtube shortcodes.
+
The container of "paige/youtube" shortcodes.
### Minimal look