<!DOCTYPE html> <html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article"> <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.130.0"> <meta name="generator" content="Relearn 6.1.0+tip"> <meta name="description" content="Displays content from other files"> <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="Include :: Hugo Relearn Theme"> <meta name="twitter:description" content="Displays content from other files"> <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include/index.html"> <meta property="og:site_name" content="Hugo Relearn Theme"> <meta property="og:title" content="Include :: Hugo Relearn Theme"> <meta property="og:description" content="Displays content from other files"> <meta property="og:locale" content="en"> <meta property="og:type" content="website"> <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="name" content="Include :: Hugo Relearn Theme"> <meta itemprop="description" content="Displays content from other files"> <meta itemprop="wordCount" content="235"> <meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <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="art-x-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="/hugo-theme-relearn/shortcodes/include/index.xml" rel="alternate" type="application/rss+xml" title="Include :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/images/logo.svg?1722590651" rel="icon" type="image/svg+xml"> <link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1722590651" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1722590651" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/nucleus.css?1722590651" rel="stylesheet"> <link href="/hugo-theme-relearn/css/auto-complete.css?1722590651" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1722590651" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1722590651" rel="stylesheet"> <link href="/hugo-theme-relearn/css/fonts.css?1722590651" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1722590651" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/theme.css?1722590651" rel="stylesheet"> <link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1722590651" rel="stylesheet" id="R-variant-style"> <link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1722590651" rel="stylesheet" id="R-variant-chroma-style"> <link href="/hugo-theme-relearn/css/variant.css?1722590651" rel="stylesheet"> <link href="/hugo-theme-relearn/css/print.css?1722590651" rel="stylesheet" media="print"> <link href="/hugo-theme-relearn/css/format-print.css?1722590651" rel="stylesheet"> <script src="/hugo-theme-relearn/js/variant.js?1722590651"></script> <script> window.relearn = window.relearn || {}; window.relearn.relBasePath='..\/..'; window.relearn.relBaseUri='..\/..\/..'; window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn'; window.index_js_url="/hugo-theme-relearn/index.search.js?1722590651"; // variant stuff window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] ); // 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}"`; </script> <style> #R-body img.bg-white { background-color: white; } </style> </head> <body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/shortcodes/include/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/shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="1"> > </li><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Include</span><meta itemprop="position" content="2"></li> </ol> <div class="topbar-area topbar-area-end" data-area="end"> <div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/icon/index.html" title="Icon (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a> </div> <div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/math/index.html" title="Math (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a> </div> </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="include">Include</h1> <p>The <code>include</code> shortcode includes other pages, resources or files from your project.</p> <h2 id="usage">Usage</h2> <p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your 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="shortcode-positional" class="tab-nav-button tab-panel-style cstyle initial" onclick="switchTab('shortcode-parameter','shortcode-positional')" > <span class="tab-nav-text">shortcode (positional)</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"> <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">include</span> <span class="nx">file</span><span class="p">=</span><span class="s">"shortcodes/include/INCLUDE_ME.md"</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 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">include</span> <span class="s">"shortcodes/include/INCLUDE_ME.md"</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 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/include .html"</span> <span class="p">(</span><span class="nx">dict</span> </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">"file"</span> <span class="s">"shortcodes/include/INCLUDE_ME.md"</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>Name</th> <th>Position</th> <th>Default</th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td><strong>file</strong></td> <td>1</td> <td><em><empty></em></td> <td>The path to the page, resource or file to be included. Page and resource paths adhere to <a href="https://gohugo.io/methods/page/path/" rel="external" target="_self">Hugo’s logical path</a>. If not found by logical path it falls back to <a href="https://gohugo.io/functions/readfile/" rel="external" target="_self">Hugo’s build-in <code>readFile</code> function</a></td> </tr> <tr> <td><strong>hidefirstheading</strong></td> <td>2</td> <td><code>false</code></td> <td>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 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">include</span> <span class="s">"shortcodes/include/INCLUDE_ME.md"</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" rel="external" target="_self">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 wrap-code"><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 “and other similar things”, or “and so forth” <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p> </li> </ol> </div> <footer class="footline"> </footer> </article> <section> <h1 class="a11y-only">Subsections of Include</h1> </section> </div> </main> </div> <script src="/hugo-theme-relearn/js/clipboard.min.js?1722590651" defer></script> <script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1722590651" defer></script> <script src="/hugo-theme-relearn/js/theme.js?1722590651" defer></script> </body> </html>