mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
21 lines
No EOL
7.6 KiB
XML
21 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>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. It could be any HTML tag name style &ldquo;li&rdquo; Choose th' style used t' display each descendant.</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) 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. Currently, it support two implementat'ns fer planks
|
|
If yer plank be a Marrrkdown file, attachements must be placed 'n a folder named like yer plank an' end'n wit' .</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> 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>Th' Expand shorrrtcode displays an expandable/collaps'ble section o' text on yer plank.
|
|
Usage {{% expand &#34;Does this Relearrrn theme rock?&#34; { &#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...&quot;.
|
|
Th' second optional parameter controls if th' block be initially shown as expanded (&quot;true&quot;) or collapsed (&quot;false&quot;). Th' default ist &quot;false&quot;.</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>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 &#34;&lt;file&gt;&#34; { &#34;true&#34; | &#34;false&#34; } %}} Th' first parameter be th' path t' th' file t' be included.
|
|
If th' file&rsquo;s rambl'n will be displayed as HTML, th' second optional parameter controls if th' first head'n o' th' included file should be displayed (&ldquo;true&rdquo;)- which be th' default - or be hidden.</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>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=(left|right|center|justify) ] &gt;}} classDiagram Person *-- Dog {{&lt; /mermaid &gt;}} Ye can set an optional align attribute which defaults t' center.
|
|
If ye don&rsquo;t need alignment ye can use th' alternative rules us'n code fences if ye have turned off guessSyntax fer th' marrrkup.</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>Th' notice shorrrtcode shows four types o' disclaimers t' help ye structure yer plank.
|
|
Usage {{% notice [ note | info | tip | warning ] %}} Some marrrkup {{% /notice %}} Examples Avast AvastA notice disclaimer
|
|
Ye can add:
|
|
multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides notice etc. ...and even source code th' possiblities be endless</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>siteparam shorrrtcode be used t' help ye print values o' ship params.
|
|
For instance, 'n this current ship, th' editURL vari'ble be used 'n config.toml
|
|
[params] editURL = &#34;https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/&#34; Use th' siteparam shorrrtcode t' display its value.
|
|
`editURL` Value : {{% siteparam &#34;editURL&#34; %}} be displayed as
|
|
editURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/</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>Choose which rambl'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!&#34; ``` {{% /tab %}} {{&lt; /tabs &gt;}} Renders as:
|
|
python R Bash print(&#34;Hello World!</description></item></channel></rss> |