<!DOCTYPE html> <html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article"> <head> <meta charset="utf-8"> <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0"> <meta name="generator" content="Hugo 0.134.0"> <meta name="generator" content="Relearn 6.3.0+tip"> <meta name="description" content="List resources contained in a page bundle"> <meta name="author" content="Sören Weber"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta name="twitter:title" content="Resources :: Hugo Relearn Theme"> <meta name="twitter:description" content="List resources contained in a page bundle"> <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html"> <meta property="og:site_name" content="Hugo Relearn Theme"> <meta property="og:title" content="Resources :: Hugo Relearn Theme"> <meta property="og:description" content="List resources contained in a page bundle"> <meta property="og:locale" content="en"> <meta property="og:type" content="article"> <meta property="article:section" content="Shortcodes"> <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="name" content="Resources :: Hugo Relearn Theme"> <meta itemprop="description" content="List resources contained in a page bundle"> <meta itemprop="wordCount" content="473"> <meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <title>Resources :: Hugo Relearn Theme</title> <link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html" rel="alternate" hreflang="x-default"> <link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html" rel="alternate" hreflang="en"> <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html" rel="alternate" hreflang="art-x-pir"> <link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html" rel="canonical" type="text/html" title="Resources :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/shortcodes/resources/index.xml" rel="alternate" type="application/rss+xml" title="Resources :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/images/logo.svg?1725397358" rel="icon" type="image/svg+xml"> <link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1725397358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1725397358" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/nucleus.css?1725397358" rel="stylesheet"> <link href="/hugo-theme-relearn/css/auto-complete.css?1725397358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1725397358" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1725397358" rel="stylesheet"> <link href="/hugo-theme-relearn/css/fonts.css?1725397358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1725397358" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/theme.css?1725397358" rel="stylesheet"> <link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1725397358" rel="stylesheet" id="R-variant-style"> <link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1725397358" rel="stylesheet" id="R-variant-chroma-style"> <link href="/hugo-theme-relearn/css/variant.css?1725397358" rel="stylesheet"> <link href="/hugo-theme-relearn/css/print.css?1725397358" rel="stylesheet" media="print"> <link href="/hugo-theme-relearn/css/format-print.css?1725397358" rel="stylesheet"> <script src="/hugo-theme-relearn/js/variant.js?1725397358"></script> <script> window.relearn = window.relearn || {}; window.relearn.relBasePath='..\/..'; window.relearn.relBaseUri='..\/..\/..'; window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn'; window.relearn.disableAnchorCopy=false; window.relearn.disableAnchorScrolling=false; window.index_js_url="/hugo-theme-relearn/index.search.js?1725397358"; // variant stuff window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] ); // translations window.T_Copy_to_clipboard = `Copy to clipboard`; window.T_Copied_to_clipboard = `Copied to clipboard!`; window.T_Copy_link_to_clipboard = `Copy link to clipboard`; window.T_Link_copied_to_clipboard = `Copied link to clipboard!`; window.T_Reset_view = `Reset view`; window.T_View_reset = `View reset!`; window.T_No_results_found = `No results found for "{0}"`; window.T_N_results_found = `{1} results found for "{0}"`; </script> <style> #R-body img.bg-white { background-color: white; } </style> </head> <body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/shortcodes/resources/index.html"> <div id="R-body" class="default-animation"> <div id="R-body-overlay"></div> <nav id="R-topbar"> <div class="topbar-wrapper"> <div class="topbar-sidebar-divider"></div> <div class="topbar-area topbar-area-start" data-area="start"> <div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button> </div> </div> <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="1"> > </li><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Resources</span><meta itemprop="position" content="2"></li> </ol> <div class="topbar-area topbar-area-end" data-area="end"> <div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/openapi/index.html" title="OpenAPI (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a> </div> <div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/siteparam/index.html" title="SiteParam (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a> </div> </div> </div> </nav> <div id="R-main-overlay"></div> <main id="R-body-inner" class="highlightable default" tabindex="-1"> <div class="flex-block-wrapper"> <article class="default"> <header class="headline"> </header> <h1 id="resources">Resources</h1> <p>The <code>resources</code> shortcode displays the <a href="https://gohugo.io/methods/resource/title/" rel="external" target="_self">titles</a> of resources contained in a <a href="https://gohugo.io/content-management/page-bundles/" rel="external" target="_self">page bundle</a>.</p> <div class="box attachments cstyle transparent"> <div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div> <ul class="box-content attachments-files"> <li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li> </ul> </div> <h2 id="usage">Usage</h2> <p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p> <div class="tab-panel" data-tab-group="shortcode-parameter"> <div class="tab-nav"> <div class="tab-nav-title">​</div> <button data-tab-item="shortcode" class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1" onclick="switchTab('shortcode-parameter','shortcode')" > <span class="tab-nav-text">shortcode</span> </button> <button data-tab-item="partial" class="tab-nav-button tab-panel-style cstyle initial" onclick="switchTab('shortcode-parameter','partial')" > <span class="tab-nav-text">partial</span> </button> </div> <div class="tab-content-container"> <div data-tab-item="shortcode" class="tab-content tab-panel-style cstyle initial active"> <div class="tab-content-text"> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"asc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div></div> </div> <div data-tab-item="partial" class="tab-content tab-panel-style cstyle initial"> <div class="tab-content-text"> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/resources.html"</span> <span class="p">(</span><span class="nx">dict</span> </span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span> </span></span><span class="line"><span class="cl"> <span class="s">"sort"</span> <span class="s">"asc"</span> </span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div> </div> </div> </div> <p>Multilanguage features are not supported directly by the shortcode but rely on Hugo’s handling for resource translations applied when the theme iterates over all available resources.</p> <h3 id="parameter">Parameter</h3> <table> <thead> <tr> <th style="text-align: left">Name</th> <th style="text-align: left">Default</th> <th style="text-align: left">Notes</th> </tr> </thead> <tbody> <tr> <td style="text-align: left"><strong>style</strong></td> <td style="text-align: left"><code>transparent</code></td> <td style="text-align: left">The style scheme used for the box.<br><br>- by severity: <code>caution</code>, <code>important</code>, <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>cyan</code>, <code>green</code>, <code>grey</code>, <code>magenta</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td> </tr> <tr> <td style="text-align: left"><strong>color</strong></td> <td style="text-align: left">see notes</td> <td style="text-align: left">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_self">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td> </tr> <tr> <td style="text-align: left"><strong>title</strong></td> <td style="text-align: left">see notes</td> <td style="text-align: left">Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <code>Resources</code><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td> </tr> <tr> <td style="text-align: left"><strong>icon</strong></td> <td style="text-align: left">see notes</td> <td style="text-align: left"><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <code>paperclip</code><br><br>If you want no icon, you have to set this parameter to <code>" "</code> (a non empty d with spaces)</td> </tr> <tr> <td style="text-align: left"><strong>sort</strong></td> <td style="text-align: left"><code>asc</code></td> <td style="text-align: left">Sorting the output in <code>asc</code>ending or <code>desc</code>ending order.</td> </tr> <tr> <td style="text-align: left"><strong>pattern</strong></td> <td style="text-align: left"><code>.*</code></td> <td style="text-align: left">A <a href="https://en.wikipedia.org/wiki/Regular_expression" rel="external" target="_self">regular expressions</a>, used to filter the resources <a href="https://gohugo.io/methods/resource/name/" rel="external" target="_self">by name</a>. For example:<br><br>- to match a file suffix of ‘jpg’, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- to match file names ending in <code>jpg</code> or <code>png</code>, use <code>.*\.(jpg|png)</code></td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <h3 id="custom-title-list-of-resources-ending-in-png-jpg-or-gif">Custom Title, List of Resources Ending in png, jpg or gif</h3> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Related **files**"</span> <span class="nx">pattern</span><span class="p">=</span><span class="s">".*\.(png|jpg|gif)"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div> <div class="box attachments cstyle transparent"> <div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related <strong>files</strong></div> <ul class="box-content attachments-files"> <li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li> </ul> </div> <h3 id="info-styled-box-descending-sort-order">Info Styled Box, Descending Sort Order</h3> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"desc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div> <div class="box attachments cstyle info"> <div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div> <ul class="box-content attachments-files"> <li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li> </ul> </div> <h3 id="with-user-defined-color-and-font-awesome-brand-icon">With User-Defined Color and Font Awesome Brand Icon</h3> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div> <div class="box attachments cstyle default" style="--VARIABLE-BOX-color: fuchsia;"> <div class="box-label"><i class="fa-fw fab fa-hackerrank"></i> Attachments</div> <ul class="box-content attachments-files"> <li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li> <li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li> </ul> </div> <h3 id="style-color-title-and-icons">Style, Color, Title and Icons</h3> <p>For further examples for <strong>style</strong>, <strong>color</strong>, <strong>title</strong> and <strong>icon</strong>, see the <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p> <footer class="footline"> </footer> </article> </div> </main> </div> <script src="/hugo-theme-relearn/js/clipboard.min.js?1725397358" defer></script> <script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1725397358" defer></script> <script src="/hugo-theme-relearn/js/theme.js?1725397358" defer></script> </body> </html>