hugo-theme-relearn/pir/basics/installation/index.print.html

352 lines
24 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="art-x-pir" dir="rtl" 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.132.1">
<meta name="generator" content="Relearn 6.1.1+tip">
<meta name="description" content="Th&#39; follow&#39;n steps be here t&#39; help ye initialize yer new website.">
<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="Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<meta name="twitter:description" content="Th&#39; follow&#39;n steps be here t&#39; help ye initialize yer new website.">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html">
<meta property="og:site_name" content="Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:title" content="Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:description" content="Th&#39; follow&#39;n steps be here t&#39; help ye initialize yer new website.">
<meta property="og:locale" content="art_x_pir">
<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="Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<meta itemprop="description" content="Th&#39; follow&#39;n steps be here t&#39; help ye initialize yer new website.">
<meta itemprop="wordCount" content="654">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="keywords" content="Documentat&#39;n">
<title>Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/installation/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/basics/installation/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html" rel="canonical" type="text/html" title="Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/pir/basics/installation/index.xml" rel="alternate" type="application/rss+xml" title="Installat&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1723567893" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1723567893" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1723567893" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1723567893" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1723567893" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1723567893" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1723567893" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1723567893" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1723567893" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1723567893" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1723567893" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1723567893" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/variant.css?1723567893" rel="stylesheet">
<link href="/hugo-theme-relearn/css/print.css?1723567893" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1723567893" rel="stylesheet">
<script src="/hugo-theme-relearn/js/variant.js?1723567893"></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/pir/index.search.js?1723567893";
// 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 t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
</script>
<style>
#R-body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/basics/installation/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>
<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/pir/basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Installat&#39;n</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/pir/basics/requirements/index.html" title="Requirrrements (🡒)"><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/pir/basics/configuration/index.html" title="Configurrrat&#39;n (🡐)"><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">
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
<ul>
<li><a class="term-link" href="/hugo-theme-relearn/pir/tags/documentatn/index.html">Documentat&#39;n</a></li>
</ul>
</div>
</header>
<h1 id="installatn">Installat&#39;n</h1>
<p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don&rsquo;t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this <a href="https://gohugo.io/overview/quickstart/" rel="external" target="_self">great documentat'n fer beginners</a>.</p>
<div class="box notices cstyle tip">
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
<div class="box-content">
<p>Th' follow'n tutorial leads ye through th' steps o' creat'n a first, minimal new ship.</p>
<p>Ye don&rsquo;t need t' edit any files besides yer <code>hugo.toml</code> an' only need t' execute th' commands 'n th' given order.</p>
</div>
</div>
<h2 id="create-your-project">Create yer Project</h2>
<p>Cap'n Hugo provides th' <code>new</code> command t' create a new website:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new ship my-new-site</span></span></code></pre></div><p>Aft that change into th' directory:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl"><span class="nb">cd</span> my-new-site</span></span></code></pre></div><p>Every upcom'n command will be executed from inside yer new site&rsquo;s root.</p>
<h2 id="install-the-theme">Install th' Theme</h2>
<h3 id="downloading-as-archive">Download'n as Archive</h3>
<p>Ye can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" rel="external" target="_self">download th' theme as .zip archive</a> an' extract its rrrambl'n into them <code>themes/hugo-theme-relearn</code> directory.</p>
<p>Afterwards add this at th' end o' yer <code>hugo.toml</code>.</p>
<div class="tab-panel" data-tab-group="config-code">
<div class="tab-nav">
<div class="tab-nav-title">hugo.</div>
<button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
<span class="tab-nav-text">toml</span>
</button>
<button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
<span class="tab-nav-text">yaml</span>
</button>
<button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
<span class="tab-nav-text">json</span>
</button>
</div>
<div class="tab-content-container">
<div
data-tab-item="toml"
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-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">theme</span> <span class="p">=</span> <span class="s1">&#39;hugo-theme-relearn&#39;</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="yaml"
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-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">theme</span><span class="p">:</span><span class="w"> </span><span class="l">hugo-theme-relearn</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="json"
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-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;theme&#34;</span><span class="p">:</span> <span class="s2">&#34;hugo-theme-relearn&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
</div>
</div>
</div>
<h3 id="using-hugos-module-system">Us'n Hugo&rsquo;s Module System</h3>
<p>Ye can install th' Relearrrn theme by follow'n <a href="https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" rel="external" target="_self">th' standard documentat'n</a> us'n Hugo&rsquo;s module system:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo mod init example.com</span></span></code></pre></div><p>Afterwards add this at th' end o' yer <code>hugo.toml</code>.</p>
<div class="tab-panel" data-tab-group="config-code">
<div class="tab-nav">
<div class="tab-nav-title">hugo.</div>
<button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
<span class="tab-nav-text">toml</span>
</button>
<button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
<span class="tab-nav-text">yaml</span>
</button>
<button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
<span class="tab-nav-text">json</span>
</button>
</div>
<div class="tab-content-container">
<div
data-tab-item="toml"
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-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">module</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">module</span><span class="p">.</span><span class="nx">imports</span><span class="p">]]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">path</span> <span class="p">=</span> <span class="s1">&#39;github.com/McShelby/hugo-theme-relearn&#39;</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="yaml"
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-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">module</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">imports</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l">github.com/McShelby/hugo-theme-relearn</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="json"
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-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;module&#34;</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;imports&#34;</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;path&#34;</span><span class="p">:</span> <span class="s2">&#34;github.com/McShelby/hugo-theme-relearn&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
</div>
</div>
</div>
<h3 id="using-git-submodules">Us'n Git Submodules</h3>
<p>If ye plan t' store yer project 'n a git repository ye can create one wit':</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">git init</span></span></code></pre></div><p>Now add th' theme as a submodule by:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">git submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearn</span></span></code></pre></div><p>Afterwards add this at th' end o' yer <code>hugo.toml</code>.</p>
<div class="tab-panel" data-tab-group="config-code">
<div class="tab-nav">
<div class="tab-nav-title">hugo.</div>
<button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
<span class="tab-nav-text">toml</span>
</button>
<button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
<span class="tab-nav-text">yaml</span>
</button>
<button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
<span class="tab-nav-text">json</span>
</button>
</div>
<div class="tab-content-container">
<div
data-tab-item="toml"
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-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">theme</span> <span class="p">=</span> <span class="s1">&#39;hugo-theme-relearn&#39;</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="yaml"
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-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">theme</span><span class="p">:</span><span class="w"> </span><span class="l">hugo-theme-relearn</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="json"
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-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;theme&#34;</span><span class="p">:</span> <span class="s2">&#34;hugo-theme-relearn&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
</div>
</div>
</div>
<h2 id="create-your-home-page">Create yer Home Plank</h2>
<p>If ye don&rsquo;t create a home plank, yet, th' theme will generate a placeholder text wit' instruct'ns on how t' proceed.</p>
<p>Start yer journey by creat'n a home plank:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind home _index.md</span></span></code></pre></div><p>Th' newly created home plank <code>content/_index.md</code> be empty an' ye obviously should add some meaningful rrrambl'n.</p>
<h2 id="create-your-first-chapter-page">Create yer First Chapter Plank</h2>
<p>Chapters be meant t' be top level planks that contain other child planks. They have a special layout style an' often just contain th' <em>title</em> an' a <em>brief abstract</em> o' th' section.</p>
<p>Now create yer first chapter plank wit' th' follow'n command:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind chapter basics/_index.md</span></span></code></pre></div><p>When open'n th' newly created file <code>content/basics/_index.md</code>, ye should see th' <code>weight</code> frontmatter wit' a number. This will be used t' generate th' subtitle o' th' chapter plank, an' should be set t' a consecutive value start'n at <code>1</code> fer each chapter level.</p>
<h2 id="create-your-first-content-pages">Create yer First Rrrambl'n Planks</h2>
<p>Then create rrrambl'n planks inside th' previously created chapter. Here be three ways t' create rrrambl'n 'n th' chapter:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new basics/first-content/_index.md
</span></span><span class="line"><span class="cl">hugo new basics/second-content/index.md
</span></span><span class="line"><span class="cl">hugo new basics/third-content.md</span></span></code></pre></div><p>Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' <code>title</code> value 'n th' beginn'n o' th' files.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
<div class="box-content">
<p>Please note that Cap'n Hugo overrides th' default archetype template com'n wit' this theme when us'n <code>hugo new ship my-new-site</code>. T' actually see yer plank later, ye have t' remove th' <code>draft=true</code> from th' page&rsquo;s frontmatter.</p>
</div>
</div>
<h2 id="testing-your-website-locally">Test'n yer Website Locally</h2>
<p>Launch yer new web ship by us'n th' follow'n command:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo serve</span></span></code></pre></div><p>Go t' <a href="http://localhost:1313" rel="external" target="_self"><code>http://localhost:1313</code></a> 'n yer browser.</p>
<p>Ye should notice a few th'ns:</p>
<ol>
<li>Th' home plank contains yer provided text.</li>
<li>Ye have th' menu <strong>Basics</strong> 'n th' sidebar. Click'n on it reveals three submenus wit' names equal t' th' <code>title</code> properties 'n th' previously created rrrambl'n planks.</li>
<li>While ye be runn'n <code>hugo serve</code> yer plank refreshes automatically when ye change a rrrambl'n plank. Neat!</li>
</ol>
<h2 id="build-and-deploy-your-website">Build an' Deploy yer Website</h2>
<p>When yer ship be ready t' be deployed, run th' follow'n command:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo</span></span></code></pre></div><p>A <code>public</code> directory will be generated, contain'n all rrrambl'n an' assets fer yer web ship.</p>
<p>It now can be deployed t' any web server by simply upload'n its contents or ye can check out one o' <a href="https://gohugo.io/hosting-and-deployment/" rel="external" target="_self">Hugo&rsquo;s many other deployment opt'ns</a>.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
<div class="box-content">
<p>If ye be stor'n yer web ship 'n git, commit all but th' <code>public</code> directory.</p>
</div>
</div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1723567893" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1723567893" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1723567893" defer></script>
</body>
</html>