mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
94 lines
No EOL
8 KiB
XML
94 lines
No EOL
8 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>Shortcodes on Hugo Relearn Theme</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/</link>
|
|
<description>Recent content in Shortcodes on Hugo Relearn Theme</description>
|
|
<generator>Hugo -- gohugo.io</generator>
|
|
<language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/index.xml" rel="self" type="application/rss+xml" />
|
|
<item>
|
|
<title>Children</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/</guid>
|
|
<description>Use the children shortcode to list the child pages of a page and the further descendants (children&rsquo;s children). By default, the shortcode displays links to the child pages.
|
|
Usage Parameter Default Description page current Specify the page name (section name) to display children for containerstyle &ldquo;ul&rdquo; Choose the style used to group all children. It could be any HTML tag name style &ldquo;li&rdquo; Choose the style used to display each descendant.</description>
|
|
</item>
|
|
<item>
|
|
<title>Attachments</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/</guid>
|
|
<description>The Attachments shortcode displays a list of files attached to a page.
|
|
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 The shortcurt lists files found in a specific folder. Currently, it support two implementations for pages
|
|
If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with .</description>
|
|
</item>
|
|
<item>
|
|
<title>Button</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/button/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/button/</guid>
|
|
<description>A button is a just a clickable button with optional icon.
|
|
{{% button href=&#34;https://gohugo.io/&#34; %}}Get Hugo{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; %}}Get Hugo with icon{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; icon=&#34;fas fa-download&#34; icon-position=&#34;right&#34; %}}Get Hugo with icon right{{% /button %}} Get Hugo Get Hugo with icon Get Hugo with icon right </description>
|
|
</item>
|
|
<item>
|
|
<title>Expand</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/</guid>
|
|
<description>The Expand shortcode displays an expandable/collapsible section of text on your page.
|
|
Usage {{% expand [ &lt;string&gt; [ &#34;true&#34; | &#34;false&#34; ] ] %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is &quot;Expand me...&quot;.
|
|
The second optional parameter controls if the block is initially shown as expanded (&quot;true&quot;) or collapsed (&quot;false&quot;). The default ist &quot;false&quot;.
|
|
Examples I&#39;ll tell you a secret.</description>
|
|
</item>
|
|
<item>
|
|
<title>Include</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/</guid>
|
|
<description>The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.
|
|
Usage {{% include &lt;string&gt; [ &#34;true&#34; | &#34;false&#34; ] %}} The first required parameter is the path to the file to be included.
|
|
If the file&rsquo;s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (&quot;true&quot;)- which is the default - or be hidden.</description>
|
|
</item>
|
|
<item>
|
|
<title>Mermaid</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/</guid>
|
|
<description>Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.
|
|
Usage Just insert your Mermaid code in the mermaid shortcode like this:
|
|
{{&lt; mermaid [ align=(&#34;left&#34;|&#34;right&#34;|&#34;center&#34;|&#34;justify&#34;) ] &gt;}} classDiagram Person *-- Dog {{&lt; /mermaid &gt;}} You can set an optional align attribute which defaults to &quot;center&quot;.
|
|
If you don&rsquo;t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.</description>
|
|
</item>
|
|
<item>
|
|
<title>Notice</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/</guid>
|
|
<description>The notice shortcode shows four types of disclaimers to help you structure your page.
|
|
Usage {{% notice ( note | info | tip | warning ) [ &lt;string&gt; ] %}} Some markup {{% /notice %}} The first parameter is required and indicates the type of notice.
|
|
The second parameter is optional. If provided, it will be used as the title of the notice. If not provided, then the type of notice will be used as the title.</description>
|
|
</item>
|
|
<item>
|
|
<title>Site param</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/</guid>
|
|
<description>The siteparam shortcode is used to help you print values of site params.
|
|
Usage {{% siteparam &lt;string&gt; %}} The first required parameter is the name of the site param to be displayed.
|
|
Examples For instance, in this current site, the editURL variable is used in config.toml
|
|
[params] editURL = &#34;https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/&#34; Use the siteparam shortcode to display its value.
|
|
`editURL` Value : {{% siteparam &#34;editURL&#34; %}} is displayed as
|
|
editURL Value : https://github.</description>
|
|
</item>
|
|
<item>
|
|
<title>Tabbed views</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/</guid>
|
|
<description>Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in 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> |