mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-28 03:03:18 +00:00
149 lines
12 KiB
HTML
149 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<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.107.0">
|
|
<meta name="generator" content="Relearn 5.7.0+tip">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>Installation :: Hugo Relearn Theme</title>
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/installation/index.html" rel="canonical" type="text/html" title="Installation :: Hugo Relearn Theme">
|
|
<link href="../../basics/installation/index.xml" rel="alternate" type="application/rss+xml" title="Installation :: Hugo Relearn Theme">
|
|
<link href="../../images/logo.svg?1670145352" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="../../css/fontawesome-all.min.css?1670145354" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1670145354" rel="stylesheet"></noscript>
|
|
<link href="../../css/featherlight.min.css?1670145354" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1670145354" rel="stylesheet"></noscript>
|
|
<link href="../../css/auto-complete.css?1670145354" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1670145354" rel="stylesheet"></noscript>
|
|
<link href="../../css/perfect-scrollbar.min.css?1670145354" rel="stylesheet">
|
|
<link href="../../css/nucleus.css?1670145354" rel="stylesheet">
|
|
<link href="../../css/fonts.css?1670145354" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1670145354" rel="stylesheet"></noscript>
|
|
<link href="../../css/theme.css?1670145354" rel="stylesheet">
|
|
<link href="../../css/theme-relearn-light.css?1670145354" rel="stylesheet" id="variant-style">
|
|
<link href="../../css/ie.css?1670145354" rel="stylesheet">
|
|
<link href="../../css/variant.css?1670145354" rel="stylesheet">
|
|
<link href="../../css/print.css?1670145354" rel="stylesheet" media="print">
|
|
<link href="../../css/format-print.css?1670145354" rel="stylesheet">
|
|
<script src="../../js/url.js?1670145354"></script>
|
|
<script src="../../js/variant.js?1670145354"></script>
|
|
<script>
|
|
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
|
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
|
window.index_js_url="../../index.search.js";
|
|
var root_url="../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
// 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_No_results_found = 'No results found for \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
|
// some further base stuff
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
|
</script>
|
|
<script src="../../js/jquery.min.js?1670145354" defer></script>
|
|
<style>
|
|
#body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../basics/installation/index.html">
|
|
<div id="body" class="default-animation">
|
|
<div id="sidebar-overlay"></div>
|
|
<div id="toc-overlay"></div>
|
|
<nav id="topbar" class="highlightable" dir="ltr">
|
|
<div>
|
|
<div id="breadcrumbs">
|
|
<span id="sidebar-toggle-span">
|
|
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
|
</span>
|
|
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="2"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Installation</span><meta itemprop="position" content="3"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<div id="head-tags">
|
|
</div>
|
|
<article class="default">
|
|
<h1 id="installation">Installation</h1>
|
|
|
|
<p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this <a href="https://gohugo.io/overview/quickstart/">great documentation for beginners</a>.</p>
|
|
<h2 id="create-your-project">Create your project</h2>
|
|
<p>Hugo provides a <code>new</code> command to create a new website.</p>
|
|
<pre tabindex="0"><code>hugo new site <new_project>
|
|
</code></pre><h2 id="install-the-theme">Install the theme</h2>
|
|
<p>Install the Relearn theme by following <a href="https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme">this documentation</a></p>
|
|
<p>This theme’s repository is: <a href="https://github.com/McShelby/hugo-theme-relearn.git">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
|
|
<p>Alternatively, you can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip">download the theme as .zip</a> file and extract it in the <code>themes</code> directory</p>
|
|
<h2 id="basic-configuration">Basic configuration</h2>
|
|
<p>When building the website, you can set a theme by using <code>--theme</code> option. However, we suggest you modify the configuration file (<code>config.toml</code>) and set the theme as the default. You can also add the <code>[outputs]</code> section to enable the search functionality.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="c"># Change the default theme to be use when building the site with Hugo</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">theme</span> <span class="p">=</span> <span class="s2">"hugo-theme-relearn"</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="c"># For search functionality</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">outputs</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">home</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"SEARCH"</span><span class="p">]</span>
|
|
</span></span></code></pre></div><h2 id="create-your-first-chapter-page">Create your first chapter page</h2>
|
|
<p>Chapters are pages that contain other child pages. It has a special layout style and usually just contains a <em>chapter name</em>, the <em>title</em> and a <em>brief abstract</em> of the section.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gu">### Chapter 1
|
|
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
|
</span></span><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 Hugo theme is all about and the core concepts behind it.
|
|
</span></span></code></pre></div><p>renders as</p>
|
|
<p>
|
|
|
|
<a href="../../basics/installation/chapter.png?classes=shadow&width=60pc" data-featherlight="image">
|
|
<img src="../../basics/installation/chapter.png?classes=shadow&width=60pc" alt="A Chapter" class="shadow" style="height: auto; width: 60pc;" loading="lazy">
|
|
</a></p>
|
|
<p>The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command</p>
|
|
<div class="highlight"><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 opening the given file, you should see the property <code>chapter=true</code> on top, meaning this page is a <em>chapter</em>.</p>
|
|
<p>By default all chapters and pages are created as a draft. If you want to render these pages, remove the property <code>draft: true</code> from the metadata.</p>
|
|
<h2 id="create-your-first-content-pages">Create your first content pages</h2>
|
|
<p>Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:</p>
|
|
<div class="highlight"><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 to edit those files by adding some sample content and replacing the <code>title</code> value in the beginning of the files.</p>
|
|
<h2 id="launching-the-website-locally">Launching the website locally</h2>
|
|
<p>Launch by using the following command:</p>
|
|
<div class="highlight"><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 to <code>http://localhost:1313</code></p>
|
|
<p>You should notice three things:</p>
|
|
<ol>
|
|
<li>You have a left-side <strong>Basics</strong> menu, containing two submenus with names equal to the <code>title</code> properties in the previously created files.</li>
|
|
<li>The home page explains how to customize it by following the instructions.</li>
|
|
<li>When you run <code>hugo serve</code>, when the contents of the files change, the page automatically refreshes with the changes. Neat!</li>
|
|
</ol>
|
|
<h2 id="build-the-website">Build the website</h2>
|
|
<p>When your site is ready to deploy, run the following command:</p>
|
|
<div class="highlight"><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, containing all static content and assets for your website. It can now be deployed on any web server.</p>
|
|
|
|
<div class="box notices cstyle note">
|
|
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
|
<div class="box-content">
|
|
<p>This website can be automatically published and hosted with <a href="https://www.netlify.com/">Netlify</a> (Read more about <a href="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments with Netlify</a>). Alternatively, you can use <a href="https://gohugo.io/hosting-and-deployment/hosting-on-github/">GitHub pages</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../js/clipboard.min.js?1670145355" defer></script>
|
|
<script src="../../js/perfect-scrollbar.min.js?1670145355" defer></script>
|
|
<script src="../../js/featherlight.min.js?1670145355" defer></script>
|
|
<script src="../../js/theme.js?1670145355" defer></script>
|
|
</body>
|
|
</html>
|