<liitemscopeitemtype="https://schema.org/ListItem"itemprop="itemListElement"><aitemprop="item"href="../../../pir/index.html"><spanitemprop="name">Cap'n Hugo Relearrrn Theme</span></a><metaitemprop="position"content="1">></li>
<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 <ahref="https://gohugo.io/overview/quickstart/"target="_blank">great documentat'n fer beginners</a>.</p>
<p>Alternatively, ye can <ahref="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip"target="_blank">download th' theme as .zip</a> file an' extract it 'n th' <code>themes</code> directory</p>
<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 <ahref="https://github.com/McShelby/hugo-theme-relearn/releases"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>
<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>config.toml</code>) an' set th' theme as th' default. Ye can also add th' <code>[outputs]</code> section t' en'ble th' search functionality.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo</span>
</span></span></code></pre></div><h2id="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 a <em>chapter name</em>, th' <em>title</em> an' a <em>brief abstract</em> o' th' section.</p>
<p>Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="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>chapter=true</code> on top, mean'n this plank be a <em>chapter</em>.</p>
<p>By default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property <code>draft: true</code> from th' metadata.</p>
<h2id="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>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new basics/first-content.md
</span></span><spanclass="line"><spanclass="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>
<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>Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns.</li>
<li>When ye run <code>hugo serve</code>, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat!</li>
</ol>
<h2id="build-the-website">Build th' website</h2>
<p>When yer ship be ready t' deploy, run th' follow'n command:</p>
</span></span></code></pre></div><p>A <code>public</code> folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.</p>
<p>This website can be automatically published an' hosted wit' <ahref="https://www.netlify.com/"target="_blank">Netlify</a> (Read more about <ahref="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/"target="_blank">Automated HUGO deployments wit' Netlify</a>). Alternatively, ye can use <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/"target="_blank">GitHub planks</a>.</p>
