hugo-theme-relearn/introduction/upgrade/index.print.html

204 lines
15 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article" data-r-output-format="print">
<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.140.2">
<meta name="generator" content="Relearn 7.2.1+64ffb39f359a8d4d2f3fb8e264401c5b8d1016cf">
<meta name="description" content="How to upgrade your Relearn site">
<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="Upgrade :: Hugo Relearn Theme">
<meta name="twitter:description" content="How to upgrade your Relearn site">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/introduction/upgrade/index.html">
<meta property="og:site_name" content="Hugo Relearn Theme">
<meta property="og:title" content="Upgrade :: Hugo Relearn Theme">
<meta property="og:description" content="How to upgrade your Relearn site">
<meta property="og:locale" content="en">
<meta property="og:type" content="website">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="name" content="Upgrade :: Hugo Relearn Theme">
<meta itemprop="description" content="How to upgrade your Relearn site">
<meta itemprop="wordCount" content="421">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="keywords" content="Tutorial">
<title>Upgrade :: Hugo Relearn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/introduction/upgrade/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/introduction/upgrade/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/introduction/upgrade/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/introduction/upgrade/index.html" rel="canonical" type="text/html" title="Upgrade :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/introduction/upgrade/index.xml" rel="alternate" type="application/rss+xml" title="Upgrade :: Hugo Relearn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1735765081" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1735765081" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1735765081" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/auto-complete.css?1735765081" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1735765081" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1735765081" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme.min.css?1735765081" rel="stylesheet">
<link href="/hugo-theme-relearn/css/format-print.min.css?1735765081" rel="stylesheet" id="R-format-style">
<script>
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..';
window.relearn.relBaseUri='..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
window.relearn.min = `.min`;
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
// variant stuff
window.relearn.themevariants = [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ];
window.relearn.customvariantname = "my-custom-variant";
window.relearn.changeVariant = function(variant) {
var oldVariant = document.documentElement.dataset.rThemeVariant;
window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant);
document.documentElement.dataset.rThemeVariant = variant;
if (oldVariant != variant) {
document.dispatchEvent( new CustomEvent('themeVariantLoaded', { detail: { variant, oldVariant } }) );
}
}
window.relearn.markVariant = function() {
var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant");
var select = document.querySelector("#R-select-variant");
if (select) {
select.value = variant;
}
}
window.relearn.initVariant = function() {
var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant") ?? "";
if( variant == window.relearn.customvariantname ){
}else if( !variant || !window.relearn.themevariants.includes(variant) ){
variant = window.relearn.themevariants[0];
window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant);
}
document.documentElement.dataset.rThemeVariant = variant;
}
window.relearn.initVariant();
window.relearn.markVariant();
// 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}"`;
</script>
<script src="/hugo-theme-relearn/js/variant.js?1735765081"></script>
<style>
#R-body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/introduction/upgrade/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&#43;ALT&#43;n)"><i class="fa-fw fas fa-bars"></i></button>
</div>
<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&#43;ALT&#43;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="#planning-the-update">Planning the Update</a></li>
<li><a href="#update-the-theme">Update 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&rsquo;s Module System</a></li>
<li><a href="#use-as-a-git-submodule">Use as a Git Submodule</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</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/introduction/index.html"><span itemprop="name">Introduction</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Upgrade</span><meta itemprop="position" content="2"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
<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/upgrade/_index.en.md" target="_self" title="Edit (CTRL&#43;ALT&#43;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/upgrade/index.print.html" title="Print whole chapter (CTRL&#43;ALT&#43;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/quickstart/index.html" title="Getting Started (🡐)"><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>
</div>
<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>
</div>
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable introduction" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
</header>
<h1 id="upgrade">Upgrade</h1>
<p>Consider Hugo and the theme one unit. If you update the theme, in many cases, you need also to update Hugo and vice versa.</p>
<p>The <a href="/hugo-theme-relearn/introduction/releasenotes/index.html">releasenotes of the theme</a> mention if a newer version of Hugo is required.</p>
<p>Note, that it is only necessary to update if you are experiencing fixed bugs or want to use new features. It is perfectly fine to stay with arbitrary old versions of Hugo and the theme if everything works for you.</p>
<h2 id="planning-the-update">Planning the Update</h2>
<p>Depending on your previously used version of Hugo and the theme, you might need to update files of your project.</p>
<p>Usually the <a href="/hugo-theme-relearn/introduction/releasenotes/index.html">releasenotes of the theme</a> help you with theme related changes.</p>
<p>During build of your project the console may show further warnings or errors with hints of what&rsquo;s wrong and how to fix it.</p>
<p>Note that these <a href="https://gohugo.io/troubleshooting/deprecation" rel="external" target="_self">hints may be removed after a while</a> by Hugo or the theme. In case you are updating from rather far beyond versions, consider to do the update in steps:</p>
<p>Say, you are using Relearn 4.0.1 and want to update your project to the latest version (say 7.2.1):</p>
<ul>
<li>find out the <a href="/hugo-theme-relearn/introduction/changelog/4/index.html">last theme release of version 4</a> (which is 4.2.5) and the <a href="/hugo-theme-relearn/introduction/releasenotes/4/index.html">required Hugo version</a> (at least 0.93.0, <a href="/hugo-theme-relearn/introduction/releasenotes/3/index.html">taken from the releasenotes of version 3</a> as version 4 did not raise the Hugo version) and update</li>
<li>run <code>hugo server</code> and fix any errors</li>
<li>find out the <a href="/hugo-theme-relearn/introduction/changelog/5/index.html">last theme release of version 5</a> (which is 5.27.0) and the <a href="/hugo-theme-relearn/introduction/releasenotes/5/index.html">required Hugo version</a> (at least 0.121.0) and update</li>
<li>run <code>hugo server</code> and fix any errors</li>
<li>etc. until done</li>
</ul>
<p>This procedure may lead to more work than updating in one single step, but it will be far easier to fix errors and can be divided into smaller units of work.</p>
<h2 id="update-the-theme">Update the Theme</h2>
<p>Updating the theme depends on the way <a href="/hugo-theme-relearn/introduction/quickstart/index.html#install-the-theme">how you&rsquo;ve installed it</a>.</p>
<p>Run all following commands from the root of your Hugo project.</p>
<h3 id="download-as-a-zip-file">Download as a Zip File</h3>
<ul>
<li>Remove the old version of the theme by removing the <code>themes/hugo-theme-relearn</code> directory.</li>
<li><a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_self">Pick a certain version</a> of theme, download it as a .zip file and unzip it into the <code>themes/hugo-theme-relearn</code> directory</li>
</ul>
<h3 id="use-hugos-module-system">Use Hugo&rsquo;s Module System</h3>
<p>Update the Relearn theme using <a href="https://gohugo.io/hugo-modules/use-modules/#update-one-module" rel="external" target="_self">Hugo&rsquo;s module system</a> to a certain version. Eg. to update to version 7.2.1</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 mod get -u github.com/McShelby/hugo-theme-relearn@7.2.1</span></span></code></pre></div>
<h3 id="use-as-a-git-submodule">Use as a Git Submodule</h3>
<p>Update the Relearn theme using <a href="https://git-scm.com/" rel="external" target="_self">Git</a> to a certain version. Eg. to update to version 7.2.1</p>
<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 update --remote --depth <span class="m">1</span> --force themes/hugo-theme-relearn
</span></span><span class="line"><span class="cl">git -C themes/hugo-theme-relearn fetch --tags
</span></span><span class="line"><span class="cl">git -C themes/hugo-theme-relearn checkout 7.2.1</span></span></code></pre></div>
<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>
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1735765081" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1735765081" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1735765081" defer></script>
</body>
</html>