mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 18:53:18 +00:00
231 lines
19 KiB
HTML
231 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-pir" dir="rtl">
|
|
<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.124.1">
|
|
<meta name="generator" content="Relearn 5.27.0+tip">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<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'n :: Cap'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="Installat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="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 great documentat'n fer beginners.
|
|
Smarrrt Arrrse Th' follow'n tutorial leads ye thru th' steps o' creat'n a first, minimal new ship.
|
|
Ye don&rsquo;t need t' edit any files besides yer hugo.toml an' only need t' execute th' commands 'n th' given order.">
|
|
<meta property="og:locale" content="art-pir">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Installat'n :: Cap'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-pir">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html" rel="canonical" type="text/html" title="Installat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/pir/basics/installation/index.xml" rel="alternate" type="application/rss+xml" title="Installat'n :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1712526590" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712526593" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712526593" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1712526593" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1712526593" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712526593" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712526593" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1712526593" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712526593" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1712526593" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712526593" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712526593" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1712526593" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1712526593" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1712526593" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/ie.css?1712526593" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/url.js?1712526593"></script>
|
|
<script src="/hugo-theme-relearn/js/variant.js?1712526593"></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";
|
|
// variant stuff
|
|
window.relearn.themeVariantModifier='';
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', '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+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/pir/basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Installat'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'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'n</a></li>
|
|
</ul>
|
|
</div>
|
|
</header>
|
|
|
|
<h1 id="installatn">Installat'n</h1>
|
|
|
|
|
|
<p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don’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="_blank">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 thru th' steps o' creat'n a first, minimal new ship.</p>
|
|
<p>Ye don’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 a <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’s root.</p>
|
|
<h2 id="install-the-theme">Install th' theme</h2>
|
|
<h3 id="from-download">From Download</h3>
|
|
<p>Ye can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" rel="external" target="_blank">download th' theme as .zip</a> file an' extract it into them <code>themes/hugo-theme-relearn</code> directory.</p>
|
|
<h3 id="with-hugos-module-system">Wit' Hugo’s Module System</h3>
|
|
<p>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="_blank">this documentat'n</a> us'n Hugo’s module system.</p>
|
|
<p>This theme’s repository be: <a href="https://github.com/McShelby/hugo-theme-relearn.git" rel="external" target="_blank">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
|
|
<h3 id="using-git-or-git-submodules">Us'n Git or Git Submodules</h3>
|
|
<p>If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.</p>
|
|
<p>If ye use th' <code>head</code> o' th' <code>main</code> branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.</p>
|
|
<p>Additionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official <a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_blank">releases from th' GitHub repository</a>.</p>
|
|
<p>Besides th' usual version tags (eg <code>1.2.3</code>) there be also tags fer th' main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) an' th' latest (just <code>x</code>) released version mak'n it easier fer ye t' pin th' theme t' a certain version.</p>
|
|
<h2 id="basic-configuration">Basic Configurat'n</h2>
|
|
<p>When build'n th' website, ye can set a theme by us'n <code>--theme</code> opt'n. However, we suggest ye modify th' configurat'n file <code>hugo.toml</code> an' set th' theme as th' default.</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">'hugo-theme-relearn'</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">"theme"</span><span class="p">:</span> <span class="s2">"hugo-theme-relearn"</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’t create a home plank, yet, th' theme will generate a placeholder text wit' instruct'ns how t' proceed.</p>
|
|
<p>Start yer journey by fill'n th' home plank wit' rrrambl'n</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>By open'n th' given file, ye should see th' property <code>archetype=home</code> on top, mean'n this plank be a home plank. Th' Relearrrn theme provides <a href="/hugo-theme-relearn/pir/cont/archetypes/index.html">some archetypes</a> t' create those skeleton files fer yer website.</p>
|
|
<p>Obviously ye better should change th' page’s rrrambl'n.</p>
|
|
<h2 id="create-your-first-chapter-page">Create yer First Chapter Plank</h2>
|
|
<p>Chapters be planks that contain other child planks. It has a special layout style an' usually just contains th' <em>title</em> an' a <em>brief abstract</em> o' th' section.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="gh"># Basics
|
|
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
|
</span></span><span class="line"><span class="cl">Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.</span></span></code></pre></div><p>renders as</p>
|
|
<p><a href="#R-image-0c1db1f5536d264aca50b358bf465f1e" class="lightbox-link"><img alt="A Chapter" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/installation/chapter.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-0c1db1f5536d264aca50b358bf465f1e"><img alt="A Chapter" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/installation/chapter.png?width=60pc"></a></p>
|
|
<p>Begin by creat'n 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>By open'n th' given file, ye should see th' property <code>archetype=chapter</code> on top, mean'n this plank be a <em>chapter</em>.</p>
|
|
<p>Th' <code>weight</code> number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new 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 two 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.md
|
|
</span></span><span class="line"><span class="cl">hugo new basics/second-content/_index.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>
|
|
<h2 id="launching-the-website-locally">Launch'n th' Website Locally</h2>
|
|
<p>Launch 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' <code>http://localhost:1313</code></p>
|
|
<p>Ye should notice three th'ns:</p>
|
|
<ol>
|
|
<li>Th' home plank contains some basic text.</li>
|
|
<li>Ye have a left-side <strong>Basics</strong> menu, contain'n two submenus wit' names equal t' th' <code>title</code> properties 'n th' previously created files.</li>
|
|
<li>When ye run <code>hugo serve</code> yer plank refreshes automatically when ye change a rrrambl'n plank. Neat!</li>
|
|
</ol>
|
|
<h2 id="build-the-website">Build th' Website</h2>
|
|
<p>When yer ship be ready t' deploy, 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> folder will be generated, contain'n all rrrambl'n an' assets fer yer website. It can now be deployed on any web server.</p>
|
|
<p>Now it’s time t' deploy yer plank by simply upload'n yer project t' some webserver or by us'n one o' <a href="https://gohugo.io/hosting-and-deployment/" rel="external" target="_blank">Hugo’s many deployment opt'ns</a>.</p>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1712526593" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712526593" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1712526593" defer></script>
|
|
</body>
|
|
</html>
|