hugo-theme-relearn/shortcodes/include/index.print.html
2023-06-15 22:17:05 +00:00

209 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.113.0">
<meta name="generator" content="Relearn 5.16.2+tip">
<meta name="description" content="Displays content from other files">
<meta name="author" content="Sören Weber">
<title>Include :: Hugo Relearn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/include/index.html" rel="alternate" hreflang="pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/index.html" rel="canonical" type="text/html" title="Include :: Hugo Relearn Theme">
<link href="../../shortcodes/include/index.xml" rel="alternate" type="application/rss+xml" title="Include :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1686867416" 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?1686867418" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1686867418" rel="stylesheet"></noscript>
<link href="../../css/nucleus.css?1686867418" rel="stylesheet">
<link href="../../css/auto-complete.css?1686867418" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1686867418" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1686867418" rel="stylesheet">
<link href="../../css/fonts.css?1686867418" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1686867418" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1686867418" rel="stylesheet">
<link href="../../css/theme-auto.css?1686867418" rel="stylesheet" id="variant-style">
<link href="../../css/variant.css?1686867418" rel="stylesheet">
<link href="../../css/print.css?1686867418" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1686867418" rel="stylesheet">
<link href="../../css/ie.css?1686867418" rel="stylesheet">
<script src="../../js/url.js?1686867418"></script>
<script src="../../js/variant.js?1686867418"></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( [ 'auto', 'relearn-bright', '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/include/index.html">
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable">
<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"> &gt; </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"> &gt; </li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Include</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">
<article class="default">
<header class="headline">
</header>
<h1 id="include">Include</h1>
<p>The <code>include</code> shortcode includes other files from your project inside of the current page.</p>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.</p>
<div class="tab-panel" data-tab-group="7f21b38b8224c6a4103699423c237dd2">
<div class="tab-nav">
<div class="tab-nav-title">&#8203;</div>
<button
data-tab-item="shortcode"
class="tab-nav-button tab-panel-style cstyle initial active"
onclick="switchTab('7f21b38b8224c6a4103699423c237dd2','shortcode')"
>
<div>
<div class="tab-nav-hidden">shortcode</div>
<div class="tab-nav-text">shortcode</div>
</div>
</button>
<button
data-tab-item="shortcode (positional)"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('7f21b38b8224c6a4103699423c237dd2','shortcode (positional)')"
>
<div>
<div class="tab-nav-hidden">shortcode (positional)</div>
<div class="tab-nav-text">shortcode (positional)</div>
</div>
</button>
<button
data-tab-item="partial"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('7f21b38b8224c6a4103699423c237dd2','partial')"
>
<div>
<div class="tab-nav-hidden">partial</div>
<div class="tab-nav-text">partial</div>
</div>
</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"><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">include</span> <span class="nx">file</span><span class="p">=</span><span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div></div>
</div>
<div
data-tab-item="shortcode (positional)"
class="tab-content tab-panel-style cstyle initial">
<div class="tab-content-text">
<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">include</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</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"><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/include .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;file&#34;</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div></div>
</div>
</div>
</div>
<p>The included files can even contain Markdown and will be taken into account when generating the table of contents.</p>
<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>file</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 path to the file to be included. Path resolution adheres to <a href="https://gohugo.io/functions/readfile/" target="_blank">Hugo&rsquo;s build-in <code>readFile</code> function</a></td>
</tr>
<tr>
<td style="text-align:left"><strong>hidefirstheading</strong></td>
<td style="text-align:left">2</td>
<td style="text-align:left"><code>false</code></td>
<td style="text-align:left">When <code>true</code> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="arbitrary-content">Arbitrary Content</h3>
<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">include</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>You can add standard markdown syntax:</p>
<ul>
<li>multiple paragraphs</li>
<li>bullet point lists</li>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><a href="https://example.com" target="_blank">links</a></li>
<li>etc.<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></li>
</ul>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code
</span></span></code></pre></div><blockquote>
<p>the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
</blockquote>
<div class="footnotes" role="doc-endnotes">
<hr>
<ol>
<li id="fn:1">
<p>Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean &ldquo;and other similar things&rdquo;, or &ldquo;and so forth&rdquo;&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p>
</li>
</ol>
</div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../js/clipboard.min.js?1686867418" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1686867418" defer></script>
<script src="../../js/theme.js?1686867418" defer></script>
</body>
</html>