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

Add string type to shortcode param doc

Browse Source
This commit is contained in:
Will Faught
2023-01-10 21:15:24 -08:00
parent 2c98c5aba1
commit a34601c61e
1 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -520,9 +520,9 @@ Parameters:
<dl>
<dt><code>.Inner</code></dt>
<dd>Required. Markdown. The inner content.</dd>
<dd>Required. String. Markdown. The inner content.</dd>
<dt><code>caption</code></dt>
<dd>Optional. Unnamed argument. Markdown. Descriptive text that appears centered below the content.</dd>
<dd>Optional. Unnamed argument. String. Markdown. Descriptive text that appears centered below the content.</dd>
</dl>
### Quote
@@ -539,13 +539,13 @@ Parameters:
<dl>
<dt><code>.Inner</code></dt>
<dd>Required. Markdown. The inner content.</dd>
<dd>Required. String. Markdown. The inner content.</dd>
<dt><code>align</code></dt>
<dd>Optional. Aligns text horizontally. Must be <code>start</code>, <code>center</code>, or <code>end</code>.</dd>
<dd>Optional. String. Aligns text horizontally. Must be <code>start</code>, <code>center</code>, or <code>end</code>.</dd>
<dt><code>caption</code></dt>
<dd>Optional. Markdown. Descriptive text that appears centered below the quotation. Must not be used with <code>cite</code>.</dd>
<dd>Optional. String. Markdown. Descriptive text that appears centered below the quotation. Must not be used with <code>cite</code>.</dd>
<dt><code>cite</code></dt>
<dd>Optional. Unnamed argument. Markdown. Must not be used with <code>caption</code>.</dd>
<dd>Optional. Unnamed argument. String. Markdown. Must not be used with <code>caption</code>.</dd>
</dl>
### Code
@@ -567,13 +567,13 @@ Parameters:
<dl>
<dt><code>.Inner</code></dt>
<dd>Required. Markdown. The inner content.</dd>
<dd>Required. String. Markdown. The inner content.</dd>
<dt><code>caption</code></dt>
<dd>Optional. Markdown. Descriptive text that appears centered below the code.</dd>
<dd>Optional. String. Markdown. Descriptive text that appears centered below the code.</dd>
<dt><code>lang</code></dt>
<dd>Required. Unnamed argument. Chroma language code. See <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">available codes</a>.</dd>
<dd>Required. Unnamed argument. String. Chroma language code. See <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">available codes</a>.</dd>
<dt><code>options</code></dt>
<dd>Optional. Hugo highlight options. See <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode">options</a>.</dd>
<dd>Optional. String. Hugo highlight options. See <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode">options</a>.</dd>
</dl>
### Image
@@ -599,27 +599,27 @@ Parameters:
<dl>
<dt><code>alt</code></dt>
<dd>Optional. Plain text. Image alt.</dd>
<dd>Optional. String. Plain text. Image alt.</dd>
<dt><code>caption</code></dt>
<dd>Optional. Markdown. Descriptive text that appears centered below the image.</dd>
<dd>Optional. String. Markdown. Descriptive text that appears centered below the image.</dd>
<dt><code>height</code></dt>
<dd>Optional. Image height in pixels.</dd>
<dd>Optional. String. Image height in pixels.</dd>
<dt><code>link</code></dt>
<dd>Optional. URL. Image link.</dd>
<dd>Optional. String. URL. Image link.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. Maximum image height.</dd>
<dd>Optional. String. Maximum image height.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. Maximum image width.</dd>
<dd>Optional. String. Maximum image width.</dd>
<dt><code>method</code></dt>
<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>
<dd>Optional. String. 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>
<dd>Optional. String. 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>
<dd>Required. Unnamed argument. URL. Image URL.</dd>
<dd>Required. Unnamed argument. String. URL. Image URL.</dd>
<dt><code>title</code></dt>
<dd>Optional. Plain text. Image title.</dd>
<dd>Optional. String. Plain text. Image title.</dd>
<dt><code>width</code></dt>
<dd>Optional. Image width in pixels.</dd>
<dd>Optional. String. Image width in pixels.</dd>
</dl>
### Gallery
@@ -657,31 +657,31 @@ Parameters:
<dl>
<dt><code>.Inner</code></dt>
<dd>Optional. Markdown. The inner content. Must be other invocations of the same shortcode.</dd>
<dd>Optional. String. Markdown. The inner content. Must be other invocations of the same shortcode.</dd>
<dt><code>align</code></dt>
<dd>Optional. Flexbox cross axis alignment. Must be <code>start</code>, <code>center</code>, <code>end</code>, etc. See <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/align-items"><code>align-items</code></a>.</dd>
<dd>Optional. String. Flexbox cross axis alignment. Must be <code>start</code>, <code>center</code>, <code>end</code>, etc. See <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/align-items"><code>align-items</code></a>.</dd>
<dt><code>caption</code></dt>
<dd>Optional. Markdown. Descriptive text that appears centered below the images.</dd>
<dd>Optional. String. Markdown. Descriptive text that appears centered below the images.</dd>
<dt><code>height</code></dt>
<dd>Optional. Height of the image or images in pixels.</dd>
<dd>Optional. String. Height of the image or images in pixels.</dd>
<dt><code>image</code></dt>
<dd>Optional. Page, site, or remote image glob. Only used in the inner content of this shortcode.</dd>
<dd>Optional. String. Page, site, or remote image glob. Only used in the inner content of this shortcode.</dd>
<dt><code>images</code></dt>
<dd>Optional. Unnamed argument. Page, site, or remote images glob. Defaults to all image page resources.</dd>
<dd>Optional. Unnamed argument. String. Page, site, or remote images glob. Defaults to all image page resources.</dd>
<dt><code>justify</code></dt>
<dd>Optional. Flexbox main axis space distribution. Must be <code>start</code>, <code>center</code>, <code>end</code>, etc. See <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content"><code>justify-content</code></a>.</dd>
<dd>Optional. String. Flexbox main axis space distribution. Must be <code>start</code>, <code>center</code>, <code>end</code>, etc. See <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content"><code>justify-content</code></a>.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. Maximum height of the image or images.</dd>
<dd>Optional. String. Maximum height of the image or images.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. Maximum width of the image or images.</dd>
<dd>Optional. String. Maximum width of the image or images.</dd>
<dt><code>method</code></dt>
<dd>Optional. Hugo image processing method. Must be <code>crop</code>, <code>fill</code>, <code>fit</code>, or <code>resize</code>. Default is <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>
<dd>Optional. String. Hugo image processing method. Must be <code>crop</code>, <code>fill</code>, <code>fit</code>, or <code>resize</code>. Default is <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. Default is <code>550x webp picture Lanczos</code>. 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>
<dd>Optional. String. Hugo image processing options. Default is <code>550x webp picture Lanczos</code>. 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>type</code></dt>
<dd>Optional. Type of layout. Must be <code>grid</code> or <code>list</code>. Default is <code>list</code>.</dd>
<dd>Optional. String. Type of layout. Must be <code>grid</code> or <code>list</code>. Default is <code>list</code>.</dd>
<dt><code>width</code></dt>
<dd>Optional. Width of the image or images in pixels.</dd>
<dd>Optional. String. Width of the image or images in pixels.</dd>
</dl>
## Customization