mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 17:53:07 +00:00
102 lines
No EOL
9.1 KiB
XML
102 lines
No EOL
9.1 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>The children shortcode lists the child pages of a page and its descendants .
|
|
Usage {{% children %}} Parameter Name Default Notes page &lt;current&gt; Specify the page name (section name) to display children for. containerstyle ul Choose the style used to group all children. It could be any HTML tag name. style li Choose the style used to display each descendant. It could be any HTML tag name. showhidden false When true, child pages hidden from the menu will be displayed aswell.</description>
|
|
</item>
|
|
<item>
|
|
<title>Swagger</title>
|
|
<link>https://McShelby.github.io/hugo-theme-relearn/shortcodes/swagger/</link>
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
<guid>https://McShelby.github.io/hugo-theme-relearn/shortcodes/swagger/</guid>
|
|
<description>This shortcode uses the RapiDoc library to display your Swagger / OpenAPI Specifications.
|
|
Note This only works in modern browsers.
|
|
Usage {{&lt; swagger src=&#34;https://petstore3.swagger.io/api/v3/openapi.json&#34; &gt;}} Parameter Name Default Notes src &lt;empty&gt; The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle. Configuration Swagger is configured with default settings. You can customize Swagger&rsquo;s default settings for all of your files thru a JSON object in your config.</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 with adjustable color, title and icon.
|
|
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 {{% attachments /%}} The shortcurt lists files found in a specific folder.
|
|
Currently, it supports 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>The button shortcode displays a clickable button with adjustable color, title and icon.
|
|
Get Hugo Get Hugo Usage {{% button href=&#34;https://gohugo.io/&#34; %}}Get Hugo{{% /button %}} {{% button href=&#34;https://gohugo.io/&#34; style=&#34;warning&#34; icon=&#34;dragon&#34; %}}Get Hugo{{% /button %}} Once the button is clicked, it opens another browser tab for the given URL.
|
|
Parameter Name Default Notes href &lt;empty&gt; The destination URL for the button. If this parameter is not set, the button will do nothing but is still displayed as clickable.</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.
|
|
Expand me... Thank you! Usage While the examples are using named parameter you are free to use positional aswell.
|
|
named positional {{% expand title=&#34;Expand me...&#34; %}}Thank you!{{% /expand %}} {{% expand &#34;Expand me...&#34; %}}Thank you!{{% /expand %}} Parameter Name Position Default Notes title 1 &quot;Expand me...&quot; Arbitray text to appear next to the expand/collapse icon. open 2 false When true the content text will be initially shown as expanded.</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 page.
|
|
Usage While the examples are using named parameter you are free to use positional aswell.
|
|
named positional {{% include file=&#34;shortcodes/INCLUDE_ME.md&#34; %}} {{% include &#34;shortcodes/INCLUDE_ME.md&#34; %}} The included files can even contain Markdown and will be taken into account when generating the table of contents.
|
|
Parameter Name Position Default Notes file 1 &lt;empty&gt; The path to the file to be included.</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>With the Mermaid library and shortcode, you can generate diagrams and flowcharts from text, in a similar manner as Markdown.
|
|
graph LR; If --> Then Then --> Else Note This only works in modern browsers.
|
|
Warning Due to limitations with Mermaid, it is currently not possible to use Mermaid code fences in an initially collapsed expand shortcode. This is a know issue and can&rsquo;t be fixed by this theme.
|
|
Usage The generated graphs can be be panned by dragging them and zoomed by using the mousewheel.</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 various types of disclaimers with adjustable color, title and icon to help you structure your page.
|
|
There may be pirates It is all about the boxes.
|
|
Usage While the examples are using named parameter you are free to use positional aswell.
|
|
named positional {{% notice style=&#34;primary&#34; title=&#34;There may be pirates&#34; icon=&#34;skull-crossbones&#34; %}} It is all about the boxes. {{% /notice %}} {{% notice primary &#34;There may be pirates&#34; &#34;skull-crossbones&#34; %}} It is all about the boxes.</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 prints values of site params.
|
|
Usage While the examples are using named parameter you are free to use positional aswell.
|
|
named positional {{% siteparam name=&#34;editURL&#34; %}} {{% siteparam &#34;editURL&#34; %}} Parameter Name Position Default Notes name 1 &lt;empty&gt; The name of the site param to be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=&#34;editURL&#34; %}} 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/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>The tabs shortcode displays arbitrary content in unlimited number of tabs. This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.
|
|
python bash print(&#34;Hello World!&#34;) echo &#34;Hello World!&#34; Usage {{&lt; tabs &gt;}} {{% tab name=&#34;python&#34; %}} ```python print(&#34;Hello World!&#34;) ``` {{% /tab %}} {{% tab name=&#34;bash&#34; %}} ```bash echo &#34;Hello World!&#34; ``` {{% /tab %}} {{&lt; /tabs &gt;}} Parameter Name Default Notes groupId default Arbitrary name of the group the tab view belongs to.</description>
|
|
</item>
|
|
</channel>
|
|
</rss> |