2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2023-11-12 12:44:57 +00:00
< meta name = "generator" content = "Hugo 0.120.4" >
2023-11-03 22:37:57 +00:00
< meta name = "generator" content = "Relearn 5.23.2+tip" >
2022-06-05 17:32:37 +00:00
< meta name = "description" content = "Get value of site params" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< 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 = "SiteParam :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "Get value of site params" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "SiteParam :: Hugo Relearn Theme" >
< meta property = "og:description" content = "Get value of site params" >
< meta property = "og:type" content = "article" >
2023-10-11 15:42:11 +00:00
< meta property = "og:url" content = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" >
2023-10-11 15:32:39 +00:00
< meta property = "og:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "article:section" content = "Shortcodes :: Hugo Relearn Theme" >
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2023-07-26 20:30:13 +00:00
< title > SiteParam :: Hugo Relearn Theme< / title >
2023-01-25 11:42:06 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel = "alternate" hreflang = "en" >
2023-11-28 21:01:15 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html" rel = "alternate" hreflang = "art-pir" >
2023-07-26 20:30:13 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel = "canonical" type = "text/html" title = "SiteParam :: Hugo Relearn Theme" >
< link href = "../../shortcodes/siteparam/index.xml" rel = "alternate" type = "application/rss+xml" title = "SiteParam :: Hugo Relearn Theme" >
2023-11-29 20:52:48 +00:00
< link href = "../../images/logo.svg?1701291161" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-11-29 20:52:48 +00:00
< link href = "../../css/fontawesome-all.min.css?1701291162" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1701291162" rel = "stylesheet" > < / noscript >
< link href = "../../css/nucleus.css?1701291162" rel = "stylesheet" >
< link href = "../../css/auto-complete.css?1701291162" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1701291162" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1701291162" rel = "stylesheet" >
< link href = "../../css/fonts.css?1701291162" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1701291162" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1701291162" rel = "stylesheet" >
< link href = "../../css/theme-relearn-auto.css?1701291162" rel = "stylesheet" id = "R-variant-style" >
< link href = "../../css/chroma-relearn-auto.css?1701291162" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "../../css/variant.css?1701291162" rel = "stylesheet" >
< link href = "../../css/print.css?1701291162" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1701291162" rel = "stylesheet" >
< link href = "../../css/ie.css?1701291162" rel = "stylesheet" >
< script src = "../../js/url.js?1701291162" > < / script >
< script src = "../../js/variant.js?1701291162" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
// variant stuff
2023-11-23 00:05:57 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// 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}"`;
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../shortcodes/siteparam/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< 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)" >
2023-09-12 21:10:21 +00:00
< i class = "fa-fw fas fa-bars" > < / i >
< / button >
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2023-09-26 20:26:46 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "../../shortcodes/index.html" > < span itemprop = "name" > Shortcodes< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > SiteParam< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
< main id = "R-body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-07-26 20:30:13 +00:00
< h1 id = "siteparam" > SiteParam< / h1 >
2022-07-05 22:16:52 +00:00
2022-06-05 17:32:37 +00:00
< p > The < code > siteparam< / code > shortcode prints values of site params.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.< / p >
2022-06-05 17:32:37 +00:00
2023-07-27 15:06:14 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
2023-06-06 17:55:15 +00:00
< div class = "tab-nav-title" > ​ < / div >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > shortcode< / span >
2023-06-04 22:28:49 +00:00
< / button >
2022-06-05 17:32:37 +00:00
< button
2023-09-05 11:10:04 +00:00
data-tab-item="shortcode-positional"
2023-06-06 16:16:06 +00:00
class="tab-nav-button tab-panel-style cstyle initial"
2023-09-05 11:10:04 +00:00
onclick="switchTab('shortcode-parameter','shortcode-positional')"
2023-01-29 16:05:10 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > shortcode (positional)< / span >
2023-06-04 22:28:49 +00:00
< / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-06-06 16:16:06 +00:00
class="tab-nav-button tab-panel-style cstyle initial"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > partial< / span >
2023-06-04 22:28:49 +00:00
< / button >
2022-06-05 17:32:37 +00:00
< / div >
2023-06-05 16:33:00 +00:00
< div class = "tab-content-container" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-06-06 16:16:06 +00:00
class="tab-content tab-panel-style cstyle initial active">
2023-06-05 16:33:00 +00:00
< div class = "tab-content-text" >
2023-06-04 22:25:27 +00:00
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
2023-06-05 16:33:00 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
2023-09-05 11:10:04 +00:00
data-tab-item="shortcode-positional"
2023-06-06 16:16:06 +00:00
class="tab-content tab-panel-style cstyle initial">
2023-06-05 16:33:00 +00:00
< div class = "tab-content-text" >
2023-06-04 22:25:27 +00:00
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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" > siteparam< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
2023-06-05 16:33:00 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-06-06 16:16:06 +00:00
class="tab-content tab-panel-style cstyle initial">
2023-06-05 16:33:00 +00:00
< div class = "tab-content-text" >
2023-06-04 22:25:27 +00:00
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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/siteparam.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
2023-07-27 15:06:14 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " page" < / span > < span class = "p" > .< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " editURL" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
2023-06-05 16:33:00 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
2023-07-27 15:06:14 +00:00
< th > Name< / th >
< th > Position< / th >
< th > Default< / th >
< th > Notes< / th >
2022-06-05 17:32:37 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2023-07-27 15:06:14 +00:00
< td > < strong > name< / strong > < / td >
< td > 1< / td >
< td > < em > < empty> < / em > < / td >
< td > The name of the site param to be displayed.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "editurl-from-configtoml" > < code > editURL< / code > from < code > config.toml< / code > < / h3 >
2023-10-28 20:28:18 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "s" > `editURL`< / span > < span class = "nx" > value< / span > < span class = "p" > :< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < / span > < / span > < / code > < / pre > < / div > < p > < code > editURL< / code > value: < a href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" target = "_blank" > https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/< / a > < / p >
2023-07-26 20:30:13 +00:00
< h3 id = "nested-parameter-with-markdown-and-html-formatting" > Nested parameter with Markdown and HTML formatting< / h3 >
< p > To use formatted parameter, add this in your < code > config.toml< / code > :< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > markup< / span > < span class = "p" > .< / span > < span class = "nx" > goldmark< / span > < span class = "p" > .< / span > < span class = "nx" > renderer< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > unsafe< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
2023-11-29 20:52:48 +00:00
< div class = "tab-panel" data-tab-group = "e7b6087c51c6e70cbdc20ce50f0a567c" >
2023-07-26 20:30:13 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="configtoml"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2023-11-29 20:52:48 +00:00
onclick="switchTab('e7b6087c51c6e70cbdc20ce50f0a567c','configtoml')"
2023-07-26 20:30:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > config.toml< / span >
2023-07-26 20:30:13 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="configtoml"
2023-07-26 20:30:13 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > .< / span > < span class = "nx" > siteparam< / span > < span class = "p" > .< / span > < span class = "nx" > test< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > text< / span > < span class = "p" > =< / span > < span class = "s2" > " A **nested** parameter < b> with< /b> formatting" < / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div >
2023-11-15 23:21:36 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "nx" > Formatted< / span > < span class = "nx" > parameter< / span > < span class = "p" > :< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " siteparam.test.text" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < / span > < / span > < / code > < / pre > < / div > < p > Formatted parameter: A < strong > nested< / strong > option < b> with< /b> formatting< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
2022-04-02 13:30:16 +00:00
< / div >
< / main >
< / div >
2023-11-29 20:52:48 +00:00
< script src = "../../js/clipboard.min.js?1701291162" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1701291162" defer > < / script >
< script src = "../../js/theme.js?1701291162" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
