2024-02-29 19:46:39 +00:00
<!DOCTYPE html>
< html lang = "art-pir" dir = "rtl" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-03-16 19:25:10 +00:00
< meta name = "generator" content = "Hugo 0.124.0" >
2024-03-17 13:03:56 +00:00
< meta name = "generator" content = "Relearn 5.26.1+tip" >
2024-02-29 19:46:39 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
< 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 :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "Attachments hugo . png ( 17 KB ) MaybeTreasure . txt ( 31 B ) NoTreasure . en . txt ( 23 B ) Treasure . pir . txt ( 31 B ) Th & # 39 ; resources shortcode displays th & # 39 ; titles o & # 39 ; resources contained & # 39 ; n a plank bundle .
Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While th' examples be us' n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.
​ shortcode partial {{% resources sort=" asc" /%}} {{ partial " shortcodes/resources.">
< meta property = "og:title" content = "Resources :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "Attachments hugo . png ( 17 KB ) MaybeTreasure . txt ( 31 B ) NoTreasure . en . txt ( 23 B ) Treasure . pir . txt ( 31 B ) Th & # 39 ; resources shortcode displays th & # 39 ; titles o & # 39 ; resources contained & # 39 ; n a plank bundle .
Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While th' examples be us' n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.
​ shortcode partial {{% resources sort=" asc" /%}} {{ partial " shortcodes/resources.">
< meta property = "og:type" content = "article" >
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html" >
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "article:section" content = "Shorrrtcodes :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
< title > Resources :: Cap' n Hugo Relearrrn 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-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html" rel = "canonical" type = "text/html" title = "Resources :: Cap'n Hugo Relearrrn Theme" >
< link href = "/hugo-theme-relearn/pir/shortcodes/resources/index.xml" rel = "alternate" type = "application/rss+xml" title = "Resources :: Cap'n Hugo Relearrrn Theme" >
2024-03-18 20:59:19 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1710795554" rel = "icon" type = "image/svg+xml" >
2024-02-29 19:46:39 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2024-03-18 20:59:19 +00:00
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710795556" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710795556" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1710795556" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1710795556" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1710795556" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1710795556" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1710795556" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1710795556" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1710795556" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1710795556" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1710795556" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/variant.css?1710795556" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/print.css?1710795556" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1710795556" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/ie.css?1710795556" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/url.js?1710795556" > < / script >
< script src = "/hugo-theme-relearn/js/variant.js?1710795556" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2024-02-29 19:46:39 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-03-16 12:40:13 +00:00
window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
2024-02-29 19:46:39 +00:00
// variant stuff
window.relearn.themeVariantModifier='';
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
// translations
window.T_Copy_to_clipboard = `Copy t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
< / script >
< style >
#R-body img.bg-white {
background-color: white;
}
< / style >
< / head >
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/pir/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/pir/shortcodes/index.html" > < span itemprop = "name" > Shorrrtcodes< / 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 >
< / 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 >
< 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/pir/shortcodes/resources/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/MaybeTreasure.pir.txt" > MaybeTreasure.txt< / a > (31 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/NoTreasure.en.txt" > NoTreasure.en.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/Treasure.pir.txt" > Treasure.pir.txt< / a > (31 B)< / li >
< / ul >
< / div >
< p > Th' < code > resources< / code > shortcode displays th' < a href = "https://gohugo.io/methods/resource/title/" target = "_blank" > titles< / a > o' resources contained 'n a < a href = "https://gohugo.io/content-management/page-bundles/" target = "_blank" > plank 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/pir/shortcodes/resources/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/MaybeTreasure.en.txt" > MaybeTreasure.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/NoTreasure.en.txt" > NoTreasure.en.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/Treasure.pir.txt" > Treasure.pir.txt< / a > (31 B)< / li >
< / ul >
< / div >
< h2 id = "usage" > Usage< / h2 >
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer 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" >
2024-03-11 20:44:09 +00:00
< 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 >
2024-02-29 19:46:39 +00:00
< / div >
< div
data-tab-item="partial"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< 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 >
2024-02-29 19:46:39 +00:00
< / 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 be not supported directly by th' shortcode but rely on Hugo’ s handl'n fer resource translat'ns applied when th' theme iterates over all avail'ble resources.< / p >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default< / th >
< th > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < strong > style< / strong > < / td >
< td > < code > transparent< / code > < / td >
< td > Th' style scheme used fer th' box.< br > < br > - by severity: < 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 > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > , < code > code< / code > < / td >
< / tr >
< tr >
< td > < strong > color< / strong > < / td >
< td > see notes< / td >
< td > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > t' be used. If not set, th' chosen color depends on th' < strong > style< / strong > . Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n color fer th' severity< br > - fer all other styles: th' correspond'n color< / td >
< / tr >
< tr >
< td > < strong > title< / strong > < / td >
< td > see notes< / td >
< td > Arbitrary text fer th' box title. Depend'n on th' < strong > style< / strong > there may be a default title. Any given value will overwrite th' default.< br > < br > - fer severity styles: th' match'n title fer th' severity< br > - fer all other styles: < code > Resources< / code > < br > < br > If ye want no title fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
< / tr >
< tr >
< td > < strong > ay'con< / strong > < / td >
< td > see notes< / td >
< td > < a href = "/hugo-theme-relearn/pir/shortcodes/icon/index.html#finding-an-icon" > Font Awesome ay'con name< / a > set t' th' left o' th' title. Depend'n on th' < strong > style< / strong > there may be a default ay'con. Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n ay'con fer th' severity< br > - fer all other styles: < code > paperclip< / code > < br > < br > If ye want no ay'con, ye have t' set this parameter t' < code > " " < / code > (a non empty d wit' spaces)< / td >
< / tr >
< tr >
< td > < strong > sort< / strong > < / td >
< td > < code > asc< / code > < / td >
< td > Sort'n th' output 'n < code > asc< / code > end'n or < code > desc< / code > end'n order.< / td >
< / tr >
< tr >
< td > < strong > pattern< / strong > < / td >
< td > < code > .*< / code > < / td >
< td > A < a href = "https://en.wikipedia.org/wiki/Regular_expression" target = "_blank" > regular expressions< / a > , used t' filter th' resources < a href = "https://gohugo.io/methods/resource/name/" target = "_blank" > by name< / a > . For example:< br > < br > - t' match a file suffix o' ‘ jpg’ , use < code > .*\.jpg< / code > (not < code > *.\.jpg< / code > )< br > - t' match file names end'n 'n < 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 o' Resources End'n 'n png, jpg or gif< / h3 >
2024-03-11 20:44:09 +00:00
< 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 >
2024-02-29 19:46:39 +00:00
< 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/pir/shortcodes/resources/hugo.png" > hugo.png< / a > (17 KB)< / li >
< / ul >
< / div >
< h3 id = "info-styled-box-descending-sort-order" > Ahoi Styled Box, Descend'n Sort Order< / h3 >
2024-03-11 20:44:09 +00:00
< 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 >
2024-02-29 19:46:39 +00:00
< div class = "box attachments cstyle info" >
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / div >
< ul class = "box-content attachments-files" >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/Treasure.pir.txt" > Treasure.pir.txt< / a > (31 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/NoTreasure.en.txt" > NoTreasure.en.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/MaybeTreasure.en.txt" > MaybeTreasure.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/hugo.png" > hugo.png< / a > (17 KB)< / li >
< / ul >
< / div >
< h3 id = "with-user-defined-color-and-font-awesome-brand-icon" > Wit' User-Defined Color an' Font Awesome Brand Ay'con< / h3 >
2024-03-11 20:44:09 +00:00
< 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" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span > < / span > < / span > < / code > < / pre > < / div >
2024-02-29 19:46:39 +00:00
< div class = "box attachments cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< div class = "box-label" > < i class = "fab fa-hackerrank" > < / i > Attachments< / div >
< ul class = "box-content attachments-files" >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/MaybeTreasure.en.txt" > MaybeTreasure.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/NoTreasure.en.txt" > NoTreasure.en.txt< / a > (23 B)< / li >
< li > < a href = "/hugo-theme-relearn/pir/shortcodes/resources/Treasure.pir.txt" > Treasure.pir.txt< / a > (31 B)< / li >
< / ul >
< / div >
< h3 id = "style-color-title-and-icons" > Style, Color, Title an' Ay'cons< / h3 >
< p > For further examples fer < strong > style< / strong > , < strong > color< / strong > , < strong > title< / strong > an' < strong > ay'con< / strong > , see th' < a href = "/hugo-theme-relearn/pir/shortcodes/notice/index.html" > < code > notice< / code > shortcode< / a > documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.< / p >
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2024-03-18 20:59:19 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1710795556" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1710795556" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1710795556" defer > < / script >
2024-02-29 19:46:39 +00:00
< / body >
< / html >