hugo-theme-relearn/shortcodes/include/index.html

206 lines
25 KiB
HTML
Raw Normal View History

<!doctype html><html lang=en class="js csstransforms3d">
<head>
<meta charset=utf-8>
<meta name=viewport content="width=device-width,initial-scale=1">
<meta name=generator content="Hugo 0.88.1">
<meta name=description content="Displays content from other Markdown files">
<meta name=author content="Sören Weber">
<link rel="shortcut icon" href=../../images/logo.svg?1635620112>
<title>Include :: Documentation for Hugo Relearn Theme</title>
<link href=../../css/nucleus.css?1635620112 rel=stylesheet>
<link href=../../css/fontawesome-all.min.css?1635620112 rel=stylesheet>
<link href=../../css/featherlight.min.css?1635620112 rel=stylesheet>
<link href=../../css/perfect-scrollbar.min.css?1635620112 rel=stylesheet>
<link href=../../css/auto-complete.css?1635620112 rel=stylesheet>
<link href=../../css/theme.css?1635620112 rel=stylesheet>
<link href=../../css/theme-relearn.css?1635620112 rel=stylesheet>
<link href=../../css/variant.css?1635620112 rel=stylesheet>
<link href=../../css/print.css?1635620112 rel=stylesheet media=print>
<script src=../../js/jquery.min.js?1635620112></script>
<style>:root #header+#content>#left>#rlblock_left{display:none!important}</style>
</head>
<body data-url=../../shortcodes/include/>
<nav id=sidebar class=showVisitedLinks>
<div id=header-wrapper>
<div id=header>
<a id=logo href=../../ style="color:#3d414d;font-family:novacento sans wide,helvetica,tahoma,geneva,arial,sans-serif;font-size:30px;font-weight:700;margin-top:-2px"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044" style="height:65px;margin-bottom:-20px;margin-top:-20px;width:65px"><path d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212.0 01-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255s1.706.724 2.068 1.843c.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12.0 01-.499 1.309 1.757 1.757.0 01-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273.0 01-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711.0 00-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style="fill:#3d414d;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/><path d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002.0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447.0 00.303-.437.175.175.0 00.013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547.0 00.353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style="fill:#3d414d;fill-
Relearn
</a>
</div>
<div class=searchbox>
<label for=search-by><i class="fas fa-search"></i></label>
<input data-search-input id=search-by type=search placeholder=Search...>
<span data-search-clear><i class="fas fa-times"></i></span>
</div>
<script src=../../js/lunr.min.js?1635620112></script>
<script src=../../js/auto-complete.js?1635620112></script>
<script>var index_url="../../index.json",root_url="../../",baseUri=root_url.replace(/\/$/,'')</script>
<script src=../../js/search.js?1635620112></script>
</div>
<div class=highlightable>
<ul class=topics>
<li data-nav-id=/basics/ title=Basics class=dd-item><a href=../../basics/><b>1.</b> Basics<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/basics/migration/ title="What's new" class="dd-item alwaysopen"><a href=../../basics/migration/>What's new<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/requirements/ title=Requirements class="dd-item alwaysopen"><a href=../../basics/requirements/>Requirements<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/installation/ title=Installation class="dd-item alwaysopen"><a href=../../basics/installation/>Installation<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/configuration/ title=Configuration class="dd-item alwaysopen"><a href=../../basics/configuration/>Configuration<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/customization/ title=Customization class="dd-item alwaysopen"><a href=../../basics/customization/>Customization<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/history/ title=History class="dd-item alwaysopen"><a href=../../basics/history/>History<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li>
<li data-nav-id=/cont/ title=Content class=dd-item><a href=../../cont/><b>2.</b> Content<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/cont/pages/ title="Pages organization" class="dd-item alwaysopen"><a href=../../cont/pages/>Pages organization<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/cont/archetypes/ title=Archetypes class=dd-item><a href=../../cont/archetypes/>Archetypes<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/markdown/ title="Markdown syntax" class=dd-item><a href=../../cont/markdown/>Markdown syntax<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/syntaxhighlight/ title="Code highlighting" class=dd-item><a href=../../cont/syntaxhighlight/>Code highlighting<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/menushortcuts/ title="Menu extra shortcuts" class=dd-item><a href=../../cont/menushortcuts/>Menu extra shortcuts<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/icons/ title="Icons and logos" class=dd-item><a href=../../cont/icons/>Icons and logos<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/i18n/ title="Multilingual and i18n" class="dd-item alwaysopen"><a href=../../cont/i18n/>Multilingual and i18n<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/cont/tags/ title=Tags class=dd-item><a href=../../cont/tags/>Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
<li data-nav-id=/shortcodes/ title=Shortcodes class="dd-item parent"><a href=../../shortcodes/><b>3.</b> Shortcodes<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/attachments/ title=Attachments class=dd-item><a href=../../shortcodes/attachments/>Attachments<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/button/ title=Button class=dd-item><a href=../../shortcodes/button/>Button<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/children/ title=Children class=dd-item><a href=../../shortcodes/children/>Children<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/test/ title="page X" class=dd-item><a href=../../shortcodes/children/test/>page X<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/children/children-1/ title="page 1" class=dd-item><a href=../../shortcodes/children/children-1/>page 1<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/ title="page 1-1" class=dd-item><a href=../../shortcodes/children/children-1/children-1-1/>page 1-1<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/ title="page 1-1-2" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/>page 1-1-2<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ title="page 1-1-2-1" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/>page 1-1-2-1<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ title="page 1-1-2-2" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/>page 1-1-2-2<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-3/ title="page 1-1-3" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-3/>page 1-1-3<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li></ul></li>
<li data-nav-id=/shortcodes/children/children-2/ title="page 2" class=dd-item><a href=../../shortcodes/children/children-2/>page 2<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/shortcodes/children/children-3/ title="page 3" class=dd-item><a href=../../shortcodes/children/children-3/>page 3<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-3/test3/ title="page 3-1" class=dd-item><a href=../../shortcodes/children/children-3/test3/>page 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
<li data-nav-id=/shortcodes/expand/ title=Expand class=dd-item><a href=../../shortcodes/expand/>Expand<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/include/ title=Include class="dd-item active"><a href=../../shortcodes/include/>Include<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/mermaid/ title=Mermaid class=dd-item><a href=../../shortcodes/mermaid/>Mermaid<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/notice/ title=Notice class=dd-item><a href=../../shortcodes/notice/>Notice<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/siteparam/ title="Site param" class=dd-item><a href=../../shortcodes/siteparam/>Site param<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/tabs/ title="Tabbed views" class=dd-item><a href=../../shortcodes/tabs/>Tabbed views<i class="fas fa-check read-icon"></i></a></li></ul></li>
</ul>
<div id=shortcuts>
<div class=nav-title>More</div>
<ul>
<li><a class=padding href=https://github.com/McShelby/hugo-theme-relearn><i class="fab fa-fw fa-github"></i> GitHub repo</a></li>
<li><a class=padding href=../../showcase/><i class="fas fa-fw fa-camera"></i> Showcases</a></li>
<li><a class=padding href=https://gohugo.io/><i class="fas fa-fw fa-bookmark"></i> Hugo Documentation</a></li>
<li><a class=padding href=../../credits/><i class="fas fa-fw fa-bullhorn"></i> Credits</a></li>
<li><a class=padding href=../../tags/><i class="fas fa-fw fa-tags"></i> Tags</a></li>
</ul>
</div>
<div id=prefooter>
<hr>
<ul>
<li>
<a class=padding>
<i class="fas fa-language fa-fw"></i>
<div class=select-style>
<select id=select-language onchange="location=baseUri+this.value"><option id=en value=/shortcodes/include/ selected>English</option><option id=pir value=/pir/shortcodes/include/>Arrr! Pirrrates</option></select><svg id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="255" height="255" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255"><g><g id="arrow-drop-down"><polygon points="0,63.75 127.5,191.25 255,63.75"/></g></g></svg>
</div>
</a>
</li>
<li><a class=padding href=# data-clear-history-toggle><i class="fas fa-history fa-fw"></i> Clear History</a></li>
</ul>
</div>
<div id=footer>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn/archive/main.zip data-icon=octicon-cloud-download aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn data-icon=octicon-star data-show-count=true aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn/fork data-icon=octicon-repo-forked data-show-count=true aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <a href=https://github.com/McShelby/hugo-theme-relearn><i class="fas fa-heart"></i></a> by <a href=https://gohugo.io/>Hugo</a></p>
<script async defer src=https://buttons.github.io/buttons.js></script>
</div>
</div>
</nav>
<div id=body>
<div id=overlay></div>
<div class="padding highlightable">
<div id=top-bar>
<div id=top-github-link>
<a class=github-link title="Edit this page" href=https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/shortcodes/include.en.md target=blank>
<i class="fas fa-code-branch"></i>
<span id=top-github-link-text>Edit this page</span>
</a>
</div>
<div id=breadcrumbs>
<span id=sidebar-toggle-span>
<a href=# id=sidebar-toggle data-sidebar-toggle>
<i class="fas fa-bars"></i>
</a>
</span>
<span id=toc-menu><i class="fas fa-list-alt"></i></span>
<ol class=links itemscope itemtype=http://schema.org/BreadcrumbList>
<meta itemprop=itemListOrder content="Descending">
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="3"><a itemprop=item href=../../><span itemprop=name>Relearn Theme for Hugo</span></a> > </li>
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="2"><a itemprop=item href=../../shortcodes/><span itemprop=name>Shortcodes</span></a> > </li>
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="1"><a itemprop=item href=../../shortcodes/include/ aria-disabled=true><span itemprop=name>Include</span></a></li>
</ol>
</div>
<div class=progress>
<div class=wrapper>
<nav id=TableOfContents>
<ul>
<li><a href=#usage>Usage</a></li>
<li><a href=#examples>Examples</a>
<ul>
<li><a href=#arbitray-content>Arbitray content</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id=head-tags>
</div>
<main id=body-inner>
<h1>Include</h1>
<p>The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.</p>
<h2 id=usage>Usage</h2>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-go data-lang=go>{{<span style=color:#ff6ac1>%</span> include &lt;<span style=color:#9aedfe>string</span>&gt; [ <span style=color:#5af78e>&#34;true&#34;</span> | <span style=color:#5af78e>&#34;false&#34;</span> ] <span style=color:#ff6ac1>%</span>}}
</code></pre></div><p>The first required parameter is the path to the file to be included.</p>
<p>If the file&rsquo;s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (<code>"true"</code>)- which is the default - or be hidden.</p>
<h2 id=examples>Examples</h2>
<h3 id=arbitray-content>Arbitray content</h3>
<p>You can add:</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>links</a></li>
<li>other shortcodes besides <code>include</code></li>
<li>etc.</li>
</ul>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-plaintext data-lang=plaintext>...and even source code
</code></pre></div><blockquote>
<p>the possiblities are endless</p>
</blockquote>
<div class=expand>
<a class=expand-label onclick="$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')">
<i class="fas fa-chevron-down"></i>
<i class="fas fa-chevron-right"></i>
Show markup
</a>
<div class=expand-content style=display:none>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-go data-lang=go>{{<span style=color:#ff6ac1>%</span> include <span style=color:#5af78e>&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span style=color:#ff6ac1>%</span>}}
</code></pre></div>
</div>
</div>
<footer class=footline>
</footer>
</main>
</div>
<div id=navigation>
<a class="nav nav-prev" href=../../shortcodes/expand/ title=Expand><i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href=../../shortcodes/mermaid/ title=Mermaid><i class="fa fa-chevron-right"></i></a>
</div>
</div>
<div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px>
<div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div>
</div>
<script src=../../js/clipboard.min.js?1635620112></script>
<script src=../../js/perfect-scrollbar.min.js?1635620112></script>
<script src=../../js/perfect-scrollbar.jquery.min.js?1635620112></script>
<script src=../../js/jquery.svg.pan.zoom.js?1635620112></script>
<script src=../../js/featherlight.min.js?1635620112></script>
<script src=../../js/modernizr.custom-3.6.0.js?1635620112></script>
<script src=../../js/relearn.js?1635620112></script>
</body>
</html>