mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 11:13:06 +00:00
23 lines
No EOL
7.6 KiB
XML
23 lines
No EOL
7.6 KiB
XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Shorrrtcodes on Documentat'n fer Cap'n Hugo Relearrrn Theme</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/</link><description>Recent content in Shorrrtcodes on Documentat'n fer Cap'n Hugo Relearrrn Theme</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/index.xml" rel="self" type="application/rss+xml"/><item><title>Children</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/children/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/children/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Use th' children shorrrtcode t' list th' child planks o' a plank an' th' further descendants (children&rsquo;s children). By default, th' shorrrtcode displays links t' th' child planks.
|
|
Usage Parameter Default Descript'n plank current Specify th' plank name (section name) t' display children fer containerstyle &ldquo;ul&rdquo; Choose th' style used t' group all children.</description></item><item><title>Attachments</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/</guid><description>Attachments NoTreasure.txt (26 B) Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Th' Attachments shorrrtcode displays a list o' files attached t' a plank.
|
|
Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage Th' shortcurt lists files found 'n a specific folder.</description></item><item><title>Button</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/button/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/button/</guid><description> Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
A button be a just a click'ble button wit' optional ay'con.
|
|
{{% button href=&#34;https://gohugo.io/&#34; %}}Get Hugo{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; %}}Get Cap'n Hugo wit' icon{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; ay'con-position=&#34;right&#34; %}}Get Cap'n Hugo wit' ay'con right{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo wit' ay'con Get Cap'n Hugo wit' ay'con right</description></item><item><title>Expand</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Th' Expand shorrrtcode displays an expandable/collaps'ble section o' text on yer plank.
|
|
Usage {{% expand [ &lt;str'n&gt; [ &#34;true&#34; | &#34;false&#34; ] ] %}} Yes! {{% /expand %}} Th' first optional parameter defines th' text that appears next t' th' expand/collapse ay'con. Th' default text be &quot;Expand me.</description></item><item><title>Include</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/include/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/include/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Th' include shorrrtcode includes other files from yer project inside o' th' current file. This can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.
|
|
Usage {{% include &lt;str'n&gt; [ &#34;true&#34; | &#34;false&#34; ] %}} Th' first required parameter be th' path t' th' file t' be included.</description></item><item><title>Merrrmaid</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Merrrmaid be a library help'n ye t' generate diagram an' flowcharts from text, 'n a similar manner as Marrrkdown.
|
|
Usage Just insert yer Merrrmaid code 'n th' mermaid shorrrtcode like this:
|
|
{{&lt; mermaid [ align=(&#34;left&#34;|&#34;right&#34;|&#34;center&#34;|&#34;justify&#34;) ] &gt;}} classDiagram Person *-- Dog {{&lt; /mermaid &gt;}} Ye can set an optional align attribute which defaults t' &quot;center&quot;.</description></item><item><title>Notice</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/notice/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/notice/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Th' notice shorrrtcode shows four types o' disclaimers t' help ye structure yer plank.
|
|
Usage {{% notice ( note | info | tip | warning ) [ &lt;str'n&gt; ] %}} Some marrrkup {{% /notice %}} Th' first parameter be required an' indicates th' type o' notice.
|
|
Th' second parameter be optional.</description></item><item><title>Ship param</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Th' siteparam shorrrtcode be used t' help ye print values o' ship params.
|
|
Usage {{% siteparam &lt;str'n&gt; %}} Th' first required parameter be th' name o' th' ship param t' be displayed.
|
|
Examples For instance, 'n this current ship, th' editURL vari'ble be used 'n config.toml
|
|
[params] editURL = &#34;https://github.</description></item><item><title>Tabbed views</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/tabs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/tabs/</guid><description>Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.
|
|
Choose which rrrambl'n t' see across th' plank. Very handy fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.
|
|
Code example {{&lt; tabs &gt;}} {{% tab name=&#34;python&#34; %}} ```python print(&#34;Hello World!&#34;) ``` {{% /tab %}} {{% tab name=&#34;R&#34; %}} ```R &gt; print(&#34;Hello World!&#34;) ``` {{% /tab %}} {{% tab name=&#34;Bash&#34; %}} ```Bash echo &#34;Hello World!</description></item></channel></rss> |