Rockingcool/paige-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document rest of image shortcode params

Browse Source
This commit is contained in:
Will Faught
2023-01-08 23:15:56 -08:00
parent 9392f681aa
commit eed809fae4
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -584,9 +584,13 @@ The `paige/image` shortcode provides a figure with a centered image.
{{< paige/image {{< paige/image
alt="My alt" >}} alt="My alt" >}}
caption="My caption" caption="My caption"
link="https://xkcd.com/149" height="10rem"
src="https://imgs.xkcd.com/comics/sandwich.png" link="https://github.com/willfaught/paige"
method="resize"
options="550x webp picture Lanczos"
src="me.jpg"
title="My title" title="My title"
width="10rem" >}}
``` ```
Parameters: Parameters:
@@ -596,12 +600,20 @@ Parameters:
<dd>Optional. Plain text. Image alt.</dd> <dd>Optional. Plain text. Image alt.</dd>
<dt><code>caption</code></dt> <dt><code>caption</code></dt>
<dd>Optional. Descriptive text that appears centered below the image. Markdown.</dd> <dd>Optional. Descriptive text that appears centered below the image. Markdown.</dd>
<dt><code>height</code></dt>
<dd>Optional. Image height in pixels.</dd>
<dt><code>link</code></dt> <dt><code>link</code></dt>
<dd>Optional. URL. Image link.</dd> <dd>Optional. URL. Image link.</dd>
<dt><code>title</code></dt> <dt><code>method</code></dt>
<dd>Optional. Plain text. Image title.</dd> <dd>Optional. Hugo image processing method. Must be <code>crop</code>, <code>fill</code>, <code>fit</code>, or <code>resize</code>. Must be specified with <code>options</code>. See <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">Image Processing Methods</a>.</dd>
<dt><code>options</code></dt>
<dd>Optional. Hugo image processing options. Must be specified with <code>method</code>. See <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">Image Processing Options</a>.</dd>
<dt><code>src</code></dt> <dt><code>src</code></dt>
<dd>Required. Unnamed argument. URL. Image URL.</dd> <dd>Required. Unnamed argument. URL. Image URL.</dd>
<dt><code>title</code></dt>
<dd>Optional. Plain text. Image title.</dd>
<dt><code>width</code></dt>
<dd>Optional. Image width in pixels.</dd>
</dl> </dl>
``` ```