hugo-theme-relearn/shortcodes/siteparam/index.print.html

166 lines
9.6 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en" dir="ltr">
<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.110.0">
<meta name="generator" content="Relearn 5.10.2+tip">
<meta name="description" content="Get value of site params">
<meta name="author" content="Sören Weber">
<title>Site param :: Hugo Relearn Theme</title>
<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">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html" rel="alternate" hreflang="pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel="canonical" type="text/html" title="Site param :: Hugo Relearn Theme">
<link href="../../shortcodes/siteparam/index.xml" rel="alternate" type="application/rss+xml" title="Site param :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1675526020" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../css/fontawesome-all.min.css?1675526022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1675526022" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1675526022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1675526022" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1675526022" rel="stylesheet">
<link href="../../css/nucleus.css?1675526022" rel="stylesheet">
<link href="../../css/fonts.css?1675526022" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1675526022" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1675526022" rel="stylesheet">
<link href="../../css/theme-relearn-light.css?1675526022" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1675526022" rel="stylesheet">
<link href="../../css/variant.css?1675526022" rel="stylesheet">
<link href="../../css/print.css?1675526022" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1675526022" rel="stylesheet">
<script src="../../js/url.js?1675526022"></script>
<script src="../../js/variant.js?1675526022"></script>
<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
window.index_js_url="../../index.search.js";
var root_url="../../";
var baseUri=root_url.replace(/\/$/, '');
// 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_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
</script>
<style>
#body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../shortcodes/siteparam/index.html">
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
</span>
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
<li 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="2"> > </li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Site param</span><meta itemprop="position" content="3"></li>
</ol>
</div>
</div>
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<h1 id="site-param">Site param</h1>
<p>The <code>siteparam</code> shortcode prints values of site params.</p>
<h2 id="usage">Usage</h2>
<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>
<div class="tab-panel" data-tab-group="shortcode-parameter">
<div class="tab-nav">
<button
data-tab-item="shortcode"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
>
<span>shortcode</span></button>
<button
data-tab-item="shortcode (positional)"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
>
<span>shortcode (positional)</span></button>
<button
data-tab-item="partial"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
>
<span>partial</span></button>
</div>
<div class="tab-content">
<div
data-tab-item="shortcode"
class="tab-item active"
>
<div class="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">&#34;editURL&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div
data-tab-item="shortcode (positional)"
class="tab-item "
>
<div class="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">&#34;editURL&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div
data-tab-item="partial"
class="tab-item "
>
<div class="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">&#34;shortcodes/siteparam.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;name&#34;</span> <span class="s">&#34;editURL&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Position</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>name</strong></td>
<td style="text-align:left">1</td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">The name of the site param to be displayed.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="editurl-from-configtoml"><code>editURL</code> from <code>config.toml</code></h3>
<div class="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">&#34;editURL&#34;</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>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../js/clipboard.min.js?1675526022" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1675526022" defer></script>
<script src="../../js/theme.js?1675526022" defer></script>
</body>
</html>