2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2022-12-08 10:17:57 +00:00
< meta name = "generator" content = "Hugo 0.108.0" >
2022-12-11 22:22:02 +00:00
< meta name = "generator" content = "Relearn 5.8.1+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
< meta name = "author" content = "Sören Weber" >
< title > Installation :: Hugo Relearn Theme< / title >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/basics/installation/index.html" rel = "canonical" type = "text/html" title = "Installation :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../../basics/installation/index.xml" rel = "alternate" type = "application/rss+xml" title = "Installation :: Hugo Relearn Theme" >
2022-12-16 16:18:42 +00:00
< link href = "../../images/logo.svg?1671207516" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2022-12-16 16:18:42 +00:00
< link href = "../../css/fontawesome-all.min.css?1671207517" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1671207517" rel = "stylesheet" > < / noscript >
< link href = "../../css/featherlight.min.css?1671207517" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/featherlight.min.css?1671207517" rel = "stylesheet" > < / noscript >
< link href = "../../css/auto-complete.css?1671207517" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1671207517" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1671207517" rel = "stylesheet" >
< link href = "../../css/nucleus.css?1671207517" rel = "stylesheet" >
< link href = "../../css/fonts.css?1671207517" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1671207517" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1671207517" rel = "stylesheet" >
< link href = "../../css/theme-relearn-light.css?1671207517" rel = "stylesheet" id = "variant-style" >
< link href = "../../css/ie.css?1671207517" rel = "stylesheet" >
< link href = "../../css/variant.css?1671207517" rel = "stylesheet" >
< link href = "../../css/print.css?1671207517" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1671207517" rel = "stylesheet" >
< script src = "../../js/url.js?1671207517" > < / script >
< script src = "../../js/variant.js?1671207517" > < / script >
2022-04-02 13:30:16 +00:00
< 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
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
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!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2022-07-14 20:20:11 +00:00
window.variants & & variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-16 16:18:42 +00:00
< script src = "../../js/jquery.min.js?1671207517" defer > < / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../basics/installation/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2022-11-07 19:58:08 +00:00
< nav id = "topbar" class = "highlightable" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2022-10-08 20:51:04 +00:00
< a href = "#" id = "sidebar-toggle" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2022-11-05 23:35:48 +00:00
< 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 >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Installation< / span > < meta itemprop = "position" content = "3" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "installation" > Installation< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-16 16:18:42 +00:00
< 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/" target = "_blank" rel = "noopener" >
great documentation for beginners
< / a > .< / p >
2022-04-02 13:30:16 +00:00
< 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 >
2022-12-16 16:18:42 +00:00
< p > Install the Relearn theme by following
< a href = "https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" target = "_blank" rel = "noopener" >
this documentation
< / a > using Hugo’ s module system.< / p >
< p > This theme’ s repository is:
< a href = "https://github.com/McShelby/hugo-theme-relearn.git" target = "_blank" rel = "noopener" >
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" target = "_blank" rel = "noopener" >
download the theme as .zip
< / a > file and extract it in the < code > themes< / code > directory< / p >
2022-04-02 13:30:16 +00:00
< 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 >
2022-11-01 23:17:10 +00:00
< / 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 >
2022-04-02 13:30:16 +00:00
< / 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 >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
< 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 >
2022-04-02 13:30:16 +00:00
< 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 >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-12-16 16:18:42 +00:00
< p > This website can be automatically published and hosted with
< a href = "https://www.netlify.com/" target = "_blank" rel = "noopener" >
Netlify
< / a > (Read more about
< a href = "https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/" target = "_blank" rel = "noopener" >
Automated HUGO deployments with Netlify
< / a > ). Alternatively, you can use
< a href = "https://gohugo.io/hosting-and-deployment/hosting-on-github/" target = "_blank" rel = "noopener" >
GitHub pages
< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2022-12-16 16:18:42 +00:00
< script src = "../../js/clipboard.min.js?1671207518" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1671207518" defer > < / script >
< script src = "../../js/featherlight.min.js?1671207518" defer > < / script >
< script src = "../../js/theme.js?1671207518" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
