From b43fbbe09c99ecbdec23dde8edccb54a29e876b2 Mon Sep 17 00:00:00 2001 From: Will Faught Date: Wed, 22 Mar 2023 21:13:31 -0700 Subject: [PATCH] Order shortcodes in readme --- README.md | 172 +++++++++++++++++++++++++++--------------------------- 1 file changed, 86 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index c6dff1a1..e58b897e 100644 --- a/README.md +++ b/README.md @@ -378,6 +378,32 @@ title: "Search" ## Shortcodes +### Code + +The `paige/code` shortcode provides a figure with code. + +``` +{{< paige/code lang="html" options="linenos=true" >}} + + + +

Test

+ + +{{< /paige/code >}} +``` + +Inner content: Required. String. The code. + +Parameters: + +
+
lang
+
Optional. Position 0. String. Chroma language code. Defaults to plaintext. See the codes.
+
options
+
Optional. String. Hugo highlight options. See the options.
+
+ ### Figure The `paige/figure` shortcode provides a figure with content. @@ -423,92 +449,6 @@ Parameters:
Optional. String. CSS value. Total width.
-### Quote - -The `paige/quote` shortcode provides a figure with a quotation. - -``` -{{< paige/quote >}} -My content -{{< /paige/quote >}} -``` - -Inner content: Required. String. Markdown. The quotation. - -Parameters: None. - -### Code - -The `paige/code` shortcode provides a figure with code. - -``` -{{< paige/code lang="html" options="linenos=true" >}} - - - -

Test

- - -{{< /paige/code >}} -``` - -Inner content: Required. String. The code. - -Parameters: - -
-
lang
-
Optional. Position 0. String. Chroma language code. Defaults to plaintext. See the codes.
-
options
-
Optional. String. Hugo highlight options. See the options.
-
- -### Image - -The `paige/image` shortcode provides a figure with an image. - -``` -{{< paige/image - alt="My alt" >}} - height="10rem" - link="https://github.com/willfaught/paige" - maxheight="10rem" - maxwidth="10rem" - method="resize" - options="550x webp picture Lanczos" - src="me.jpg" - title="My title" - width="10rem" ->}} -``` - -Inner content: None. - -Parameters: - -
-
alt
-
Optional. String. Plain text. Image alt.
-
height
-
Optional. String. CSS value. Image height.
-
link
-
Optional. String. URL. Image link.
-
maxheight
-
Optional. String. CSS value. Image maximum height.
-
maxwidth
-
Optional. String. CSS value. Image maximum width.
-
method
-
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See the methods.
-
options
-
Optional. String. Hugo image processing options. Must be specified with method. See the options.
-
src
-
Required. Position 0. String. URL. Image source.
-
title
-
Optional. String. Plain text. Image title.
-
width
-
Optional. String. CSS value. Image width.
-
- ### Gallery The `paige/gallery` shortcode provides a figure with a collection of images. @@ -582,6 +522,66 @@ Parameters:
Optional. String. URL. E-mails in URLs with a mailto: scheme are protected from web crawlers.
+### Image + +The `paige/image` shortcode provides a figure with an image. + +``` +{{< paige/image + alt="My alt" >}} + height="10rem" + link="https://github.com/willfaught/paige" + maxheight="10rem" + maxwidth="10rem" + method="resize" + options="550x webp picture Lanczos" + src="me.jpg" + title="My title" + width="10rem" +>}} +``` + +Inner content: None. + +Parameters: + +
+
alt
+
Optional. String. Plain text. Image alt.
+
height
+
Optional. String. CSS value. Image height.
+
link
+
Optional. String. URL. Image link.
+
maxheight
+
Optional. String. CSS value. Image maximum height.
+
maxwidth
+
Optional. String. CSS value. Image maximum width.
+
method
+
Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See the methods.
+
options
+
Optional. String. Hugo image processing options. Must be specified with method. See the options.
+
src
+
Required. Position 0. String. URL. Image source.
+
title
+
Optional. String. Plain text. Image title.
+
width
+
Optional. String. CSS value. Image width.
+
+ +### Quote + +The `paige/quote` shortcode provides a figure with a quotation. + +``` +{{< paige/quote >}} +My content +{{< /paige/quote >}} +``` + +Inner content: Required. String. Markdown. The quotation. + +Parameters: None. + ### Vimeo The `paige/vimeo` shortcode provides a responsive Vimeo video.