Change hero param format to process

This commit is contained in:
Will Faught
2023-04-07 23:49:45 -07:00
parent 58a2f82e51
commit 5ee01538f5
3 changed files with 6 additions and 6 deletions

View File

@@ -413,7 +413,7 @@ Parameters:
The `paige/hero` shortcode provides a hero section.
```
{{< paige/hero alt="" format="" header="" height="" image="" imageclass="" maxheight="" maxwidth="" title="" width="" >}} {{< /paige/hero >}}
{{< paige/hero alt="" header="" height="" image="" imageclass="" maxheight="" maxwidth="" process="" title="" width="" >}} {{< /paige/hero >}}
```
Inner content: Optional. String. Markdown. The body.
@@ -423,8 +423,6 @@ Parameters:
<dl>
<dt><code>alt</code></dt>
<dd>Optional. String. Plain text. Image alt.</dd>
<dt><code>format</code></dt>
<dd>Optional. String. Image format. Must be <code>bmp</code>, <code>gif</code>, <code>jpg</code>, <code>png</code>, <code>tiff</code>, or <code>webp</code>. Must not be used with <code>method</code> or <code>options</code>.</dd>
<dt><code>header</code></dt>
<dd>Optional. String. Markdown. The header.</dd>
<dt><code>height</code></dt>
@@ -437,6 +435,8 @@ Parameters:
<dd>Optional. String. CSS value. Image maximum height. Default is <code>20rem</code>.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Image maximum width.</dd>
<dt><code>process</code></dt>
<dd>Optional. String or boolean. If a string, it is the Hugo image processing <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a> and <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>, mixed together. If no method is specified, resize is used. If no image dimensions are given, the originals are used. If a boolean that is true, the Hugo image processing method resize is used, and the default Hugo image processing options are used.</dd>
<dt><code>stretch</code></dt>
<dd>Optional. Boolean. Whether to stretch the image fully horizontally.</dd>
<dt><code>title</code></dt>