<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Change of behavior, may require action</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> New behavior, often introducing new options</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The sidebar menus are now <ahref="/hugo-theme-relearn/configuration/sidebar/menus/index.html">completely configurable</a>.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The <ahref="/hugo-theme-relearn/shortcodes/children/index.html"><code>children</code> shortcode</a> was changed to output a page’s <em>LinkTitle</em> instead of previously using the <em>Title</em>.</p>
<p>As the shortcode always outputs subpages in context of the parent page, it functions similar to the sidebar menu. The sidebar menu itself uses the <em>LinkTitle</em> for naming the menu entries and so should the shortcode do.</p>
<p>The parameter value <code>sort=linktitle</code> was deprecated for the easier <code>sort=title</code>. You can still use the old value but both behave the same way in sorting by <em>LinkTitle</em>.</p>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Menus created by your page structure are now able to <ahref="/hugo-theme-relearn/configuration/sidebar/menus/index.html#displaying-arbitrary-links-in-a-page-menu">contain arbitrary links</a> inserted into the structure using the <code>menuUrl</code> or <code>menuPageRef</code> front matter.
<li><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.126.0</span></span> This release requires a newer Hugo version.</li>
</ul>
<h3id="breaking">Breaking</h3>
<ul>
<li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme</p>
<ul>
<li>suffered from poor build performance for sites with 1000 or more pages</li>
<li>reinvented the wheel instead of using available Hugo mechanisms</li>
<p><em>What do I gain</em>, you may ask. A significant performance boost during build! Usually, the build time has been cut at least in half for bigger sites. It is now possible to build even larger sites with 5000 or more pages. This was previously almost impossible due to rapidly increasing build time with the more pages you’ve introduced. For even bigger sites, the theme now has <ahref="/hugo-theme-relearn/configuration/sidebar/menus/index.html#expander-for-submenus">configurable performance optimizations</a> - at the price of feature limitations.</p>
<p>If you haven’t done customizations to any partials, you can update right away.</p>
<p>If you have customized your templates, in the best cases, you will get build warnings or even errors. In the worst cases, your build succeeds but the site will not work as intended by you.</p>
<p>Specifically, you will have to adapt your site if you have</p>
<ul>
<li><ahref="/hugo-theme-relearn/configuration/customization/partials/index.html">overwritten the <code>header.html</code>, <code>menu.html</code> or <code>footer.html</code> partials</a></li>
<li>self-defined archetype partials in <code>layouts/partials/archetypes</code> - now becoming <ahref="/hugo-theme-relearn/configuration/customization/designs/index.html">page designs</a></li>
<li><ahref="/hugo-theme-relearn/configuration/customization/topbar/index.html">overwritten prev/next topbar buttons</a> - needs sync with implementation changes</li>
</ul>
</li>
<li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> This release changes the way the search index and the dedicated search page are generated. This may require reconfiguration by you to still work as you have intended.</p>
<p>You need to remove the now obsolete <code>search</code> and <code>searchpage</code> output format from <code>[outputs.home]</code> in your <code>hugo.toml</code>, resulting in something similar to</p>
<p>After that, your build will succeed but will most likely cause new defaults to be applied. With no further settings, in-page search, search popup and dedicated search page are all active by default. This can be reconfigured.</p>
<p>In addition, you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing <code>searchIndexURL</code> and <code>searchPageURL</code> respectively in your <code>hugo.toml</code>.</p>
<p>See the <ahref="/hugo-theme-relearn/configuration/sidebar/search/index.html">updated documentation</a> for reference.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Once again, the theme changed the font. We switched to the excellent <ahref="https://github.com/googlefonts/roboto-flex"rel="external"target="_self">Roboto Flex</a> font.</p>
<p>Care was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance.</p>
<p>This change was necessary as the previously used font had display issues with <ahref="/hugo-theme-relearn/authoring/markdown/index.html#marked-text">marked text</a>, contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.</p>
<p>The font was created by Google, is licensed under OFL 1.1 and is delivered from your theme’s installation. As always, no third-party server calls are involved.</p>
<p>If you have changed the <code>font-family</code> in your installation, you most likely have to adjust the variables <code>--MAIN-font-weight</code>, <code>--MAIN-BOLD-font-weight</code> and <code>--MAIN-letter-spacing</code>.</p>
<p>Additionally, if you have changed the font to a <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_fonts/Variable_fonts_guide#variable_fonts_what_they_are_and_how_they_differ"rel="external"target="_self">variable font</a> in your installation, you may have to adjust the variable <code>--MAIN-font-variation-settings</code>. As this only applies to <strong>variable fonts</strong>, this should rarely be necessary.</p>
</li>
<li>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> While switching the font, it was discovered that certain CSS variables were falsely named. You don’t need to change anything in your custom variant stylesheet as the old names will be used as a fallback.</p>
<p><code>--MAIN-TITLES-TEXT-font</code> was renamed to <code>--MAIN-TITLES-font</code>, <code>--MAIN-TITLES-H<n>-color</code> was renamed to <code>--MAIN-TITLES-H<n>-TEXT-color</code>.</p>
</li>
<li>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The options and front matter to force loading a <ahref="/hugo-theme-relearn/shortcodes/math/index.html#force-loading-of-the-mathjax-library">math</a>, <ahref="/hugo-theme-relearn/shortcodes/mermaid/index.html#force-loading-of-the-mermaid-library">mermaid</a> or <ahref="/hugo-theme-relearn/shortcodes/openapi/index.html#force-loading-of-the-swagger-ui-library">openapi</a> library has been changed.</p>
<p>Previously, you had to set the unintuitive <code>disableMathJax=false</code> to force load the math library in case of a passthrough configuration. This is replaced by the simpler <code>math=true</code> or <code>math.force=true</code> and is now in line with <ahref="https://gohugo.io/content-management/mathematics/#step-1"rel="external"target="_self">Hugo’s official documentation</a>.</p>
<p>You don’t need to change anything yet but will receive warnings if the old settings are used.</p>
</li>
<li>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The default logo is not contained inside of the theme’s logo partial anymore.</p>
<p>This is to avoid usage of the theme’s branding throughout the web in non-modified installations.</p>
<p>In addition, the default text for the logo partial is now <ahref="/hugo-theme-relearn/configuration/sidebar/headerfooter/index.html#title">taken from the <code>linkTitle</code> setting</a> of your <code>hugo.toml</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The docs received a much-needed overhaul for all chapters.</p>
<p>Basically, the structure was reorganized, giving each topic its own page while keeping the amount of items for each menu level comprehensible by adding sub-pages.</p>
<p>The docs now clearly differentiate between <ahref="/hugo-theme-relearn/configuration/index.html">configuration of your site</a>, all things <ahref="/hugo-theme-relearn/authoring/index.html">writing page content</a> and the <ahref="/hugo-theme-relearn/shortcodes/index.html">shortcodes docs</a> that cover both topics, configuration and usage.</p>
<p>To give you a better overview of what’s possible with the theme, we introduced reference pages for all theme <ahref="/hugo-theme-relearn/configuration/reference/index.html">configuration options</a> and <ahref="/hugo-theme-relearn/authoring/frontmatter/reference/index.html">front matter</a> and mark each occurrence of such on all pages with the badges <spanclass="badge cstyle cyan badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-gears"></i></span><spanclass="badge-content">Option</span></span> and <spanclass="badge cstyle green badge-with-title"><spanclass="badge-title"><iclass="fa-fw fab fa-markdown"></i></span><spanclass="badge-content">Front Matter</span></span>.</p>
<p>Also, a lot of previously undocumented features are now included, namely</p>
<li>configuring <ahref="/hugo-theme-relearn/configuration/content/titles/index.html">breadcrumb, titles</a> and <ahref="/hugo-theme-relearn/configuration/content/headings/index.html">headings</a> of your content</li>
<li><ahref="/hugo-theme-relearn/configuration/content/linking/index.html">options for using links</a></li>
