hugo-theme-relearn/configuration/sitemanagement/structure/index.print.html

164 lines
13 KiB
HTML
Raw Normal View History

<!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.138.0">
<meta name="generator" content="Relearn 7.1.1+85d43bcef3403a38c509d04606f2cd8ca91c8bd5">
<meta name="description" content="Your site&#39;s directory structure">
<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="Directory Structure :: Hugo Relearn Theme">
<meta name="twitter:description" content="Your site&#39;s directory structure">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/structure/index.html">
<meta property="og:site_name" content="Hugo Relearn Theme">
<meta property="og:title" content="Directory Structure :: Hugo Relearn Theme">
<meta property="og:description" content="Your site&#39;s directory structure">
<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="Directory Structure :: Hugo Relearn Theme">
<meta itemprop="description" content="Your site&#39;s directory structure">
<meta itemprop="wordCount" content="188">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="keywords" content="Explanation">
<title>Directory Structure :: Hugo Relearn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/structure/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/structure/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/configuration/sitemanagement/structure/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/structure/index.html" rel="canonical" type="text/html" title="Directory Structure :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/configuration/sitemanagement/structure/index.xml" rel="alternate" type="application/rss+xml" title="Directory Structure :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1731710358" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731710358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731710358" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1731710358" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1731710358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1731710358" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1731710358" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1731710358" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1731710358" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1731710358" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1731710358" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1731710358" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/print.css?1731710358" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1731710358" rel="stylesheet">
<script src="/hugo-theme-relearn/js/variant.js?1731710358"></script>
<script>
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
// 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/configuration/sitemanagement/structure/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&#43;ALT&#43;n)"><i class="fa-fw fas fa-bars"></i></button>
</div>
<div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table of Contents (CTRL&#43;ALT&#43;t)"><i class="fa-fw fas fa-list-alt"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
</div>
</div>
</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/configuration/index.html"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/configuration/sitemanagement/index.html"><span itemprop="name">Site Management</span></a><meta itemprop="position" content="2">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Directory Structure</span><meta itemprop="position" content="3"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
<div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/configuration/sitemanagement/structure/_index.en.md" target="_self" title="Edit (CTRL&#43;ALT&#43;w)"><i class="fa-fw fas fa-pen"></i></a>
</div>
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/sitemanagement/structure/index.print.html" title="Print whole chapter (CTRL&#43;ALT&#43;p)"><i class="fa-fw fas fa-print"></i></a>
</div>
<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/configuration/sitemanagement/index.html" title="Site Management (🡐)"><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/configuration/sitemanagement/multilingual/index.html" title="Multilingual (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
</div>
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="More"><i class="fa-fw fas fa-ellipsis-v"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<div class="topbar-area topbar-area-more" data-area="more">
</div>
</div>
</div>
</div>
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable configuration" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
</header>
<h1 id="directory-structure">Directory Structure</h1>
<p>If you&rsquo;ve followed the <a href="/hugo-theme-relearn/introduction/quickstart/index.html">Getting Started</a> guide, your directory layout will look similar to this:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">├── content
</span></span><span class="line"><span class="cl">│ ├── first-chapter
</span></span><span class="line"><span class="cl">│ │ ├── first-page
</span></span><span class="line"><span class="cl">| | | └── _index.md
</span></span><span class="line"><span class="cl">│ │ ├── second-page
</span></span><span class="line"><span class="cl">| | | └── index.md
</span></span><span class="line"><span class="cl">│ │ └── third-page.md
</span></span><span class="line"><span class="cl">│ └── _index.md
</span></span><span class="line"><span class="cl">├── themes
</span></span><span class="line"><span class="cl">│ └── hugo-theme-relearn
</span></span><span class="line"><span class="cl">│ └── ...
</span></span><span class="line"><span class="cl">└── hugo.toml</span></span></code></pre></div>
<p>Hugo uses a <a href="https://gohugo.io/getting-started/directory-structure/#union-file-system" rel="external" target="_self">union file system</a>, which lets you combine multiple directories.</p>
<p>By default, it puts your root directory on top of the Relearn theme directory. Files in your root directory will replace theme files in the same location.</p>
<p>For example, if you create a file at <code>layouts/partials/heading.html</code>, it will override the theme&rsquo;s <code>themes/hugo-theme-relearn/layouts/partials/heading.html</code>.</p>
<p><a href="/hugo-theme-relearn/configuration/customization/partials/index.html">See this list</a>, to learn which files are allowed to be modified by you.</p>
<p>This makes it easy to customize the theme without changing files in the <code>themes</code> directory, making future theme updates simpler.</p>
<div class="box notices cstyle warning">
<div class="box-label">
<i class="fa-fw fas fa-exclamation-triangle"></i> Warning
</div>
<div class="box-content">
<p>Don&rsquo;t edit files inside the <code>themes/hugo-theme-relearn</code> directory. That&rsquo;s not the recommended way to customize! Refer to the explanation above.</p>
<p>Don&rsquo;t clone the theme repository and edit files there for your site. That&rsquo;s not the recommended way to customize! Instead, follow the <a href="/hugo-theme-relearn/introduction/quickstart/index.html">Getting Started</a> guide.</p>
</div>
</div>
<footer class="footline">
<div class="R-taxonomy taxonomy-categories cstyle" title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
<i class="fa-fw fas fa-layer-group"></i>
<ul>
<li><a class="term-link" href="/hugo-theme-relearn/categories/explanation/index.html">Explanation</a></li>
</ul>
</div>
</footer>
</article>
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1731710358" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1731710358" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1731710358" defer></script>
</body>
</html>