2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2024-04-27 13:29:53 +00:00
< html lang = "en" dir = "ltr" itemscope itemtype = "http://schema.org/Article" >
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" >
2024-10-24 14:30:52 +00:00
< meta name = "generator" content = "Hugo 0.136.4" >
2024-10-24 15:36:57 +00:00
< meta name = "generator" content = "Relearn 7.0.1+0938e8bd2e8bce8d47586b5c26e306892fcb70a9" >
2024-10-13 14:26:50 +00:00
< meta name = "description" content = "Initialize your website in a few simple steps" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta name = "twitter:title" content = "Getting Started :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "Initialize your website in a few simple steps" >
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart/index.html" >
2024-04-07 13:13:19 +00:00
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2024-10-13 14:26:50 +00:00
< meta property = "og:title" content = "Getting Started :: Hugo Relearn Theme" >
< meta property = "og:description" content = "Initialize your website in a few simple steps" >
2024-04-07 13:13:19 +00:00
< meta property = "og:locale" content = "en" >
2023-10-11 15:32:39 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "name" content = "Getting Started :: Hugo Relearn Theme" >
< meta itemprop = "description" content = "Initialize your website in a few simple steps" >
< meta itemprop = "wordCount" content = "509" >
2024-04-24 19:38:41 +00:00
< meta itemprop = "image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "keywords" content = "Tutorial" >
< title > Getting Started :: Hugo Relearn Theme< / title >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/introduction/quickstart/index.html" rel = "alternate" hreflang = "art-x-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart/index.html" rel = "canonical" type = "text/html" title = "Getting Started :: Hugo Relearn Theme" >
< link href = "/hugo-theme-relearn/introduction/quickstart/index.xml" rel = "alternate" type = "application/rss+xml" title = "Getting Started :: Hugo Relearn Theme" >
2024-10-24 15:36:57 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1729784203" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1729784203" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1729784203" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1729784203" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1729784203" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1729784203" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1729784203" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1729784203" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1729784203" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1729784203" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1729784203" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1729784203" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1729784203" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1729784203" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1729784203" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..';
window.relearn.relBaseUri='..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-08-22 16:34:04 +00:00
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
2023-11-16 22:53:34 +00:00
// variant stuff
2024-04-19 06:38:17 +00:00
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' ] );
2023-11-16 22:53:34 +00:00
// 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_Reset_view = `Reset view`;
window.T_View_reset = `View reset!`;
window.T_No_results_found = `No results found for "{0}"`;
window.T_N_results_found = `{1} results found for "{0}"`;
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2024-10-13 14:26:50 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/introduction/quickstart/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< 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 >
2023-09-12 21:10:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-toc" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Table of Contents (CTRL+ALT+t)" > < i class = "fa-fw fas fa-list-alt" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< nav class = "TableOfContents" >
< ul >
< li > < a href = "#install-hugo" > Install Hugo< / a > < / li >
< li > < a href = "#create-your-project" > Create your Project< / a > < / li >
< li > < a href = "#install-the-theme" > Install the Theme< / a >
< ul >
< li > < a href = "#download-as-a-zip-file" > Download as a Zip File< / a > < / li >
< li > < a href = "#use-hugos-module-system" > Use Hugo’ s Module System< / a > < / li >
< li > < a href = "#use-as-a-git-submodule" > Use as a Git Submodule< / a > < / li >
< / ul >
< / li >
< li > < a href = "#create-your-home-page" > Create your Home Page< / a > < / li >
< li > < a href = "#create-your-first-chapter-page" > Create your First Chapter Page< / a > < / li >
< li > < a href = "#create-your-first-content-pages" > Create your First Content Pages< / a > < / li >
< li > < a href = "#test-your-website-locally" > Test your Website Locally< / a > < / li >
< li > < a href = "#build-and-deploy-your-website" > Build and Deploy your Website< / a > < / li >
< li > < a href = "#next-steps" > Next Steps< / a > < / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2024-10-13 14:26:50 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "/hugo-theme-relearn/introduction/index.html" > < span itemprop = "name" > Introduction< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Getting Started< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-edit" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/introduction/quickstart/_index.en.md" target = "_self" title = "Edit (CTRL+ALT+w)" > < i class = "fa-fw fas fa-pen" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-print" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/introduction/quickstart/index.print.html" title = "Print whole chapter (CTRL+ALT+p)" > < i class = "fa-fw fas fa-print" > < / i > < / a >
< / div >
< 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/introduction/index.html" title = "Introduction (🡐)" > < 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/introduction/tools/index.html" title = "Tool Integration (🡒)" > < i class = "fa-fw fas fa-chevron-right" > < / i > < / a >
2024-04-07 19:58:38 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-more" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "More" > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< div class = "topbar-area topbar-area-more" data-area = "more" >
< / div >
< / div >
< / div >
2024-04-07 19:58:38 +00:00
< / div >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
2024-10-13 14:26:50 +00:00
< main id = "R-body-inner" class = "highlightable introduction" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2024-10-13 14:26:50 +00:00
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2024-10-13 14:26:50 +00:00
< h1 id = "getting-started" > Getting Started< / h1 >
2022-07-05 22:16:52 +00:00
2024-10-13 14:26:50 +00:00
< p > Here’ s how to start your new website. If you’ re new to Hugo, we recommend learning more about it in its excellent < a href = "https://gohugo.io/getting-started/" rel = "external" target = "_self" > starter’ s guide< / a > .< / p >
< h2 id = "install-hugo" > Install Hugo< / h2 >
< p > Download and install Hugo < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.126.0< / span > < / span > or newer for your operating system < a href = "https://gohugo.io/installation/" rel = "external" target = "_self" > following the instructions< / a > .< / p >
< p > The < em > standard< / em > edition of Hugo is sufficient but you can also use the < em > extended< / em > edition.< / p >
2024-04-22 19:14:35 +00:00
< h2 id = "create-your-project" > Create your Project< / h2 >
2024-10-13 14:26:50 +00:00
< p > Use Hugo’ s < code > new site< / code > command to make a new website< / p >
2024-09-05 18:03:19 +00:00
< 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 site my-new-site< / span > < / span > < / code > < / pre > < / div >
2024-10-13 14:26:50 +00:00
< p > Then move into the new directory< / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< p > Run all future commands from this directory.< / p >
2024-04-22 19:14:35 +00:00
< h2 id = "install-the-theme" > Install the Theme< / h2 >
2024-10-13 14:26:50 +00:00
< h3 id = "download-as-a-zip-file" > Download as a Zip File< / h3 >
< p > You can < a href = "https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" rel = "external" target = "_self" > download the theme as a .zip file< / a > and unzip it into the < code > themes/hugo-theme-relearn< / code > directory.< / p >
< p > Then add this at the top of your < code > hugo.toml< / code > < / p >
2024-04-22 19:14:35 +00:00
< 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" >
2024-09-05 18:03:19 +00:00
< 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 >
2024-04-22 19:14:35 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-09-05 18:03:19 +00:00
< 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 >
2024-04-22 19:14:35 +00:00
< / 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 >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-04-22 19:14:35 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "use-hugos-module-system" > Use Hugo’ s Module System< / h3 >
< p > Install the Relearn theme using < a href = "https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" rel = "external" target = "_self" > Hugo’ s module system< / a > < / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< p > Then add this at the end of your < code > hugo.toml< / code > < / p >
2024-04-22 19:14:35 +00:00
< 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 >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > path< / span > < span class = "p" > =< / span > < span class = "s1" > ' github.com/McShelby/hugo-theme-relearn' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-04-22 19:14:35 +00:00
< / 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" >
2024-09-05 18:03:19 +00:00
< / 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 >
2024-04-22 19:14:35 +00:00
< / 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" > " module" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " imports" < / 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" > " path" < / span > < span class = "p" > :< / span > < span class = "s2" > " github.com/McShelby/hugo-theme-relearn" < / 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 >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-04-22 19:14:35 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "use-as-a-git-submodule" > Use as a Git Submodule< / h3 >
< p > If you’ re using < a href = "https://git-scm.com/" rel = "external" target = "_self" > Git< / a > for your project, you can create a repository now< / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< p > Add the theme as a Git submodule< / p >
2024-09-05 18:03:19 +00:00
< 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 --depth < span class = "m" > 1< / span > https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearn< / span > < / span > < / code > < / pre > < / div >
2024-10-13 14:26:50 +00:00
< p > Then add this at the top of your < code > hugo.toml< / code > < / p >
2024-03-02 10:05:50 +00:00
< 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" >
2024-09-05 18:03:19 +00:00
< 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 >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-09-05 18:03:19 +00:00
< 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 >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< 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 >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " theme" < / span > < span class = "p" > :< / span > < span class = "s2" > " hugo-theme-relearn" < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-03-15 20:10:54 +00:00
< h2 id = "create-your-home-page" > Create your Home Page< / h2 >
2024-10-13 14:26:50 +00:00
< p > Start by making a home page< / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-15 16:12:49 +00:00
< p > The new home page file < code > content/_index.md< / code > has two parts: the page info (like < code > title< / code > ) at the top, called < a href = "https://gohugo.io/content-management/front-matter/" rel = "external" target = "_self" > front matter< / a > , and the page content below.< / p >
2024-03-15 20:10:54 +00:00
< h2 id = "create-your-first-chapter-page" > Create your First Chapter Page< / h2 >
2024-10-13 14:26:50 +00:00
< p > Chapters are top-level pages that contain other pages. They have a special layout.< / p >
< p > Make your first chapter page< / 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 first-chapter/_index.md< / span > < / span > < / code > < / pre > < / div >
< p > The new file < code > content/first-chapter/_index.md< / code > has a < code > weight< / code > number in the front matter. This sets the chapter’ s subtitle and its order in the menu.< / p >
2024-03-15 20:10:54 +00:00
< h2 id = "create-your-first-content-pages" > Create your First Content Pages< / h2 >
2024-10-13 14:26:50 +00:00
< p > Now make content pages inside the chapter. Here are three ways to do this< / 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 first-chapter/first-page/_index.md
< / span > < / span > < span class = "line" > < span class = "cl" > hugo new first-chapter/second-page/index.md
< / span > < / span > < span class = "line" > < span class = "cl" > hugo new first-chapter/third-page.md< / span > < / span > < / code > < / pre > < / div >
< p > Hugo treats these files differently based on their file names. Learn more in < a href = "https://gohugo.io/content-management/" rel = "external" target = "_self" > Hugo’ s guide< / a > .< / p >
< p > Feel free to edit these files. Change the < code > title< / code > , add a < code > weight< / code > if you want, and write your content.< / p >
< h2 id = "test-your-website-locally" > Test your Website Locally< / h2 >
< p > Start your new website on your computer with this command< / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< p > Open < a href = "http://localhost:1313" rel = "external" target = "_self" > http://localhost:1313< / a > in your web browser.< / p >
< p > You can keep the server running while you edit. The browser will update automatically when you save changes.< / p >
< figure > < a href = "https://gohugo.io" > < img src = "/hugo-theme-relearn/introduction/quickstart/magic.gif"
alt="Magic">< / a > < figcaption >
< p > It’ s a kind of magic< / p >
< / figcaption >
< / figure >
2024-04-22 19:14:35 +00:00
< h2 id = "build-and-deploy-your-website" > Build and Deploy your Website< / h2 >
2024-10-13 14:26:50 +00:00
< p > When your site is ready to go live, run this command< / p >
2024-09-05 18:03:19 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< p > This creates a < code > public< / code > directory with all your website files.< / p >
< p > You can upload this directory to any web server, or use one of < a href = "https://gohugo.io/hosting-and-deployment/" rel = "external" target = "_self" > Hugo’ s many other ways to publish< / a > .< / p >
< h2 id = "next-steps" > Next Steps< / h2 >
< p > Your site is now fully functional.< / p >
< p > You can continue < a href = "/hugo-theme-relearn/configuration/index.html" > configuring your site< / a > to your needs.< / p >
< p > Or just start < a href = "/hugo-theme-relearn/authoring/index.html" > authoring content< / a > and discover what’ s possible.< / p >
2023-05-17 22:13:41 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/tutorial/index.html" > Tutorial< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
2022-04-02 13:30:16 +00:00
< / div >
< / main >
< / div >
2024-10-24 15:36:57 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1729784203" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1729784203" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1729784203" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
