mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 18:53:18 +00:00
15765 lines
1.2 MiB
15765 lines
1.2 MiB
<!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.125.1">
|
||
<meta name="generator" content="Relearn 5.27.0+tip">
|
||
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
||
<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="Hugo Relearn Theme">
|
||
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
|
||
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/index.html">
|
||
<meta property="og:site_name" content="Hugo Relearn Theme">
|
||
<meta property="og:title" content="Hugo Relearn Theme">
|
||
<meta property="og:description" content="A theme for Hugo designed for documentation.
|
||
★ What&rsquo;s new in the latest release ★
|
||
Motivation The theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adapting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.
|
||
Features Wide set of usage scenarios Responsive design for mobile usage Looks nice on paper (if it has to) Usable offline, no external dependencies Usable from your local file system via file:// protocol Support for the VSCode Front Matter extension for on-premise CMS capabilities Support for Open Graph and Twitter Cards Configurable theming and visuals Configurable brand images Automatic switch for light/dark variant depending on your OS settings Predefined light, dark and color variants User selectable variants Stylesheet generator Configurable syntax highlighting Unique theme features Print whole chapters or even the complete site In page search Site search Dedicated search page Taxonomy support Configurable topbar buttons Unlimited nested menu items Configurable shortcut links Hidden pages Multi language support Full support for languages written right to left Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support for mixed language content Additional Markdown features Support for GFM (GitHub Flavored Markdown) Image effects like sizing, shadow, border and alignment Image lightbox Shortcodes galore Display resources contained in a page bundle Marker badges Configurable buttons List child pages Expand areas to reveal content Font Awesome icons Inclusion of other files Math and chemical formulae using MathJax Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.">
|
||
<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">
|
||
<title>Hugo Relearn Theme</title>
|
||
<link href="https://mcshelby.github.io/hugo-theme-relearn/index.html" rel="alternate" hreflang="x-default">
|
||
<link href="https://mcshelby.github.io/hugo-theme-relearn/index.html" rel="alternate" hreflang="en">
|
||
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/index.html" rel="alternate" hreflang="art-pir">
|
||
<link href="https://mcshelby.github.io/hugo-theme-relearn/index.html" rel="canonical" type="text/html" title="Hugo Relearn Theme">
|
||
<link href="/hugo-theme-relearn/index.xml" rel="alternate" type="application/rss+xml" title="Hugo Relearn Theme">
|
||
<link href="/hugo-theme-relearn/images/logo.svg?1713557920" rel="icon" type="image/svg+xml">
|
||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1713557920" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1713557920" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/nucleus.css?1713557920" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/auto-complete.css?1713557920" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1713557920" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1713557920" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/fonts.css?1713557920" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1713557920" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/theme.css?1713557920" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1713557920" rel="stylesheet" id="R-variant-style">
|
||
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1713557920" rel="stylesheet" id="R-variant-chroma-style">
|
||
<link href="/hugo-theme-relearn/css/variant.css?1713557920" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/print.css?1713557920" rel="stylesheet" media="print">
|
||
<link href="/hugo-theme-relearn/css/format-print.css?1713557920" rel="stylesheet">
|
||
<script src="/hugo-theme-relearn/js/variant.js?1713557920"></script>
|
||
<script>
|
||
window.relearn = window.relearn || {};
|
||
window.relearn.relBasePath='.';
|
||
window.relearn.relBaseUri='..';
|
||
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
||
window.index_js_url="/hugo-theme-relearn/index.search.js";
|
||
// variant stuff
|
||
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' ] );
|
||
// 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>
|
||
<style>
|
||
#R-body img.bg-white {
|
||
background-color: white;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/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+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
||
</div>
|
||
</div>
|
||
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||
</ol>
|
||
<div class="topbar-area topbar-area-end" data-area="end">
|
||
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><span class="topbar-control"><i class="fa-fw fas fa-chevron-left"></i></span>
|
||
</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/basics/index.html" title="Basics (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<div id="R-main-overlay"></div>
|
||
<main id="R-body-inner" class="highlightable home" tabindex="-1">
|
||
<div class="flex-block-wrapper">
|
||
<article class="home">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="hugo-relearn-theme">Hugo Relearn Theme</h1>
|
||
|
||
<p>A theme for <a href="https://gohugo.io/" rel="external" target="_blank">Hugo</a> designed for documentation.</p>
|
||
<p><a href="/hugo-theme-relearn/basics/migration/index.html">★ What’s new in the latest release ★</a></p>
|
||
<p><a href="#R-image-3e2c3bccfbc8e0730242bade421a1fef" class="lightbox-link"><img alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/images/hero.png" style=" height: auto; width: auto;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3e2c3bccfbc8e0730242bade421a1fef"><img alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/images/hero.png"></a></p>
|
||
<h2 id="motivation">Motivation</h2>
|
||
<p>The theme is a fork of the great <a href="https://github.com/matcornic/hugo-theme-learn" rel="external" target="_blank">Learn theme</a> with the aim of fixing long outstanding bugs and adapting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.</p>
|
||
<h2 id="features">Features</h2>
|
||
<ul>
|
||
<li><strong>Wide set of usage scenarios</strong>
|
||
<ul>
|
||
<li>Responsive design for mobile usage</li>
|
||
<li>Looks nice on paper (if it has to)</li>
|
||
<li>Usable offline, no external dependencies</li>
|
||
<li><a href="/hugo-theme-relearn/basics/customization/index.html#file-system">Usable from your local file system via <code>file://</code> protocol</a></li>
|
||
<li>Support for the <a href="https://github.com/estruyf/vscode-front-matter" rel="external" target="_blank">VSCode Front Matter extension</a> for on-premise CMS capabilities</li>
|
||
<li><a href="/hugo-theme-relearn/basics/customization/index.html#social-media-meta-tags">Support for Open Graph and Twitter Cards</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Configurable theming and visuals</strong>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/basics/branding/index.html#change-the-logo">Configurable brand images</a></li>
|
||
<li><a href="/hugo-theme-relearn/basics/branding/index.html#adjust-to-os-settings">Automatic switch for light/dark variant depending on your OS settings</a></li>
|
||
<li>Predefined light, dark and color variants</li>
|
||
<li><a href="/hugo-theme-relearn/basics/branding/index.html#multiple-variants">User selectable variants</a></li>
|
||
<li><a href="/hugo-theme-relearn/basics/generator/index.html">Stylesheet generator</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/highlight/index.html">Configurable syntax highlighting</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Unique theme features</strong>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/basics/customization/index.html#activate-print-support">Print whole chapters or even the complete site</a></li>
|
||
<li>In page search</li>
|
||
<li><a href="/hugo-theme-relearn/basics/customization/index.html#activate-search">Site search</a></li>
|
||
<li><a href="/hugo-theme-relearn/basics/customization/index.html#activate-dedicated-search-page">Dedicated search page</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/taxonomy/index.html">Taxonomy support</a></li>
|
||
<li><a href="/hugo-theme-relearn/basics/topbar/index.html">Configurable topbar buttons</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/pages/index.html">Unlimited nested menu items</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/menushortcuts/index.html">Configurable shortcut links</a></li>
|
||
<li>Hidden pages</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Multi language support</strong>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/cont/i18n/index.html">Full support for languages written right to left</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/i18n/index.html#basic-configuration">Available languages</a>: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese</li>
|
||
<li><a href="/hugo-theme-relearn/cont/i18n/index.html#search">Search support for mixed language content</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Additional Markdown features</strong>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/cont/markdown/index.html">Support for GFM (GitHub Flavored Markdown)</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/markdown/index.html#image-effects">Image effects like sizing, shadow, border and alignment</a></li>
|
||
<li><a href="/hugo-theme-relearn/cont/markdown/index.html#lightbox">Image lightbox</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Shortcodes galore</strong>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/index.html">Display resources contained in a page bundle</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/badge/index.html">Marker badges</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/button/index.html">Configurable buttons</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/index.html">List child pages</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/expand/index.html">Expand areas to reveal content</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/icon/index.html">Font Awesome icons</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/include/index.html">Inclusion of other files</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/math/index.html">Math and chemical formulae using MathJax</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/mermaid/index.html">Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/notice/index.html">Colorful boxes</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/openapi/index.html">OpenAPI specifications using Swagger UI</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/siteparam/index.html">Reveal you site’s configuration parameter</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/tab/index.html">Single tabbed panels</a> and <a href="/hugo-theme-relearn/shortcodes/tabs/index.html">multiple tabbed panels</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="support">Support</h2>
|
||
<p>To get support, feel free to open a new <a href="https://github.com/McShelby/hugo-theme-relearn/discussions" rel="external" target="_blank">discussion topic</a> or <a href="https://github.com/McShelby/hugo-theme-relearn/issues" rel="external" target="_blank">issue report</a> in the official repository on GitHub.</p>
|
||
<h2 id="contributions">Contributions</h2>
|
||
<p>Feel free to contribute to this documentation by just clicking the <span class="btn cstyle transparent"><span><i class="fa-fw fas fa-pen"></i></span></span> <em>edit</em> button displayed on top right of each page.</p>
|
||
<p>You are most welcome to contribute bugfixes or new features by making pull requests to the <a href="https://github.com/McShelby/hugo-theme-relearn" rel="external" target="_blank">official repository</a>. Check the <a href="/hugo-theme-relearn/dev/contributing/index.html">contribution guidelines</a> first before starting.</p>
|
||
<h2 id="license">License</h2>
|
||
<p>The Relearn theme is licensed under the <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE" rel="external" target="_blank">MIT License</a>.</p>
|
||
<h2 id="credits">Credits</h2>
|
||
<p>This theme would not be possible without the work of <a href="/hugo-theme-relearn/more/credits/index.html">many others</a>.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Hugo Relearn Theme</h1>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">Chapter 1</div>
|
||
|
||
<h1 id="basics">Basics</h1>
|
||
|
||
<p>Discover what this Hugo theme is all about and the core-concepts behind it.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Basics</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="whats-new">What's New</h1>
|
||
|
||
<p>This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the <a href="/hugo-theme-relearn/basics/history/index.html">history page</a>.</p>
|
||
<ul>
|
||
<li>
|
||
<p><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.121.0</span></span> The minimum required Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> A change that requires action by you after upgrading to assure the site is still functional.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A change in default behavior that may requires action by you if you want to revert it.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Marks new behavior you might find interesting or comes configurable.</p>
|
||
</li>
|
||
</ul>
|
||
<!--GH-ACTION-RELEASE-MILESTONE-->
|
||
<hr>
|
||
<h2 id="600">6.0.0.beta (XXXX-XX-XX)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> This release requires you to move your self-defined variant (<code>theme-*.css</code>) and chroma stylesheets (<code>chroma-*.css</code>) from <code>static/css</code> to <code>assets/css</code>.</p>
|
||
<p>This was necessary to avoid permission errors on build if running in certain Unix configurations.</p>
|
||
<p>In addition it is not allowed anymore to <code>@import</code> your chroma stylesheet from inside of your variant stylesheet.</p>
|
||
<p>Say, your chroma stylesheet is named <code>chroma-monokai.css</code>, you have to add the following inside your variant stylesheet:</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="nt">--CODE-theme</span><span class="o">:</span> <span class="nt">monokai</span><span class="o">;</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> Support for Internet Explorer 11 was finally dropped.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Removing support for Internet Explorer 11 allowed to upgrade Font Awesome to version 6.5.2.</p>
|
||
<p>You may experience slight changes for some icons. In addition you have additional ~1700 icons <a href="https://fontawesome.com/v6/search?m=free" rel="external" target="_blank">to chose</a> from.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <a href="/hugo-theme-relearn/shortcodes/include/index.html"><code>include</code> shortcode</a> is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting <code>include.errorlevel</code> to either <code>warning</code> or <code>error</code> in your <code>hugo.toml</code> if a path can not be resolved.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Romanian.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5270">5.27.0 (2024-04-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.121.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If the theme is configured to generate warnings or errors during build by setting <code>image.errorlevel</code> to either <code>warning</code> or <code>error</code> in your <code>hugo.toml</code>, it will now also generate output if a link fragment is not found in the target page.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <a href="/hugo-theme-relearn/basics/customization/index.html#own-shortcodes-with-javascript-dependencies">dependency loader</a> was made more versatile.</p>
|
||
<p>The configuration in your <code>hugo.toml</code> does not require the <code>location</code> parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don’t need to change anything, yet.</p>
|
||
<p>With the new mechanism, your dependency loader now receives an additional <code>location</code> parameter instead that you can query to inject your dependencies in the desired location.</p>
|
||
<p>By that you can now call the dependency mechanism in your own overriden partials by giving it a distinct <code>location</code> parameter. In addition your injected files can now be spread to multiple locations which wasn’t previously possible.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Additional styling was added for the native HTML elements <code><mark></code> and <code><kbd></code>. To use them you must allow the <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_blank">usage of HTML</a> in your <code>hugo.toml</code>. The <a href="/hugo-theme-relearn/cont/markdown/index.html#standard-and-extensions">Markdown documentation</a> was enhanced for this.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You now can scroll forward and backward through all headings of a page by using <kbd>ALT</kbd> <kbd>🡑</kbd> and <kbd>ALT</kbd> <kbd>🡓</kbd>. This also works for the <code>PRINT</code> output format.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The breadcrumbs used in the topbar, search results and the taxonomy term lists are now using the pages frontmatter <code>linktitle</code> instead of <code>title</code> if set.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5260">5.26.0 (2024-03-18)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The lazy loading of images is now configurable by using the new <code>lazy</code> <a href="/hugo-theme-relearn/cont/imageeffects/index.html">image effect</a>. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It is now possible to <a href="/hugo-theme-relearn/basics/customization/index.html#change-the-main-areas-max-width">adjust the max width of the main area</a>, eg. in case you want to use the full page width for your content.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Images and Codefences are now respecting <a href="https://gohugo.io/content-management/markdown-attributes/" rel="external" target="_blank">Hugo’s Markdown attributes</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme has updated its Mermaid dependency to 10.6.0. This adds support for <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#block-diagram">block diagrams</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release fixes a long outstanding bug where the page wasn’t repositioning correctly when going forward or backward in your browser history.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5250">5.25.0 (2024-02-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> This release deprecates the <a href="/hugo-theme-relearn/shortcodes/attachments/index.html"><code>attachments</code> shortcode</a> in favor of the new the <a href="/hugo-theme-relearn/shortcodes/resources/index.html"><code>resources</code> shortcode</a>.</p>
|
||
<p>If you are using Hugo below <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.123.0</span></span>, you don’t need to change anything as the old shortcode still works (but may generate warnings).</p>
|
||
<p>Anyways, users are strongly advised to migrate as the <code>attachments</code> shortcode will not receive support anymore. Migration instructions are listed on the <a href="/hugo-theme-relearn/shortcodes/attachments/index.html#migration"><code>attachments</code> shortcode page</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If you run Hugo with <a href="https://gohugo.io/methods/page/gitinfo/" rel="external" target="_blank">GitInfo</a> configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the <code>content-footer.html</code> partial.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="5240">5.24.0 (2024-02-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.112.4</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The topbar button received a way to add text next to the icon. For this, the original <code>title</code> option was renamed to <code>hint</code> while the new <code>title</code> option is now displayed next to the icon.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The frontmatter option <code>menuTitle</code> is now deprecated in favor for Hugo’s own <code>linkTitle</code>. You don’t need to change anything as the old <code>menuTitle</code> option is still supported.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlighting in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as <a href="/hugo-theme-relearn/basics/branding/index.html#modify-shipped-variants">described here</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If the theme can not resolve a link to a page or image, you can now generate warnings or errors during build by setting <code>link.errorlevel</code> or <code>image.errorlevel</code> to either <code>warning</code> or <code>error</code> in your <code>hugo.toml</code> respectively. By default this condition is silently ignored and the link is written as-is.</p>
|
||
<p>Please note that a page link will generate false negatives if <code>uglyURLs=true</code> and it references an ordinary page before <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.123.0</span></span>.</p>
|
||
<p>Please note that an image link will generate false negatives if the file resides in your <code>static</code> directory.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You now can configure additional options for every theme variant in your <code>hugo.toml</code>. This allows for optional <a href="/hugo-theme-relearn/basics/branding/index.html#theme-variant-advanced">advanced functionality</a>. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).</p>
|
||
<p>The advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New partial for defining the heading. See <a href="/hugo-theme-relearn/basics/customization/index.html#partials">documentation</a> for further reading.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support for Hugo’s built-in <a href="https://gohugo.io/content-management/shortcodes/#figure" rel="external" target="_blank"><code>figure</code> shortcode</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> In additiion to the existing <a href="/hugo-theme-relearn/basics/customization/index.html#change-the-menu-width">menu width customization</a>, it is now also possible to set the width of the menu flyout for small screen sizes with the <code>--MENU-WIDTH-S</code> CSS property.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Improvements for accessibility when tabbing through the page for images, links and tab handles.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <code>editURL</code> config parameter is now <a href="/hugo-theme-relearn/cont/frontmatter/index.html">overwritable in your pages frontmatter</a>. In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable <code>${FilePath}</code> in your URL by the pages file path. You don’t need to change anything in your existing configuration as the old way without the replacement variable still works.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The themes <a href="/hugo-theme-relearn/basics/configuration/index.html">config</a> and <a href="/hugo-theme-relearn/cont/frontmatter/index.html">frontmatter</a> options received a comprehensive documentation update. In addition the theme switched from <code>config.toml</code> to <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility with Hugo versions <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.121.0</span></span> or higher for the <a href="/hugo-theme-relearn/shortcodes/highlight/index.html"><code>highlight</code> shortcode</a>. This does not change the minimum required Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility with Hugo versions <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.123.0</span></span> or higher for theme specific <a href="/hugo-theme-relearn/basics/customization/index.html">output formats</a> and handling of taxonomy and term titles. This does not change the minimum required Hugo version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5230">5.23.0 (2023-11-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> With <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.120.0</span></span> the author settings move into the <code>[params]</code> array in your <code>hugo.toml</code>. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.</p>
|
||
<p>Change your previous setting from</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">author</span> <span class="p">=</span> <span class="s1">'Hugo'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">author</span><span class="p">:</span><span class="w"> </span><span class="l">Hugo</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"author"</span><span class="p">:</span> <span class="s2">"Hugo"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>to</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">author</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Hugo'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">author</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Hugo</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"author"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Hugo"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Taxonomy <a href="https://gohugo.io/content-management/taxonomies#add-custom-metadata-to-a-taxonomy-or-term" rel="external" target="_blank">term pages</a> now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your <code>hugo.toml</code> by adding <code>disableTermBreadcrumbs=true</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It is now possible to print custom taxonomies anywhere in your page. <a href="/hugo-theme-relearn/cont/taxonomy/index.html#customization">See the docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It is now possible to adjust the menu width for your whole site. <a href="/hugo-theme-relearn/basics/customization/index.html#change-the-menu-width">See the docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. <a href="/hugo-theme-relearn/basics/customization/index.html#social-media-meta-tags">See the docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release comes with additional sort options for the menu and the <a href="/hugo-theme-relearn/shortcodes/children/index.html"><code>children</code> shortcode</a>. Both will now accept the following values: <code>weight</code>, <code>title</code>, <code>linktitle</code>, <code>modifieddate</code>, <code>expirydate</code>, <code>publishdate</code>, <code>date</code>, <code>length</code> or <code>default</code> (adhering to Hugo’s default sort order).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. <a href="/hugo-theme-relearn/basics/customization/index.html#own-shortcodes-with-javascript-dependencies">See the docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme has updated its Mermaid dependency to 10.6.0. This adds support for the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#xychart">xychart type</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release adds portable Markdown links.</p>
|
||
<p>Previously it was not possible to use pure Markdown links in a configuration independent way to link to pages inside of your project. It always required you to know how your <code>uglyURLs</code> setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. <code>[generator](generator/index.html)</code> vs. <code>[generator](generator.html)</code>). This is a hassle as you have to change these links manually once you change your <code>uglyURLs</code> setting or change the type of a page.</p>
|
||
<p>You could work around this by using the <code>relref</code> shortcode (eg <code>[generator]({{% relref "../generator" %}})</code>) which works but results in non-portable Markdown.</p>
|
||
<p>Now it’s possible to use the same path of a call to <code>relref</code> in a plain Markdown link (eg <code>[generator](../generator)</code>). This is independent of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so <code>[generator](generator/index.html)</code> will work as before.</p>
|
||
<p>The following types of linking are supported:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>link</th>
|
||
<th>description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>[generator](en/basics/generator)</code></td>
|
||
<td>absolute from your project root (multilang)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](/en/basics/generator)</code></td>
|
||
<td>absolute from your project root (multilang)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](basics/generator)</code></td>
|
||
<td>absolute from your current language root</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](/basics/generator)</code></td>
|
||
<td>absolute from your current language root</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](./../generator)</code></td>
|
||
<td>relative from the current page</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](../generator)</code></td>
|
||
<td>relative from the current page</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5220">5.22.0 (2023-10-02)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with <code>R-</code>.</p>
|
||
<p>If you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> You can now have structural sections in the hierarchical menu without generating a page for it.</p>
|
||
<p>This can come in handy, if content for such a section page doesn’t make much sense to you. See <a href="/hugo-theme-relearn/cont/frontmatter/index.html#disable-section-pages">the documentation</a> for how to do this.</p>
|
||
<p>This feature may require you to make changes to your existing installation if you are already using <em><a href="/hugo-theme-relearn/cont/menushortcuts/index.html#shortcuts-to-pages-inside-of-your-project">shortcuts to pages inside of your project</a></em> with a <em>headless branch parent</em>.</p>
|
||
<p>In this case it is advised to remove the <code>title</code> from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It is now possible to overwrite the setting for <code>collapsibleMenu</code> of your <code>hugo.toml</code> inside of a page’s frontmatter.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It is now possible to remove the root breadcrumb by setting <code>disableRootBreadcrumb=true</code> in your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The output of the dedicated search page now displays the result’s breadcrumb.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Table rows now change their background color on every even row.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Swahili. This language is not supported for search.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5210">5.21.0 (2023-09-18)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your <code>menu-footer.html</code> <a href="/hugo-theme-relearn/basics/customization/index.html#partials">partial overridden</a>, you may want to review the styling (eg. margins/paddings) of your partial.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See <a href="/hugo-theme-relearn/basics/topbar/index.html">the documentation</a> for further details.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme has updated its Swagger dependency to 5.7.2 for the <a href="/hugo-theme-relearn/shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>. This brings support for OpenAPI Specification 3.1.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5200">5.20.0 (2023-08-26)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The theme has updated its Swagger dependency to 5.4.1 for the <a href="/hugo-theme-relearn/shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>.</p>
|
||
<p>With this comes a change in the light theme variants of <code>Relearn Bright</code>, <code>Relearn Light</code> and <code>Zen Light</code> by switching the syntaxhighlighting inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.</p>
|
||
<p>Additionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.</p>
|
||
<p>If you dislike this change, you can revert this in your theme variants CSS by adding</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="nt">--OPENAPI-CODE-theme</span><span class="o">:</span> <span class="nt">obsidian</span><span class="o">;</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nt">--PRINT-OPENAPI-CODE-theme</span><span class="o">:</span> <span class="nt">obsidian</span><span class="o">;</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> For consistency reasons, we renamed the CSS variable <code>--MENU-SECTION-HR-color</code> to <code>--MENU-SECTION-SEPARATOR-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme variants <code>Zen Light</code> and <code>Zen Dark</code> now add more contrast between menu, topbar and content by adding thin borders.</p>
|
||
<p>Those borders are now configurable by using the CSS variables <code>--MAIN-TOPBAR-BORDER-color</code>, <code>--MENU-BORDER-color</code>, <code>--MENU-TOPBAR-BORDER-color</code>, <code>--MENU-TOPBAR-SEPARATOR-color</code>, <code>--MENU-HEADER-SEPARATOR-color</code> and <code>--MENU-SECTION-ACTIVE-CATEGORY-BORDER-color</code>.</p>
|
||
<p>For existing variants nothing has changed visually.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The default values for the <a href="/hugo-theme-relearn/cont/markdown/index.html#image-effects">image effects</a> are <a href="/hugo-theme-relearn/cont/imageeffects/index.html">now configurable</a> for your whole site via <code>hugo.toml</code> or for each page through frontmatter.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed <code>expand</code> or inactive <code>tabs</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility with Hugo versions lower than <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.111.0</span></span> for the <a href="/hugo-theme-relearn/shortcodes/highlight/index.html"><code>highlight</code> shortcode</a>. This does not change the minimum required Hugo version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5190">5.19.0 (2023-08-12)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/highlight/index.html"><code>highlight</code> shortcode</a> now accepts the new parameter <code>title</code>. This displays the code like a <a href="/hugo-theme-relearn/shortcodes/tab/index.html">single tab</a>. This is also available using codefences and makes it much easier to write nicer code samples.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme has added two new color variants <code>zen-light</code> and <code>zen-dark</code>. Check it out!</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now <a href="/hugo-theme-relearn/basics/customization/index.html#react-to-variant-switches-in-javascript">dispatches the custom event</a> <code>themeVariantLoaded</code> on the <code>document</code> when the variant is fully loaded either initially or by switching the variant manually with the variant selector.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme has updated its Mermaid dependency to 10.3.1. This adds support for the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#sankey">sankey diagram type</a> and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Hungarian.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5180">5.18.0 (2023-07-27)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The theme adds additional warnings for deprecated or now unsupported features.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> There are visual improvements in displaying text links in your content as well as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility with 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.95.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/siteparam/index.html"><code>siteparam</code> shortcode</a> is now capable in displaying nested params as well as supporting text formatting.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5170">5.17.0 (2023-06-22)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The default behavior for the copy-to-clipboard feature for code blocks has changed.</p>
|
||
<p>The copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.</p>
|
||
<p>If you dislike this new behavior you can turn it off and revert to the old behavior by adding <code>[params] disableHoverBlockCopyToClipBoard=true</code> to your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility with 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.114.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new <a href="/hugo-theme-relearn/shortcodes/highlight/index.html"><code>highlight</code> shortcode</a> replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.</p>
|
||
<p>In addition it offers some extensions. Currently only the <code>wrap</code> extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5160">5.16.0 (2023-06-10)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.</p>
|
||
<p><code>DEPRECATION</code> warnings mark features that still work but may be removed in the future.</p>
|
||
<p><code>UNSUPPORTED</code> warnings mark features that will not work anymore.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The 404 error page was revamped. Hopefully you will not see this very often.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> and the <a href="/hugo-theme-relearn/shortcodes/tab/index.html"><code>tab</code> shortcode</a> received some love and now align with their style, color, title and icon parameter to the other shortcodes.</p>
|
||
<p>The visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.</p>
|
||
<p>Additionally the <code>name</code> parameter was renamed to <code>title</code> but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now optionally supports <a href="/hugo-theme-relearn/basics/branding/index.html#change-the-favicon">separate favicons</a> for light & dark mode.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5150">5.15.0 (2023-05-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Restored compatibility with 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.112.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
|
||
<p>The <a href="/hugo-theme-relearn/shortcodes/attachments/index.html"><code>attachments</code> shortcode</a> has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo < <code>0.112.0</code> for now.</p>
|
||
<p>It is <a href="https://github.com/McShelby/hugo-theme-relearn/issues/22" rel="external" target="_blank">planned to refactor</a> the <code>attchments</code> shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <a href="/hugo-theme-relearn/shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> has changed behavior if you haven’t set the <code>groupid</code> parameter.</p>
|
||
<p>Formerly all tab views without a <code>groupid</code> were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The already known <code>tabs</code>has a new friend the <a href="/hugo-theme-relearn/shortcodes/tab/index.html"><code>tab</code> shortcode</a> to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.</p>
|
||
<p>Additionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Besides the <em>tag</em> <a href="/hugo-theme-relearn/cont/taxonomy/index.html">taxonomy</a> the theme now also provides the <em>category</em> taxonomy out of the box and shows them in the content footer of each page.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5140">5.14.0 (2023-05-20)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.</p>
|
||
<p>Hugo’s default taxonmies <code>tags</code> and <code>categories</code> are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> To give you more flexibility in customizing your article layout a new partial <code>content-header.html</code> is introduced.</p>
|
||
<p>This came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional <a href="https://gohugo.io/content-management/taxonomies/" rel="external" target="_blank">taxonomies</a> not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.</p>
|
||
<p>So how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?</p>
|
||
<ol>
|
||
<li>Hide tags above title: Overwrite <code>content-header.html</code> with an empty file.</li>
|
||
<li>Show tags between title and content: Overwrite <code>heading-post.html</code> and add <code>{{ partial "tags.html" . }}</code> to it.</li>
|
||
<li>Show tags below content: Overwrite <code>content-footer.html</code> and add <code>{{ partial "tags.html" . }}</code> to it.</li>
|
||
</ol>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new parameter <code>breadcrumbSeparator</code> is now available in your <code>hugo.toml</code> to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5130">5.13.0 (2023-05-17)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <code>swagger</code> shortcode was deprecated in favor for the <a href="/hugo-theme-relearn/shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the <code>swagger</code> shortcode in the next major release.</p>
|
||
<p>Additionally, the implemantion of this shortcode was switched from RapiDoc to <a href="https://github.com/swagger-api/swagger-ui" rel="external" target="_blank">SwaggerUI</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120">5.12.0 (2023-05-04)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support for the great <a href="https://github.com/estruyf/vscode-front-matter" rel="external" target="_blank">VSCode Front Matter extension</a> which provides on-premise CMS capabilties to Hugo.</p>
|
||
<p>The theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your <code>frontmatter.json</code> like this</p>
|
||
|
||
<div class="tab-panel" data-tab-group="5847ec6173623e2e4578b3dc05836210">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="frontmatterjson"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('5847ec6173623e2e4578b3dc05836210','frontmatterjson')"
|
||
>
|
||
<span class="tab-nav-text">frontmatter.json</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="frontmatterjson"
|
||
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-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"frontMatter.extends"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"./vscode-frontmatter/snippets.en.json"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div></li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the <a href="/hugo-theme-relearn/pir/index.html">pirate translation</a>. This feature is not available in Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The scrollbars are now colored according to their variant color scheme to better fit into the visuals.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110">5.11.0 (2023-02-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The theme removed the popular <a href="https://jquery.com" rel="external" target="_blank">jQuery</a> library from its distribution.</p>
|
||
<p>In case you made changes to the theme that are depending on this library you can place a copy of jQuery into your <code>static/js</code> directory and load it from your own <code>layouts/partials/custom-header.html</code> like this:</p>
|
||
|
||
<div class="tab-panel" data-tab-group="5fbb368c077eb409e432205a526b7a27">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="layoutspartialscustom-headerhtml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('5fbb368c077eb409e432205a526b7a27','layoutspartialscustom-headerhtml')"
|
||
>
|
||
<span class="tab-nav-text">layouts/partials/custom-header.html</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="layoutspartialscustom-headerhtml"
|
||
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-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"{{"</span><span class="na">js</span><span class="err">/</span><span class="na">jquery</span><span class="err">.</span><span class="na">min</span><span class="err">.</span><span class="na">js</span><span class="err">"|</span> <span class="na">relURL</span><span class="err">}}"</span> <span class="na">defer</span><span class="p">></</span><span class="nt">script</span><span class="p">></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#parameter">Mermaid</a> diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.</p>
|
||
<p>The default setting of <code>on</code>, in effect since 1.1.0, changed back to <code>off</code> as there was interference with scrolling on mobile and big pages.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The theme is now capable to visually <a href="/hugo-theme-relearn/basics/branding/index.html#adjust-to-os-settings">adapt to your OS’s light/dark mode setting</a>.</p>
|
||
<p>This is also the new default setting if you haven’t configured <code>themeVariant</code> in your <code>hugo.toml</code>.</p>
|
||
<p>Additionally you can configure the variants to be taken for light/dark mode with the new <code>themeVariantAuto</code> parameter.</p>
|
||
<p>This is not supported for Internet Explorer 11, which still displays in the <code>relearn-light</code> variant.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The JavaScript code for handling image lightboxes (provided by <a href="https://noelboss.github.io/featherlight" rel="external" target="_blank">Featherlight</a>) was replaced by a CSS-only solution.</p>
|
||
<p>This also changed the <a href="/hugo-theme-relearn/cont/markdown/index.html#lightbox">lightbox effects</a> parameter from <code>featherlight=false</code> to <code>lightbox=false</code>. Nevertheless you don’t need to change anything as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In the effort to comply with WCAG standards, the implementation of the <a href="/hugo-theme-relearn/shortcodes/expand/index.html"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Czech. This language is not supported for search.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/tags" rel="external" target="_blank">GitHub releases</a> are also now tagged for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) release making it easier for you to pin the theme to a certain version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100">5.10.0 (2023-01-25)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/attachments/index.html"><code>attachments</code></a>, <a href="/hugo-theme-relearn/shortcodes/badge/index.html"><code>badge</code></a>, <a href="/hugo-theme-relearn/shortcodes/button/index.html"><code>button</code></a> and <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code></a> shortcodes have a new parameter <code>color</code> to set arbitrary CSS color values.</p>
|
||
<p>Additionally the <code>--ACCENT-color</code> brand color introduced in version 5.8.0 is now supported with these shortcodes.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="590">5.9.0 (2022-12-23)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> With this version it is now possible to not only have sections on the first menu level but also pages.</p>
|
||
<p>It was later discovered, that this causes pages only meant to be displayed in the <code>More</code> section of the menu and stored directly inside your <code>content</code> directory to now show up in the menu as well.</p>
|
||
<p>To <a href="/hugo-theme-relearn/cont/menushortcuts/index.html#shortcuts-to-pages-inside-of-your-project">get rid</a> of this undesired behavior you have two choices:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Make the page file a <a href="https://gohugo.io/content-management/page-bundles/#headless-bundle" rel="external" target="_blank">headless branch bundle</a> (contained in its own subdirectory and called <code>_index.md</code>) and add the following frontmatter configuration to the file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its content to <strong>not</strong> be ontained in the sitemap.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Showcase'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s1">'always'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">_build</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">list</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">publishResources</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">render</span><span class="p">:</span><span class="w"> </span><span class="l">always</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Showcase</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"_build"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"list"</span><span class="p">:</span> <span class="s2">"never"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"publishResources"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"render"</span><span class="p">:</span> <span class="s2">"always"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Showcase"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>Store the page file for below a parent headless branch bundle and add the following frontmatter to he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>). <strong>Don’t give this page a <code>title</code></strong> as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">_build</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">list</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">publishResources</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">render</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"_build"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"list"</span><span class="p">:</span> <span class="s2">"never"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"publishResources"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"render"</span><span class="p">:</span> <span class="s2">"never"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its content to be contained in the sitemap.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Credits'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Credits</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"title"</span><span class="p">:</span> <span class="s2">"Credits"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The required folder name for the <a href="/hugo-theme-relearn/shortcodes/attachments/index.html"><code>attachments</code> shortcode</a> was changed for leaf bundles.</p>
|
||
<p>Previously, the attachments for leaf bundles in non-multilang setups were required to be in a <code>files</code> subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a <code>_index.<LANGCODE>.files</code> or <code>index.<LANGCODE>.files</code> subdirectory accordingly.</p>
|
||
<p>This added unnecessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a <code>index.files</code> directory. Although the old <code>files</code> directory is now deprecated, if both directories are present, only the old <code>files</code> directory will be used for compatibility.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Absolute links prefixed with <code>http://</code> or <code>https://</code> are now opened in a separate browser tab.</p>
|
||
<p>You can revert back to the old behavior by defining <code>externalLinkTarget="_self"</code> in the <code>params</code> section of your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now supports <a href="https://gohugo.io/hugo-modules/" rel="external" target="_blank">Hugo’s module system</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580">5.8.0 (2022-12-08)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new <a href="/hugo-theme-relearn/shortcodes/badge/index.html"><code>badge</code> shortcode</a> is now available to add highly configurable markers to your content as you can see it on this page.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new <a href="/hugo-theme-relearn/shortcodes/icon/index.html"><code>icon</code> shortcode</a> simplyfies the usage of icons. This can even be combined with also new <code>badge</code> shortcode.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely <a href="/hugo-theme-relearn/cont/markdown/index.html#tasks">task lists</a>, <a href="/hugo-theme-relearn/cont/markdown/index.html#definitions">defintion lists</a> and <a href="/hugo-theme-relearn/cont/markdown/index.html#footnotes">footnotes</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> A new color <code>--ACCENT-color</code> was introduced which is used for highlighting search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old <code>yellow</code> color is still used as default.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570">5.7.0 (2022-11-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The Korean language translation for this theme is now available with the language code <code>ko</code>. Formerly the country code <code>kr</code> was used instead.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/button/index.html"><code>button</code> shortcode</a> can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The search now supports the Korean language.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560">5.6.0 (2022-11-18)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.</p>
|
||
<p>To activate this feature, you need to <a href="/hugo-theme-relearn/basics/customization/index.html#activate-dedicated-search-page">configure it</a> in your <code>hugo.toml</code> as a new outputformat <code>searchpage</code> for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.</p>
|
||
<p>You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Keyboard handling for the TOC and search was improved.</p>
|
||
<p>Pressing <code>CTRL+ALT+t</code> now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the <code>TAB</code> key.</p>
|
||
<p>The search received its own brand new keyboard shortcut <code>CTRL+ALT+f</code>. This will focus the cursor inside of the search box so you can immediately start your search by typing.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.</p>
|
||
<p>To <a href="/hugo-theme-relearn/basics/configuration/index.html">configure this</a> in your <code>hugo.toml</code> make sure to set Hugo’s <code>disableHugoGeneratorInject=true</code> <strong>and</strong> also <code>[params] disableGeneratorVersion=true</code>, otherwise Hugo will generate a meta tag into your home page automagically.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Creation of your project gets a little bit faster with this release.</p>
|
||
<p>This addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550">5.5.0 (2022-11-06)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.</p>
|
||
<p>For that the JavaScript code to handle the <a href="/hugo-theme-relearn/cont/markdown/index.html#image-effects">lightbox and image effects</a> on the client side was removed in favour for static generation of those effects on the server.</p>
|
||
<p>If you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML <code>img</code> URLs manually to the respective HTML attributes.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Old</th>
|
||
<th>New</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code><img src="pic.png?width=20vw&classes=shadow,border"></code></td>
|
||
<td><code><img src="pic.png" style="width:20vw;" class="shadow border"></code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="540">5.4.0 (2022-11-01)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="/hugo-theme-relearn/basics/customization/index.html#file-system">With the proper settings</a> in your <code>hugo.toml</code> your page is now servable from the local file system using <code>file://</code> URLs.</p>
|
||
<p>Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your <code>hugo.toml</code> from <code>json</code> to <code>search</code>. The now deprecated <code>json</code> outputformat still works as before, so there is no need to reconfigure your installation if it is only served from <code>http://</code> or <code>https://</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <a href="/hugo-theme-relearn/shortcodes/button/index.html"><code>button</code> shortcode</a> has a new parameter <code>target</code> to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/math/index.html"><code>math</code> shortcode</a> and <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html"><code>mermaid</code> shortcode</a> now also support the <code>align</code> parameter if codefence syntax is used.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Finnish (Suomi).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530">5.3.0 (2022-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="/hugo-theme-relearn/cont/markdown/index.html#css-classes">Image formatting</a> has two new classes to align images to the <code>left</code> or <code>right</code>. Additionally, the already existing <code>inline</code> option is now documented.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Printing for the <a href="/hugo-theme-relearn/shortcodes/openapi/index.html"><code>swagger</code> shortcode</a> was optimized to expand sections that are usually closed in interactive mode. This requires <a href="/hugo-theme-relearn/basics/customization/index.html#activate-print-support">print support</a> to be configured.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520">5.2.0 (2022-08-03)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If you’ve set <code>collapsibleMenu = true</code> in your <code>hugo.toml</code>, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510">5.1.0 (2022-07-15)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.95.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a <code>index.print.html</code> to the default URL.</p>
|
||
<p>You can revert this behavior by overwriting the <code>print</code> output format setting in your <code>hugo.toml</code>to:</p>
|
||
|
||
<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">outputFormats</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">outputFormats</span><span class="p">.</span><span class="nx">print</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">baseName</span> <span class="p">=</span> <span class="s1">'index'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">isHTML</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mediaType</span> <span class="p">=</span> <span class="s1">'text/html'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'print'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">path</span> <span class="p">=</span> <span class="s1">'_print'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">permalinkable</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">outputFormats</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">print</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">baseName</span><span class="p">:</span><span class="w"> </span><span class="l">index</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">isHTML</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mediaType</span><span class="p">:</span><span class="w"> </span><span class="l">text/html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">print</span><span class="w">
|
||
</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">_print</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">permalinkable</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">"outputFormats"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"print"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"baseName"</span><span class="p">:</span> <span class="s2">"index"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"isHTML"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mediaType"</span><span class="p">:</span> <span class="s2">"text/html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"print"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"path"</span><span class="p">:</span> <span class="s2">"_print"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"permalinkable"</span><span class="p">:</span> <span class="kc">false</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500">5.0.0 (2022-07-05)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate <code>*.js</code> file (if not already) and add the <code>defer</code> keyword to the <code>script</code> element. Eg.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">script</span> <span class="na">defer</span> <span class="na">src</span><span class="o">=</span><span class="s">"myscript.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The way <a href="/hugo-theme-relearn/cont/archetypes/index.html">archetypes</a> are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.</p>
|
||
<p>Your existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:</p>
|
||
<ul>
|
||
<li>
|
||
<p>for your home page, add the frontmatter parameter <code>archetype = "home"</code> and remove the leading heading</p>
|
||
</li>
|
||
<li>
|
||
<p>for all files containing the deprecated frontmatter parameter <code>chapter = true</code>, replace it with <code>archetype = "chapter"</code> and remove the leading headings</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The frontmatter options <code>pre</code> / <code>post</code> were renamed to <code>menuPre</code> / <code>menuPost</code>. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Adding new partials <code>heading-pre.html</code> / <code>heading-post.html</code> and according frontmatter options <code>headingPre</code> / <code>headingPost</code> to modify the way your page`s main heading gets styled.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new shortcode <code>math</code> is available to add beautiful math and chemical formulae. See the <a href="/hugo-theme-relearn/shortcodes/math/index.html">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="420">4.2.0 (2022-06-23)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> The second parameter for the <a href="/hugo-theme-relearn/shortcodes/include/index.html"><code>include</code> shortcode</a> was switched in meaning and was renamed from <code>showfirstheading</code> to <code>hidefirstheading</code>. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.</p>
|
||
<p>If you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Previously, if the <a href="/hugo-theme-relearn/shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> The <code>landingPageURL</code> was removed from <code>hugo.toml</code>. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s homepage. If you want to support a different link, overwrite the <code>logo.html</code> partial.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410">4.1.0 (2022-06-12)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> While fixing issues with the search functionality for non Latin languages, you can now <a href="/hugo-theme-relearn/cont/i18n/index.html#search-with-mixed-language-support">configure to have multiple languages on a single page</a>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="400">4.0.0 (2022-06-05)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> The <code>custom_css</code> config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the <code>custom-header.html</code> template in a much more generic manner.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove <code>--MAIN-ANCHOR-color</code> instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from <code>--MAIN-LINK-color</code> and <code>--MAIN-ANCHOR-HOVER-color</code> respectively.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.</p>
|
||
<p>This applies to <a href="/hugo-theme-relearn/shortcodes/expand/index.html"><code>expand</code></a>, <a href="/hugo-theme-relearn/shortcodes/include/index.html"><code>include</code></a>, <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code></a> and <a href="/hugo-theme-relearn/shortcodes/siteparam/index.html"><code>siteparam</code></a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The <a href="/hugo-theme-relearn/shortcodes/button/index.html"><code>button</code></a> shortcode received some love and now has a parameter for the color style similar to other shortcodes.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New colors <code>--PRIMARY-color</code> and <code>--SECONDARY-color</code> were added to provide easier modification of your custom style. Shortcodes with a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
|
||
<p>These two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Polish. This language is not supported for search.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The documentation for all shortcodes were revised.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340">3.4.0 (2022-04-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> If you had previously overwritten the <code>custom-footer.html</code> partial to add visual elements below the content of your page, you have to move this content to the new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant to contain HTML other than additional styles and JavaScript.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If you prefer expandable/collapsible menu items, you can now set <code>collapsibleMenu=true</code> in your <code>hugo.toml</code>. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You can activate <a href="/hugo-theme-relearn/basics/customization/index.html#activate-print-support">print support</a> in your <code>hugo.toml</code> to add the capability to print whole chapters or even the complete site.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translation into Traditional Chinese.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330">3.3.0 (2022-03-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Introduction of new CSS variables to set the font. The theme distinguishes between <code>--MAIN-font</code> for all content text and <code>--CODE-font</code> for inline or block code. There are additional overrides for all headings. See the <a href="/hugo-theme-relearn/basics/generator/index.html">theme variant generator</a> of the exampleSite for all available variables.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI specifications. See the <a href="/hugo-theme-relearn/shortcodes/openapi/index.html">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320">3.2.0 (2022-03-19)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.93.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of <code>disableMermaid</code> config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.</p>
|
||
<p>The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set <code>disableMermaid=false</code> in your frontmatter to force the library to be loaded. See the <a href="/hugo-theme-relearn/basics/generator/index.html">theme variant generator</a> of the exampleSite for an example.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Additional color variant variable <code>--MERMAID-theme</code> to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310">3.1.0 (2022-03-15)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="/hugo-theme-relearn/shortcodes/attachments/index.html"><code>attachment</code></a> and <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code></a> shortcodes have a new parameter to override the default icon. Allowed values are all <a href="https://fontawesome.com/v5/search?m=free" rel="external" target="_blank">Font Awesome 5 Free</a> icons.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300">3.0.0 (2022-02-22)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> We made changes to the menu footer. If you have your <code>menu-footer.html</code> <a href="/hugo-theme-relearn/basics/customization/index.html#partials">partial overridden</a>, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the <code>menu-footer.html</code> partial that is coming with the exampleSite.</p>
|
||
<p>This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and <em>Clear history</em> functionality).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.</p>
|
||
<p>This change will only affect your installation if you’ve not set the <code>themeVariant</code> parameter in your <code>hugo.toml</code>. <a href="/hugo-theme-relearn/basics/branding/index.html#theme-variant">If you still want to use the Learn color variant</a>, you have to explicitly set <code>themeVariant="learn"</code> in your <code>hugo.toml</code>.</p>
|
||
<p>Note, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove <code>--MENU-SEARCH-BOX-ICONS-color</code> and introduced <code>--MENU-SEARCH-color</code> instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> For consistency reasons, we renamed <code>--MENU-SEARCH-BOX-color</code> to <code>--MENU-SEARCH-BORDER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> With this release you are now capable to define your own <em>dark mode</em> variants.</p>
|
||
<p>To make this possible, we have introduced a lot more color variables you can use in <a href="/hugo-theme-relearn/basics/branding/index.html#theme-variant">your color variants</a>. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.</p>
|
||
<p>To see what’s now possible, see the new variants <code>relearn-dark</code> and <code>neon</code> that are coming with this release.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> To make the creation of new variants easier for you, we’ve added a new interactive <a href="/hugo-theme-relearn/basics/generator/index.html">theme variant generator</a>. This feature will not work with Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You can now configure multiple color variants in your <code>hugo.toml</code>. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the <a href="/hugo-theme-relearn/basics/branding/index.html#multiple-variants">documentation</a> for configuration.</p>
|
||
<p>Note, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290">2.9.0 (2021-11-19)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> This release removes the themes implementation of <code>ref</code>/<code>relref</code> in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.</p>
|
||
<p>In a standard compliant form you must not link to the <code>*.md</code> file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Non-Standard</th>
|
||
<th>Standard</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Branch bundle</td>
|
||
<td><code>basics/configuration/_index.md</code></td>
|
||
<td><code>basics/configuration</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Leaf bundle</td>
|
||
<td><code>basics/configuration/index.md</code></td>
|
||
<td><code>basics/configuration</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Page</td>
|
||
<td><code>basics/configuration.md</code></td>
|
||
<td><code>basics/configuration</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" rel="external" target="_blank">Hugo got you covered</a> as well.</p>
|
||
<p>Also, the old themes implementation allowed refs to non-existing content. This will cause Hugo’s implementation to show the error below and abort the generation. If your project relies on this old behavior, you can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" rel="external" target="_blank">reconfigure the error handling</a> of Hugo’s implementation.</p>
|
||
<p>In the best case your usage of the old implementation is already standard compliant and you don’t need to change anything. You’ll notice this very easily once you’ve started <code>hugo server</code> after an upgrade and no errors are written to the console.</p>
|
||
<p>You may see errors on the console after the update in the form:</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">ERROR 2021/11/19 22:29:10 <span class="o">[</span>en<span class="o">]</span> REF_NOT_FOUND: Ref <span class="s2">"basics/configuration/_index.md"</span>: <span class="s2">"hugo-theme-relearn\exampleSite\content\_index.en.md:19:22"</span>: page not found</span></span></code></pre></div><p>In this case, you must apply one of two options:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Start up a text editor with regular expression support for search and replace. Search for <code>(ref\s+"[^"]*?)(?:/_index|/index)?(?:\.md)?(#[^"]*?)?"</code> and replace it by <code>$1$2"</code> in all <code>*.md</code> files. <strong>This is the recommended choice</strong>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Copy the old implementation files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> and <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> to your own projects <code>layouts/shortcode/ref.html</code> and <code>layouts/shortcode/relref.html</code> respectively. <strong>This is not recommended</strong> as your project will still rely on non-standard behavior afterwards.</p>
|
||
</li>
|
||
</ol>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280">2.8.0 (2021-11-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Although never officially documented, this release removes the font <code>Novacento</code>/<code>Novecento</code>. If you use it in an overwritten CSS please replace it with <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> in SVG, PNG or ICO format <a href="/hugo-theme-relearn/basics/branding/index.html#change-the-favicon">out of the box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore in most cases.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You can hide the table of contents menu for the whole site by setting the <code>disableToc</code> option in your <code>hugo.toml</code>. For an example see <a href="/hugo-theme-relearn/basics/configuration/index.html">the example configuration</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270">2.7.0 (2021-10-24)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Optional second parameter for <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code></a> shortcode to set title in box header.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260">2.6.0 (2021-10-21)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Your site can now be served from a subfolder if you set <code>baseURL</code> in your <code>hugo.toml</code>. See the <a href="/hugo-theme-relearn/basics/customization/index.html#public-web-server-from-subdirectory">documentation</a> for a detailed example.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250">2.5.0 (2021-10-08)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> New colors <code>--CODE-BLOCK-color</code> and <code>--CODE-BLOCK-BG-color</code> were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240">2.4.0 (2021-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting <code>disableTagHiddenPages=true</code> in your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You can define the expansion state of your menus for the whole site by setting the <code>alwaysopen</code> option in your <code>hugo.toml</code>. Please see further <a href="/hugo-theme-relearn/cont/frontmatter/index.html#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New frontmatter <code>ordersectionsby</code> option to change immediate children sorting in menu and <code>children</code> shortcode. Possible values are <code>title</code> or <code>weight</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Alternate content of a page is now advertised in the HTML meta tags. See <a href="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head" rel="external" target="_blank">Hugo documentation</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230">2.3.0 (2021-09-13)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.81.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220">2.2.0 (2021-09-09)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting <code>disableSeoHiddenPages=true</code> in your <code>hugo.toml</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210">2.1.0 (2021-09-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.69.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see <code>CHANGELOG.md</code> in the exampleSite), they will now be ignored by the search.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting <code>disableSearchHiddenPages=true</code> in your <code>hugo.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If a search term is found in an <code>expand</code> shortcode, the expand will be opened.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> The menu will scroll the active item into view on load.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200">2.0.0 (2021-08-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Syntax highlighting was switched to the <a href="https://gohugo.io/content-management/syntax-highlighting/" rel="external" target="_blank">built in Hugo mechanism</a>. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In the predefined stylesheets there was a typo and <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed to <code>--MENU-HOME-LINK-HOVER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <code>--MENU-HOME-LINK-color</code> and <code>--MENU-HOME-LINK-HOVER-color</code> were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Arrow navigation and <code>children</code> shortcode were ignoring setting for <code>ordersectionsby</code>. This is now changed and may result in different sorting order of your sub pages.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A page without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> You can define the expansion state of your menus in the frontmatter. Please see further <a href="/hugo-theme-relearn/cont/frontmatter/index.html#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New partials for defining pre/post content for menu items and the content. See <a href="/hugo-theme-relearn/basics/customization/index.html#partials">documentation</a> for further reading.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="/hugo-theme-relearn/shortcodes/children/index.html"><code>children</code></a> with new parameter <code>containerstyle</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New shortcode <a href="/hugo-theme-relearn/shortcodes/include/index.html"><code>include</code></a> to include arbitrary file content into a page.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120">1.2.0 (2021-07-26)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="/hugo-theme-relearn/shortcodes/expand/index.html"><code>expand</code></a> with new parameter to open on page load.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110">1.1.0 (2021-07-02)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html">Mermaid</a> diagrams can now be panned and zoomed. This isn’t configurable yet.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#configuration"><code>Mermaid</code></a> config options can be set in <code>hugo.toml</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100">1.0.0 (2021-07-01)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><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.65.0</span></span> The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Initial fork of the <a href="https://github.com/matcornic/hugo-theme-learn" rel="external" target="_blank">Learn theme</a> based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to <code>Relearn</code> and a new logo. For the reasons behind forking the Learn theme, see <a href="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495" rel="external" target="_blank">this comment</a> in the Learn issues.</p>
|
||
</li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="requirements">Requirements</h1>
|
||
|
||
<p>Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.</p>
|
||
<p>Just download at least version <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.121.0</span></span> of the <a href="https://gohugo.io/getting-started/installing/" rel="external" target="_blank">Hugo binary</a> for your OS (Windows, Linux, Mac).</p>
|
||
<figure><a href="https://gohugo.io"><img src="/hugo-theme-relearn/basics/requirements/magic.gif"
|
||
alt="Magic"></a><figcaption>
|
||
<p>It’s a kind of magic</p>
|
||
</figcaption>
|
||
</figure>
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list 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/basic/index.html">Basic</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/documentation/index.html">Documentation</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<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/" rel="external" target="_blank">great documentation for beginners</a>.</p>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>The following tutorial leads you through the steps of creating a first, minimal new site.</p>
|
||
<p>You don’t need to edit any files besides your <code>hugo.toml</code> and only need to execute the commands in the given order.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="create-your-project">Create your project</h2>
|
||
<p>Hugo provides a <code>new</code> command to create a new website:</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 site my-new-site</span></span></code></pre></div><p>After that change into the directory:</p>
|
||
<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><p>Every upcoming command will be executed from inside your new site’s root.</p>
|
||
<h2 id="install-the-theme">Install the theme</h2>
|
||
<h3 id="from-download">From Download</h3>
|
||
<p>You can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" rel="external" target="_blank">download the theme as .zip</a> file and extract it into them <code>themes/hugo-theme-relearn</code> directory.</p>
|
||
<h3 id="with-hugos-module-system">With Hugo’s Module System</h3>
|
||
<p>Install the Relearn theme by following <a href="https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" rel="external" target="_blank">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" rel="external" target="_blank">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
|
||
<h3 id="using-git-or-git-submodules">Using Git or Git Submodules</h3>
|
||
<p>If you install the theme from your git repository or GitHub, you have several options.</p>
|
||
<p>If you use the <code>head</code> of the <code>main</code> branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.</p>
|
||
<p>Additionally you can checkout one of the tagged versions. These tagged versions correspond to an official <a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_blank">releases from the GitHub repository</a>.</p>
|
||
<p>Besides the usual version tags (eg <code>1.2.3</code>) there are also tags for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) released version making it easier for you to pin the theme to a certain version.</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>hugo.toml</code> and set the theme as the default.</p>
|
||
|
||
<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="nx">theme</span> <span class="p">=</span> <span class="s1">'hugo-theme-relearn'</span></span></span></code></pre></div></div>
|
||
</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">theme</span><span class="p">:</span><span class="w"> </span><span class="l">hugo-theme-relearn</span></span></span></code></pre></div></div>
|
||
</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="create-your-home-page">Create your Home Page</h2>
|
||
<p>If you don’t create a home page, yet, the theme will generate a placeholder text with instructions how to proceed.</p>
|
||
<p>Start your journey by filling the home page with content</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 home _index.md</span></span></code></pre></div><p>By opening the given file, you should see the property <code>archetype=home</code> on top, meaning this page is a home page. The Relearn theme provides <a href="/hugo-theme-relearn/cont/archetypes/index.html">some archetypes</a> to create those skeleton files for your website.</p>
|
||
<p>Obviously you better should change the page’s content.</p>
|
||
<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 the <em>title</em> and a <em>brief abstract</em> of the section.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><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="#R-image-d38d82adaebb40adafb6a4b59b6ceade" class="lightbox-link"><img alt="A Chapter" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/installation/chapter.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-d38d82adaebb40adafb6a4b59b6ceade"><img alt="A Chapter" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/installation/chapter.png?width=60pc"></a></p>
|
||
<p>Begin by creating your first chapter page with the following command:</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 basics/_index.md</span></span></code></pre></div><p>By opening the given file, you should see the property <code>archetype=chapter</code> on top, meaning this page is a <em>chapter</em>.</p>
|
||
<p>The <code>weight</code> number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.</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 wrap-code"><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 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><p>Go to <code>http://localhost:1313</code></p>
|
||
<p>You should notice three things:</p>
|
||
<ol>
|
||
<li>The home page contains some basic text.</li>
|
||
<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>When you run <code>hugo serve</code> your page refreshes automatically when you change a content page. 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 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><p>A <code>public</code> folder will be generated, containing all content and assets for your website. It can now be deployed on any web server.</p>
|
||
<p>Now it’s time to deploy your page by simply uploading your project to some web server or by using one of <a href="https://gohugo.io/hosting-and-deployment/" rel="external" target="_blank">Hugo’s many deployment options</a>.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/config/index.html">Config</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="configuration">Configuration</h1>
|
||
|
||
<p>On top of <a href="https://gohugo.io/overview/configuration/" rel="external" target="_blank">Hugo’s global configuration options</a>, the Relearn theme lets you define further options unique to the theme in your <code>hugo.toml</code>.</p>
|
||
<p>Note that some of these options are explained in detail in other sections of this documentation.</p>
|
||
<h2 id="all-config-options">All config options</h2>
|
||
<p>The values reflect the options active in this documentation. The defaults can be taken from the <a href="/hugo-theme-relearn/basics/configuration/index.html#annotated-config-options">annotated example</a> below.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'en'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">breadcrumbSeparator</span> <span class="p">=</span> <span class="s1">'>'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">description</span> <span class="p">=</span> <span class="s1">'Documentation for Hugo Relearn Theme'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableAssetsBusting</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableGeneratorVersion</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableHoverBlockCopyToClipBoard</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableInlineCopyToClipBoard</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLandingPageButton</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLanguageSwitchingButton</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableRandomIds</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableRootBreadcrumb</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSearch</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSearchHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSeoHiddenPages</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableShortcutsTitle</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableTagHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableTermBreadcrumbs</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">editURL</span> <span class="p">=</span> <span class="s1">'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s1">'_blank'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">images</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'images/hero.png'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s1">'{}'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s1">'{ "securityLevel": "loose" }'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s1">'weight'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">showVisitedLinks</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s1">'::'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">author</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Sören Weber'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">image</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">errorlevel</span> <span class="p">=</span> <span class="s1">'warning'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">include</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">errorlevel</span> <span class="p">=</span> <span class="s1">'warning'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">link</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">errorlevel</span> <span class="p">=</span> <span class="s1">'warning'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">social</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">facebook_admin</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">twitter</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-auto'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Relearn Light/Dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-light'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-bright'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'zen-light'</span><span class="p">,</span> <span class="s1">'zen-dark'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-auto'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Zen Light/Dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-light'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'learn'</span><span class="p">,</span> <span class="s1">'neon'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'retro-auto'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Retro Learn/Neon'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'neon'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'learn'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'blue'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'green'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'red'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">additionalContentLanguage</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">en</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">alwaysopen</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">author</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Sören Weber</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">breadcrumbSeparator</span><span class="p">:</span><span class="w"> </span><span class="s1">'>'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">collapsibleMenu</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customMathJaxURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customMermaidURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">customOpenapiURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Documentation for Hugo Relearn Theme</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableAssetsBusting</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableBreadcrumb</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableExplicitIndexURLs</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableGeneratorVersion</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableHoverBlockCopyToClipBoard</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableInlineCopyToClipBoard</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableLandingPageButton</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableLanguageSwitchingButton</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableMathJax</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableMermaid</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableNextPrev</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableOpenapi</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableRandomIds</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableRootBreadcrumb</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableSearch</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableSearchHiddenPages</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableSeoHiddenPages</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableShortcutsTitle</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableTagHiddenPages</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableTermBreadcrumbs</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableToc</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">editURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">externalLinkTarget</span><span class="p">:</span><span class="w"> </span><span class="l">_blank</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">highlightWrap</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">imageEffects</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">border</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lazy</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lightbox</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shadow</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">images</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">images/hero.png</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">include</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">link</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mathJaxInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{}'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mermaidInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "securityLevel": "loose" }'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mermaidZoom</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">ordersectionsby</span><span class="p">:</span><span class="w"> </span><span class="l">weight</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">showVisitedLinks</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">social</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">facebook_admin</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">twitter</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Relearn Light/Dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-bright</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Zen Light/Dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">learn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">neon</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">retro-auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Retro Learn/Neon</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">neon</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">learn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">blue</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">green</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">red</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">titleSeparator</span><span class="p">:</span><span class="w"> </span><span class="s1">'::'</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"additionalContentLanguage"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"en"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"alwaysopen"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"author"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Sören Weber"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"breadcrumbSeparator"</span><span class="p">:</span> <span class="s2">"\u003e"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"collapsibleMenu"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customMathJaxURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customMermaidURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customOpenapiURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Documentation for Hugo Relearn Theme"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableAssetsBusting"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableBreadcrumb"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableExplicitIndexURLs"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableGeneratorVersion"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableHoverBlockCopyToClipBoard"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableInlineCopyToClipBoard"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableLandingPageButton"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableLanguageSwitchingButton"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableMathJax"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableMermaid"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableNextPrev"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableOpenapi"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableRandomIds"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableRootBreadcrumb"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableSearch"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableSearchHiddenPages"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableSeoHiddenPages"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableShortcutsTitle"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableTagHiddenPages"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableTermBreadcrumbs"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableToc"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"editURL"</span><span class="p">:</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"externalLinkTarget"</span><span class="p">:</span> <span class="s2">"_blank"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"highlightWrap"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"image"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"imageEffects"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"border"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lazy"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lightbox"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shadow"</span><span class="p">:</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"images"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"images/hero.png"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"include"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"link"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mathJaxInitialize"</span><span class="p">:</span> <span class="s2">"{}"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidInitialize"</span><span class="p">:</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidZoom"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"ordersectionsby"</span><span class="p">:</span> <span class="s2">"weight"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"showVisitedLinks"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"social"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"facebook_admin"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"twitter"</span><span class="p">:</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</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">"auto"</span><span class="p">:</span> <span class="p">[],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Relearn Light/Dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-light"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-bright"</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="nt">"auto"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-light"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-dark"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Zen Light/Dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-light"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-dark"</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="nt">"auto"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"learn"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"neon"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"retro-auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Retro Learn/Neon"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"neon"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"learn"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"blue"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"green"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"red"</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="nt">"titleSeparator"</span><span class="p">:</span> <span class="s2">"::"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="annotated-config-options">Annotated config options</h2>
|
||
|
||
<div class="tab-panel" data-tab-group="ed5d00bf7aabe54a0a5a9f6a311562c3">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="hugotoml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('ed5d00bf7aabe54a0a5a9f6a311562c3','hugotoml')"
|
||
>
|
||
<span class="tab-nav-text">hugo.toml</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="hugotoml"
|
||
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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If an option value is said to be not set, you can achieve the same behavior</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># by giving it an empty string value.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hugo</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options usually apply to other themes as well.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The author of your site.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This will be used in HTML meta tags, the opengraph protocol and twitter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># You can also set `author.email` if you want to publish this information.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">author</span><span class="p">.</span><span class="nx">name</span> <span class="p">=</span> <span class="s2">"Sören Weber"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The social media image of your site.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is used for generating social media meta information for the opengraph</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># protocol and twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">images</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"images/hero.png"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The description of your site.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is used for generating HTML meta tags, social media meta information</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># for the opengraph protocol and twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">description</span> <span class="p">=</span> <span class="s2">"Documentation for Hugo Relearn Theme"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Admin options for social media.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># implementation. See the Hugo docs for possible values.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">facebook_admin</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">twitter</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Relearn Theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options are specific to the Relearn theme.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Branding</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options set your overall visual appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Used color variants.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "auto"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This sets one or more color variants, available to your readers to choose</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># from. You can</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># - set a single value eg. "zen-light"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># - an array like [ "neon", "learn" ]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># - an array with options like [ { identifier = "neon" },{ identifier = "learn" } ]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The last form allows to set further options for each variant.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The `identifier` is mandatory. You can also set `name` which overrides the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># value displayed in the variant selector.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the array has more than one entry, a variant selector</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># is shown in the lower part of the menu. The first entry in the array is the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># default variant, used for first time visitors.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The theme ships with the following variants: "relearn-bright",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "relearn-light", "relearn-dark", "zen-light", "zen-dark", "neon", "learn",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "blue", "green", "red". In addition you can use auto mode variants. See the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># docs for a detailed explanation.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># You can also define your own variants. See the docs how this works. Also,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># the docs provide an interactive theme generator to help you with this task.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"relearn-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Relearn Light/Dark"</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[]</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"relearn-light"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"relearn-dark"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"relearn-bright"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"zen-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Zen Light/Dark"</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"zen-light"</span><span class="p">,</span> <span class="s2">"zen-dark"</span> <span class="p">]</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"zen-light"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"zen-dark"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"retro-auto"</span><span class="p">,</span> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"Retro Learn/Neon"</span><span class="p">,</span> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"learn"</span><span class="p">,</span> <span class="s2">"neon"</span> <span class="p">]</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"neon"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"learn"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"blue"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"green"</span> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"red"</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></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># General</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options are defining general, non visual behavior.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoid new asset URLs on build.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># By default JavaScript-files and CSS-files get a unique ID on each rebuild.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This makes sure, the user always has the latest version and not some stale</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># copy of his browser cache. Anyways, it can be desireable to turn this</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># off in certain circumstances. For example if you have Hugo's dev server</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># running. Also some proxies dislike this optimization.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableAssetsBusting</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoid generator meta tags.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Set this to true if you want to disable generation for generator meta tags</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># of Hugo and the theme in your HTML head. In this case also don't forget to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># meta tag into your home page anyways.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableGeneratorVersion</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoid unique IDs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># In various situations the theme generates non stable unique ids to be used</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># in HTML fragment links. This can be undesirable for example when testing</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># the output for changes. If you disable the random id generation, the theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># may not function correctly anymore.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableRandomIds</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Multilanguage content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If your pages contain further languages besides the main one used, add all</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># those auxiliary languages here. This will create a search index with</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># support for all used languages of your site.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is handy for example if you are writing in Spanish but have lots of</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># source code on your page which typically uses English terminology.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"en"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Additional code dependencies.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: See hugo.toml of the theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The theme provides a mechanism to load further JavaScript and CSS</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># dependencies on demand only if they are needed. This comes in handy if you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># want to add own shortcodes that depend on additional code to be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># See the docs how this works.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># [relearn.dependencies]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Topbar</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify the topbar appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the table of contents button.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the TOC button is hidden, also the keyboard shortcut is disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the breadcrumbs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the breadcrumbs are hidden, the title of the displayed page will still be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># shown in the topbar.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide Next and Previous navigation buttons.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the navigation buttons are hidden, also the keyboard shortcuts are</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The URL prefix to edit a page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, an edit button will be shown in the topbar. If the button is hidden,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># also the keyboard shortcuts are disabled. The value can contain the macro</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` which will be replaced by the file path of your displayed page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If no `${FilePath}` is given in the value, the value is treated as if the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` was appended at the end of the value. This can be overridden</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># in the pages frontmatter. This is useful if you want to give the opportunity</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># for people to create merge request for your content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Menu</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify the menu appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the search box.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the search box is disabled, the search functionality is disabled too.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This will also cause the keyboard shortcut to be disabled and the dedicated</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search page is not linked although it mighty be configured.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableSearch</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the Home entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If shown, a Home button will appear below the search bar and the main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># It links to your the home page of the current language.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableLandingPageButton</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The order of main menu submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "expirydate", "publishdate", "date", "length" or "default" (adhering to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hugo's default sort order). This can be overridden in the pages frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"weight"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The initial expand state of submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This controls whether submenus will be expanded (true), or collapsed (false)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># in the menu. If not set, the first menu level is set to false, all others</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># levels are set to true. This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the displayed page has submenus, they will always been displayed expanded</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># regardless of this option.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Shows expander for submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set to true, a submenu in the sidebar will be displayed in a collapsible</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># tree view and a clickable expander is set in front of the entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Shows checkmarks for visited pages of the main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This also causes the display of the `Clear History` entry in the lower part</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># of the menu to remove all checkmarks. The checkmarks will also been removed</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># if you regenerate your site as the ids are not stable.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">showVisitedLinks</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide heading above the shortcut menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title for the heading can be overwritten in your i18n files. See Hugo's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># documentation how to do this.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableShortcutsTitle</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the language switcher.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If you have more than one language configured, a language switcher is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># displayed in the lower part of the menu. This option lets you explicitly</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># turn this behavior off.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableLanguageSwitchingButton</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hidden pages</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how hidden pages are treated.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A page flagged as hidden, is only removed from the main menu if you are</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># currently not on this page or the hidden page is not part of current page's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ancestors. For all other functionality in Hugo a hidden page behaves like any</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># other page if not otherwise configured.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden pages from search.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hides hidden pages from the suggestions of the search box and the dedicated</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableSearchHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden pages for web crawlers.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoids hidden pages from showing up in the sitemap and on Google (et all),</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># otherwise they may be indexed by search engines</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableSeoHiddenPages</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden pages for taxonomies.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hides hidden pages from showing up on the taxonomy and terms pages. If this</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># reduces term counters to zero, an empty but not linked term page will be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># created anyhow.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableTagHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Content</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify how your content is displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Title separator.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "::"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Changes the title separator used when concatenating the page title with the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># site title. This is consistently used throughout the theme.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s2">"::"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Breadcrumb separator.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: ">"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Changes the breadcrumb separator used in the topbars breadcrumb area and for</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search results and term pages.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">breadcrumbSeparator</span> <span class="p">=</span> <span class="s2">">"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the root breadcrumb.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The root breadcrumb is usually the home page of your site. Because this is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># always accessible by clicking on the logo, you may want to reduce clutter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># by removing this from your breadcrumb.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableRootBreadcrumb</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide breadcrumbs term pages.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If you have lots of taxonomy terms, the term pages may seem cluttered with</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># breadcrumbs to you, so this is the option to turn off breadcrumbs on term</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># pages. Only the page title will then be shown on the term pages.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableTermBreadcrumbs</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Highlight</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how code is displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide copy-to-clipboard for inline code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This removes the copy-to-clipboard button from your inline code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableInlineCopyToClipBoard</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Always show copy-to-clipboard for block code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The theme only shows the copy-to-clipboard button if you hover over the code</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># block. Set this to true to disable the hover effect and always show the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># button.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableHoverBlockCopyToClipBoard</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Wrap for code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># By default lines of code blocks wrap around if the line is too long to be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># displayed on screen. If you dislike this behavior, you can reconfigure it</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># here.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Note that lines always wrap in print mode regardless of this option.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter or given as a parameter to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># individual code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Include</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how the include shortcode works.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># What to do when path is not resolved.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: ""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># You can control what should happen if a path can not be resolved to as</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># a resource or via the file system. If not set, no output will be written</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># for the unresolved path. If set to `warning` the same happens and an additional</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># warning is printed. If set to `error` an error message is printed and the build</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># is aborted.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">include</span><span class="p">.</span><span class="nx">errorlevel</span> <span class="p">=</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Images</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how images are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># What to do when local image link is not resolved.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: ""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># You can control what should happen if a local image can not be resolved to as</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># a resource. If not set, the unresolved link is written as given into the resulting</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># output. If set to `warning` the same happens and an additional warning is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set to `error` an error message is printed and the build is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># aborted.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Please note that this can not resolve files inside of your `static` directory.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">image</span><span class="p">.</span><span class="nx">errorlevel</span> <span class="p">=</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Image effects.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># See the documentation for how you can even add your own arbitrary effects to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># the list.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># All effects can be overridden in the page's frontmatter or through URL parameter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># given to the image. See the documentation for details.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Links</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how links are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># What to do when local page link is not resolved.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: ""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># You can control what should happen if a local link can not be resolved to a</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># page. If not set, the unresolved link is written as given into the resulting</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># output. If set to `warning` the same happens and an additional warning is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># printed. If set to `error` an error message is printed and the build is</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># aborted.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Please note that with Hugo < 0.123.0 + `uglyURLs=true` this can lead to false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># negatives.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">link</span><span class="p">.</span><span class="nx">errorlevel</span> <span class="p">=</span> <span class="s2">"warning"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># How to open external links.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "_blank"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For external links you can define how they are opened in your browser. All</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># values for the HTML `target` attribute of the `a` element are allowed. The</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># default value opens external links in a separate browser tab. If you want</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># to open those links in the same tab, use "_self".</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">"_blank"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Generate link URLs the Hugo way.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set to true, the theme behaves like a standard Hugo installation and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># appends no index.html to prettyURLs. As a trade off, your build project will</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># not be servable from the file system.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how math formulae are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initialization options for MathJax.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See the MathJaxdocumentation for possible parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{}"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load MathJax if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Math shortcode is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMathJax=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external MathJax library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the MathJax library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Mermaid</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how Mermaid graphs are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Make graphs panable and zoomable</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For huge graphs it can be helpful to make them zoomable. Zoomable graphs come</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># with a reset button for the zoom.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter or given as a parameter to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># individual graphs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initialization options for Mermaid.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See the Mermaid documentation for possible parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load Mermaid if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Mermaid shortcode or codefence is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Mermaid will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMermaid=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external Mermaid library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the Mermaid library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenApi</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how OpenAPI specifications are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load OpenAPI if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a OpenAPI shortcode is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenAPI will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableOpenapi=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external OpenAPI library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the OpenAPI library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden in the page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="branding">Branding</h1>
|
||
|
||
<p>The Relearn theme provides configuration options to change your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed through so called color variants.</p>
|
||
<p>A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your <code>hugo.toml</code>.</p>
|
||
<p>The Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The <a href="/hugo-theme-relearn/basics/generator/index.html">interactive variant generator</a> may help you with this task.</p>
|
||
<p>Once configured in your <code>hugo.toml</code>, you can select them with the variant selector at the bottom of the menu.</p>
|
||
<h2 id="theme-variant">Change the Variant (Simple)</h2>
|
||
<h3 id="single-variant">Single Variant</h3>
|
||
<p>Set the <code>themeVariant</code> value to the name of your theme file. That’s it! Your site will be displayed in this variant only.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="s1">'relearn-light'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-light</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</span><span class="p">:</span> <span class="s2">"relearn-light"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<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>Your theme variant file must reside in your site’s <code>assets/css</code> directory and the file name must start with <code>theme-</code> and end in <code>.css</code>. In the above example, the path of your theme file must be <code>assets/css/theme-relearn-light.css</code>.</p>
|
||
<p>If you want to make changes to a shipped color variant, create a copy in your site’s <code>assets/css</code> directory. Don’t edit the file in the theme’s directory!</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="multiple-variants">Multiple Variants</h3>
|
||
<p>You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'relearn-light'</span><span class="p">,</span> <span class="s1">'relearn-dark'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">relearn-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">relearn-dark</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"relearn-light"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"relearn-dark"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>The theme provides an advanced configuration mode, combining the functionality for multiple variants with the below possibilities of adjusting to your OS settings and syntax highlighting and even more!</p>
|
||
<p>Although all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. <a href="/hugo-theme-relearn/basics/branding/index.html#theme-variant-advanced">See below</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="adjust-to-os-settings">Adjust to OS Settings</h2>
|
||
<p>You can also cause the site to adjust to your OS settings for light/dark mode. Just set the <code>themeVariant</code> to <code>auto</code> to become an auto mode variant. That’s it.</p>
|
||
<p>You can use the <code>auto</code> value with the single or multiple variants option. If you are using multiple variants, you can drop <code>auto</code> at any position in the option’s array, but usually it makes sense to set it in the first position and make it the default.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'auto'</span><span class="p">,</span> <span class="s1">'red'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">red</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"red"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>If you don’t configure anything else, the theme will default to use <code>relearn-light</code> for light mode and <code>relearn-dark</code> for dark mode. These defaults are overwritten by the first two non-auto options of your <code>themeVariant</code> option if present.</p>
|
||
<p>In the above example, you would end with <code>red</code> for light mode and the default of <code>relearn-dark</code> for dark mode.</p>
|
||
<p>If you don’t like that behavior, you can explicitly set <code>themeVariantAuto</code>. The first entry in the array is the color variant for light mode, the second for dark mode.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariantAuto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'learn'</span><span class="p">,</span> <span class="s1">'neon'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariantAuto</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">learn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">neon</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariantAuto"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"learn"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"neon"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="change-the-favicon">Change the Favicon</h2>
|
||
<p>If your favicon is a SVG, PNG or ICO, just drop your image in your site’s <code>static/images/</code> directory and name it <code>favicon.svg</code>, <code>favicon.png</code> or <code>favicon.ico</code> respectively.</p>
|
||
<p>If you want to adjust your favicon according to your OS settings for light/dark mode, add the image files <code>static/images/favicon-light.svg</code> and <code>static/images/favicon-dark.svg</code> to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to <code>favicon.svg</code> for each missing file. All supplied favicons must be of the same file format.</p>
|
||
<p>If no favicon file is found, the theme will lookup the alternative filename <code>logo</code> in the same location and will repeat the search for the list of supported file types.</p>
|
||
<p>If you need to change this default behavior, create a new file <code>layouts/partials/favicon.html</code> in your site’s directory and write something like this:</p>
|
||
|
||
<div class="tab-panel" data-tab-group="07b913ad43e32cf208e4831553e0222a">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="layoutspartialsfaviconhtml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('07b913ad43e32cf208e4831553e0222a','layoutspartialsfaviconhtml')"
|
||
>
|
||
<span class="tab-nav-text">layouts/partials/favicon.html</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="layoutspartialsfaviconhtml"
|
||
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-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">"icon"</span> <span class="na">href</span><span class="o">=</span><span class="s">"/images/favicon.bmp"</span> <span class="na">type</span><span class="o">=</span><span class="s">"image/bmp"</span><span class="p">></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="change-the-logo">Change the Logo</h2>
|
||
<p>Create a new file in <code>layouts/partials/logo.html</code> of your site. Then write any HTML you want. You could use an <code>img</code> HTML tag and reference an image created under the <em>static</em> folder, or you could paste a SVG definition!</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>The size of the logo will adapt automatically.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="syntax-highlighting">Syntax Highlighting</h2>
|
||
<p>If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation <a href="https://gohugo.io/content-management/syntax-highlighting/" rel="external" target="_blank">according to Hugo’s documentation</a> and provide a syntax highlighting stylesheet file.</p>
|
||
<p>You can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to <code>assets/css/chroma-<NAME>.css</code>. To use it with your color variant you have to define <code>--CODE-theme: <NAME></code> in the color variant stylesheet file.</p>
|
||
<p>For an example, take a look into <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/assets/css/theme-relearn-light.css" rel="external" target="_blank"><code>theme-relearn-light.css</code></a> and <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/exampleSite/config/_default/hugo.toml" rel="external" target="_blank"><code>hugo.toml</code></a> of the exampleSite.</p>
|
||
<h2 id="theme-variant-advanced">Change the Variant (Advanced)</h2>
|
||
<p>The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.</p>
|
||
<p>Like with the <a href="/hugo-theme-relearn/basics/branding/index.html#multiple-variants">multiple variants</a> option, you are defining your theme variants in an array but now <em>not by simple strings</em> <strong>but in a table with suboptions</strong>.</p>
|
||
<p>Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'relearn-light'</span><span class="p">,</span> <span class="s1">'relearn-dark'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">relearn-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">relearn-dark</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"relearn-light"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"relearn-dark"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>you now write it that way:</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-light'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-dark'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-dark</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</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">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-light"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-dark"</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The <code>identifier</code> option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>identifier</td>
|
||
<td><em><empty></em></td>
|
||
<td>Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form <code>assets/css/theme-<IDENTIFIER>.css</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>see notes</td>
|
||
<td>The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>auto</td>
|
||
<td><em><empty></em></td>
|
||
<td>If set, the variant is treated as an <a href="/hugo-theme-relearn/basics/branding/index.html#adjust-to-os-settings">auto mode variant</a>. It has the same behavior as the <code>themeVariantAuto</code> option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="example-configuration-of-this-site">Example Configuration of This Site</h3>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-auto'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Relearn Light/Dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-light'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'relearn-dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">auto</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'zen-light'</span><span class="p">,</span> <span class="s1">'zen-dark'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-auto'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'Zen Light/Dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-light'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'zen-dark'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">params</span><span class="p">.</span><span class="nx">themeVariant</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'neon'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Relearn Light/Dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">relearn-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">auto</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">zen-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-auto</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Zen Light/Dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-light</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">zen-dark</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">neon</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</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">"auto"</span><span class="p">:</span> <span class="p">[],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Relearn Light/Dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-light"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"relearn-dark"</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="nt">"auto"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-light"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"zen-dark"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-auto"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Zen Light/Dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-light"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"zen-dark"</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"neon"</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="modify-shipped-variants">Modify Shipped Variants</h2>
|
||
<p>In case you like a shipped variant but only want to tweak some aspects, you have two choices:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Copy and change</p>
|
||
<p>You can copy the shipped variant file from the theme’s <code>assets/css</code> directory to the site’s <code>assets/css</code> directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your <code>hugo.toml</code> by the chosen name.</p>
|
||
</li>
|
||
<li>
|
||
<p>Create and import</p>
|
||
<p>You can create a new variant file in the site’s <code>assets/css</code> directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your <code>hugo.toml</code> by the chosen name.</p>
|
||
<p>For example, you want to use the <code>relearn-light</code> variant but want to change the syntax highlighting schema to the one used in the <code>neon</code> variant. For that, create a new <code>assets/css/theme-my-branding.css</code> in your site’s directory and add the following lines:</p>
|
||
|
||
<div class="tab-panel" data-tab-group="c7919c6aa9fc74d26456f62331295768">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="assetscsstheme-my-brandingcss"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('c7919c6aa9fc74d26456f62331295768','assetscsstheme-my-brandingcss')"
|
||
>
|
||
<span class="tab-nav-text">assets/css/theme-my-branding.css</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="assetscsstheme-my-brandingcss"
|
||
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-css" data-lang="css"><span class="line"><span class="cl"><span class="p">@</span><span class="k">import</span> <span class="s2">"theme-relearn-light.css"</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">:</span><span class="nd">root</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--CODE-theme</span><span class="p">:</span> <span class="n">neon</span><span class="p">;</span> <span class="c">/* name of the chroma stylesheet file */</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--CODE-BLOCK-color</span><span class="p">:</span> <span class="nb">rgba</span><span class="p">(</span> <span class="mi">226</span><span class="p">,</span> <span class="mi">228</span><span class="p">,</span> <span class="mi">229</span><span class="p">,</span> <span class="mi">1</span> <span class="p">);</span> <span class="c">/* fallback color for code text */</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--CODE-BLOCK-BG-color</span><span class="p">:</span> <span class="nb">rgba</span><span class="p">(</span> <span class="mi">40</span><span class="p">,</span> <span class="mi">42</span><span class="p">,</span> <span class="mi">54</span><span class="p">,</span> <span class="mi">1</span> <span class="p">);</span> <span class="c">/* fallback color for code background */</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>Afterwards put this in your <code>hugo.toml</code> to use your new variant:</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="s1">'my-branding'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">themeVariant</span><span class="p">:</span><span class="w"> </span><span class="l">my-branding</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"themeVariant"</span><span class="p">:</span> <span class="s2">"my-branding"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>In comparison to <em>copy and change</em>, this has the advantage that you profit from any adjustments to the <code>relearn-light</code> variant but keep your modifications.</p>
|
||
</li>
|
||
</ol>
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list 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/custom/index.html">Custom</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/categories/theming/index.html">Theming</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="customization">Customization</h1>
|
||
|
||
<h2 id="usage-scenarios">Usage scenarios</h2>
|
||
<p>The theme is usable in different scenarios, requiring the following mandatory settings in your <code>hugo.toml</code>. All settings not mentioned can be set to your liking.</p>
|
||
<h3 id="public-web-server-from-root">Public Web Server from Root</h3>
|
||
|
||
<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="nx">baseURL</span> <span class="p">=</span> <span class="s1">'https://example.com/'</span></span></span></code></pre></div></div>
|
||
</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">baseURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://example.com/</span></span></span></code></pre></div></div>
|
||
</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">"baseURL"</span><span class="p">:</span> <span class="s2">"https://example.com/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="public-web-server-from-subdirectory">Public Web Server from Subdirectory</h3>
|
||
|
||
<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="nx">baseURL</span> <span class="p">=</span> <span class="s1">'https://example.com/mysite/'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">baseURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://example.com/mysite/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">relativeURLs</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">"baseURL"</span><span class="p">:</span> <span class="s2">"https://example.com/mysite/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"relativeURLs"</span><span class="p">:</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="private-web-server-lan">Private Web Server (LAN)</h3>
|
||
<p>The same settings as with any of the public web server usage scenarios or</p>
|
||
|
||
<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="nx">baseURL</span> <span class="p">=</span> <span class="s1">'/'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">baseURL</span><span class="p">:</span><span class="w"> </span><span class="l">/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">relativeURLs</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"baseURL"</span><span class="p">:</span> <span class="s2">"/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"relativeURLs"</span><span class="p">:</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="file-system">File System</h3>
|
||
|
||
<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="nx">baseURL</span> <span class="p">=</span> <span class="s1">'/'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">baseURL</span><span class="p">:</span><span class="w"> </span><span class="l">/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">relativeURLs</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"baseURL"</span><span class="p">:</span> <span class="s2">"/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"relativeURLs"</span><span class="p">:</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
|
||
<p>Using a <code>baseURL</code> with a subdirectory and <code>relativeURLs=true</code> are mutually exclusive due to the fact, that <a href="https://github.com/gohugoio/hugo/issues/12130" rel="external" target="_blank">Hugo does not apply the <code>baseURL</code> correctly</a>.</p>
|
||
<p>If you need both, you have to generate your site twice but with different settings into separate directories.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<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>Sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) and generated social media links inside of your pages will always be generated with absolute URLs and will not work if you set <code>relativeURLs=true</code>.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<div class="box-content">
|
||
|
||
<p>If you are using <code>uglyURLs=false</code> (Hugo’s default), the theme will append an additional <code>index.html</code> to all page links to make your site be servable from the file system. If you don’t care about the file system and only serve your page via a web server you can generate the links without this:</p>
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableExplicitIndexURLs</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableExplicitIndexURLs"</span><span class="p">:</span> <span class="kc">true</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="activate-search">Activate search</h2>
|
||
<p>If not already present, add the following lines in your <code>hugo.toml</code> file.</p>
|
||
|
||
<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">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="s1">'html'</span><span class="p">,</span> <span class="s1">'rss'</span><span class="p">,</span> <span class="s1">'search'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">outputs</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">home</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">rss</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">search</span></span></span></code></pre></div></div>
|
||
</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">"outputs"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"home"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"rss"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"search"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library. Note that the <code>search</code> outputformat was named <code>json</code> in previous releases but was implemented differently. Although <code>json</code> still works, it is now deprecated.</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>If you want to use the search feature from the file system, migrating from an older installation of the theme, make sure to change your outputformat for the homepage from the now deprecated <code>json</code> to <code>search</code> <a href="/hugo-theme-relearn/basics/customization/index.html#activate-search">as seen below</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="activate-dedicated-search-page">Activate dedicated search page</h3>
|
||
<p>You can add a dedicated search page for your page by adding the <code>searchpage</code> outputformat to your home page by adding the following lines in your <code>hugo.toml</code> file. This will cause Hugo to generate a new file <code>http://example.com/mysite/search.html</code>.</p>
|
||
|
||
<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">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="s1">'html'</span><span class="p">,</span> <span class="s1">'rss'</span><span class="p">,</span> <span class="s1">'search'</span><span class="p">,</span> <span class="s1">'searchpage'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">outputs</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">home</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">rss</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">search</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">searchpage</span></span></span></code></pre></div></div>
|
||
</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">"outputs"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"home"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"rss"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"search"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"searchpage"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>You can access this page by either clicking on the magnifier glass or by typing some search term and pressing <code>ENTER</code> inside of the menu’s search box .</p>
|
||
<p><a href="#R-image-51a506b54004745a5f764571e0e246c6" class="lightbox-link"><img alt="Screenshot of the dedicated search page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/customization/search_page.png?&width=60pc" style=" height: auto; width: 60pc;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-51a506b54004745a5f764571e0e246c6"><img alt="Screenshot of the dedicated search page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/customization/search_page.png?&width=60pc"></a></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>To have Hugo create the dedicated search page successfully, you must not generate the URL <code>http://example.com/mysite/search.html</code> from your own content. This can happen if you set <code>uglyURLs=true</code> in your <code>hugo.toml</code> and defining a Markdown file <code>content/search.md</code>.</p>
|
||
<p>To make sure, there is no duplicate content for any given URL of your project, run <code>hugo --printPathWarnings</code>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="activate-print-support">Activate print support</h2>
|
||
<p>You can activate print support to add the capability to print whole chapters or even the complete site. Just add the <code>print</code> output format to your home, section and page in your <code>hugo.toml</code> as seen below:</p>
|
||
|
||
<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">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="s1">'html'</span><span class="p">,</span> <span class="s1">'rss'</span><span class="p">,</span> <span class="s1">'print'</span><span class="p">,</span> <span class="s1">'search'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">page</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'html'</span><span class="p">,</span> <span class="s1">'rss'</span><span class="p">,</span> <span class="s1">'print'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'html'</span><span class="p">,</span> <span class="s1">'rss'</span><span class="p">,</span> <span class="s1">'print'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">outputs</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">home</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">rss</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">print</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">search</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">page</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">rss</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">print</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">section</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">html</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">rss</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">print</span></span></span></code></pre></div></div>
|
||
</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">"outputs"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"home"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"rss"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"print"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"search"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"page"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"rss"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"print"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"section"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"html"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"rss"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"print"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.</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>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" rel="external" target="_blank">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" rel="external" target="_blank">Hugo’s URL handling</a> even if you’ve set <code>uglyURLs=true</code> in your <code>hugo.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
|
||
<p>Nevertheless, if you’re unhappy with the resulting URLs you can manually redefine <code>outputFormats.print</code> in your own <code>hugo.toml</code> to your liking.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="home-button-configuration">Home Button Configuration</h2>
|
||
<p>If the <code>disableLandingPageButton</code> option is set to <code>false</code>, a Home button will appear
|
||
on the left menu. It is an alternative for clicking on the logo. To edit the
|
||
appearance, you will have to configure the <code>landingPageName</code> for the defined languages:</p>
|
||
|
||
<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">languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-home'></i> Home"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-home'></i> Arrr! Homme"</span></span></span></code></pre></div></div>
|
||
</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">languages</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">en</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">landingPageName</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-home'></i> Home</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pir</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">landingPageName</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-home'></i> Arrr! Homme</span></span></span></code></pre></div></div>
|
||
</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">"languages"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"en"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"landingPageName"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home"</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="nt">"pir"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"landingPageName"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Homme"</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>If this option is not configured for a specific language, they will get their default values:</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-home'></i> Home"</span></span></span></code></pre></div></div>
|
||
</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">landingPageName</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-home'></i> Home</span></span></span></code></pre></div></div>
|
||
</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">"landingPageName"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The home button is going to look like this:</p>
|
||
<p><a href="#R-image-9b7cd95c1a02c8925e958b61e6545c35" class="lightbox-link"><img alt="Default Home Button" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/customization/home_button_defaults.png?width=18.75rem" style=" height: auto; width: 18.75rem;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-9b7cd95c1a02c8925e958b61e6545c35"><img alt="Default Home Button" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/customization/home_button_defaults.png?width=18.75rem"></a></p>
|
||
<h2 id="social-media-meta-tags">Social Media Meta Tags</h2>
|
||
<p>You can add social media meta tags for the <a href="https://gohugo.io/templates/internal/#open-graph" rel="external" target="_blank">Open Graph</a> protocol and <a href="https://gohugo.io/templates/internal/#twitter-cards" rel="external" target="_blank">Twitter Cards</a> to your site. These are configured as mentioned in the Hugo docs.</p>
|
||
<h2 id="change-the-menu-width">Change the Menu Width</h2>
|
||
<p>The menu width adjusts automatically for different screen sizes.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Screen Width</th>
|
||
<th>Menu Width</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>S</td>
|
||
<td>< 48rem</td>
|
||
<td>14.375rem</td>
|
||
</tr>
|
||
<tr>
|
||
<td>M</td>
|
||
<td>48rem - 60rem</td>
|
||
<td>14.375rem</td>
|
||
</tr>
|
||
<tr>
|
||
<td>L</td>
|
||
<td>>= 60rem</td>
|
||
<td>18.75rem</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The values for the screen width breakpoints aren’t configurable.</p>
|
||
<p>If you want to adjust the menu width you can define the following CSS variables in your <code>custom-header.html</code>. Note that <code>--MENU-WIDTH-S</code> applies to the menu flyout width in mobile mode for small screen sizes.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="p">:</span><span class="nd">root</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MENU-WIDTH-S</span><span class="p">:</span> <span class="mf">14.375</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MENU-WIDTH-M</span><span class="p">:</span> <span class="mf">14.375</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MENU-WIDTH-L</span><span class="p">:</span> <span class="mf">18.75</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div><h2 id="change-the-main-areas-max-width">Change the Main Area’s Max Width</h2>
|
||
<p>By default the main area width will only grow to a certain extent if more vertical screen space is available. This is done for readability purposes as long line are usually harder to read.</p>
|
||
<p>If you are unhappy with the default, you can define the following CSS variable in your <code>custom-header.html</code> and set the value to your liking. If you want to use all available space, select a really big value like <code>1000rem</code>;</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="p">:</span><span class="nd">root</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MAIN-WIDTH-MAX</span><span class="p">:</span> <span class="mf">80.25</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div><h2 id="own-shortcodes-with-javascript-dependencies">Own Shortcodes with JavaScript Dependencies</h2>
|
||
<p>Certain shortcodes make use of additional dependencies like JavaScript and CSS files. The theme only loads these dependencies if the shortcode is used. To do so correctly the theme adds management code in various files.</p>
|
||
<p>You can you use this mechanism in your own shortcodes. Say you want to add a shortcode <code>myshortcode</code> that also requires the <code>jquery</code> JavaScript library.</p>
|
||
<ol>
|
||
<li>
|
||
<p>Write the shortcode file <code>layouts/shortcodes/myshortcode.html</code> and add the following line</p>
|
||
|
||
<div class="tab-panel" data-tab-group="aca547a100925f712b3b05b0d0bc9338">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="layoutsshortcodesmyshortcodehtml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('aca547a100925f712b3b05b0d0bc9338','layoutsshortcodesmyshortcodehtml')"
|
||
>
|
||
<span class="tab-nav-text">layouts/shortcodes/myshortcode.html</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="layoutsshortcodesmyshortcodehtml"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">-</span> <span class="p">.</span><span class="nx">Page</span><span class="p">.</span><span class="nx">Store</span><span class="p">.</span><span class="nx">Set</span> <span class="s">"hasMyShortcode"</span> <span class="kc">true</span> <span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div></li>
|
||
<li>
|
||
<p>Add the following snippet to your <code>hugo.toml</code></p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">relearn</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">relearn</span><span class="p">.</span><span class="nx">dependencies</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">relearn</span><span class="p">.</span><span class="nx">dependencies</span><span class="p">.</span><span class="nx">myshortcode</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s1">'MyShortcode'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">relearn</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">dependencies</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">myshortcode</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">MyShortcode</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"relearn"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"dependencies"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"myshortcode"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"MyShortcode"</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>
|
||
</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>Add the dependency loader file <code>layouts/partials/dependencies/myshortcode.html</code>. The loader file will be called from multiple locations inside of the theme with the parameter <code>page</code> containing the current <a href="https://gohugo.io/methods/page/" rel="external" target="_blank">page</a> variable and <code>location</code> with one of the currently defined locations</p>
|
||
<ul>
|
||
<li><code>header</code>: if called at the end of the HTML <code>head</code> element</li>
|
||
<li><code>footer</code>: if called at the end of the HTML <code>body</code> element</li>
|
||
</ul>
|
||
|
||
<div class="tab-panel" data-tab-group="1d6d6948cb6955f4a0e4513755c4874c">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="layoutspartialsdependenciesmyshortcodehtml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('1d6d6948cb6955f4a0e4513755c4874c','layoutspartialsdependenciesmyshortcodehtml')"
|
||
>
|
||
<span class="tab-nav-text">layouts/partials/dependencies/myshortcode.html</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="layoutspartialsdependenciesmyshortcodehtml"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">-</span> <span class="k">if</span> <span class="nx">eq</span> <span class="p">.</span><span class="nx">location</span> <span class="s">"footer"</span> <span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nx">script</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://www.unpkg.com/jquery/dist/jquery.js"</span><span class="p">><</span><span class="o">/</span><span class="nx">script</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">-</span> <span class="nx">end</span> <span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div></li>
|
||
</ol>
|
||
<p>Character casing is relevant!</p>
|
||
<ul>
|
||
<li>the <code>name</code> setting in your <code>hugo.toml</code> must match the key (that needs to be prefixed with a <code>has</code>) you used for the store in your <code>layouts/shortcodes/myshortcode.html</code>.</li>
|
||
<li>the key on <code>params.relearn.dependencies</code> in your <code>hugo.toml</code> must match the base file name of your loader file.</li>
|
||
</ul>
|
||
<p>See the <code>math</code>, <code>mermaid</code> and <code>openapi</code> shortcodes for examples.</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>If you are really into customization of the theme and want to use the dependency loader for your own locations, you can do this by simply calling it from inside of your overriden partials</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">-</span> <span class="nx">partial</span> <span class="s">"dependencies.html"</span> <span class="p">(</span><span class="nx">dict</span> <span class="s">"page"</span> <span class="p">.</span> <span class="s">"location"</span> <span class="s">"mylocation"</span><span class="p">)</span> <span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<h2 id="output-formats">Output Formats</h2>
|
||
<p>Certain parts of the theme can be changed for support of your own <a href="https://gohugo.io/templates/output-formats/" rel="external" target="_blank">output formats</a>. Eg. if you define a new output format <code>PLAINTEXT</code> in your <code>hugo.toml</code>, you can add a file <code>layouts/partials/header.plaintext.html</code> to change the way, the page header should look like for that output format.</p>
|
||
<h2 id="react-to-variant-switches-in-javascript">React to Variant Switches in JavaScript</h2>
|
||
<p>Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event <code>themeVariantLoaded</code> on the <code>document</code> will be dispatched. You can add an event listener and react to changes.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span> <span class="s1">'themeVariantLoaded'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span> <span class="nx">e</span> <span class="p">){</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span> <span class="nx">e</span><span class="p">.</span><span class="nx">detail</span><span class="p">.</span><span class="nx">variant</span> <span class="p">);</span> <span class="c1">// `relearn-light`
|
||
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">});</span></span></span></code></pre></div><h2 id="partials">Partials</h2>
|
||
<p>The Relearn theme has been built to be as configurable as possible by defining multiple <a href="https://gohugo.io/templates/partials/" rel="external" target="_blank">partials</a></p>
|
||
<p>In <code>themes/hugo-theme-relearn/layouts/partials/</code>, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead <a href="https://gohugo.io/themes/customizing/" rel="external" target="_blank">follow this page</a>. You’d create a new partial in the <code>layouts/partials</code> folder of your local project. This partial will have the priority.</p>
|
||
<p>This theme defines the following partials :</p>
|
||
<ul>
|
||
<li><code>header.html</code>: the header of the page. See <a href="/hugo-theme-relearn/basics/customization/index.html#output-formats">output-formats</a></li>
|
||
<li><code>footer.html</code>: the footer of the page. See <a href="/hugo-theme-relearn/basics/customization/index.html#output-formats">output-formats</a></li>
|
||
<li><code>body.html</code>: the body of the page. The body may contain of one or many articles. See <a href="/hugo-theme-relearn/basics/customization/index.html#output-formats">output-formats</a></li>
|
||
<li><code>article.html</code>: the output for a single article, can contain elements around your content. See <a href="/hugo-theme-relearn/basics/customization/index.html#output-formats">output-formats</a></li>
|
||
<li><code>menu.html</code>: left menu. <em>Not meant to be overwritten</em></li>
|
||
<li><code>search.html</code>: search box. <em>Not meant to be overwritten</em></li>
|
||
<li><code>custom-header.html</code>: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include <code>style</code> HTML tag directive in your file.</li>
|
||
<li><code>custom-footer.html</code>: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include <code>javascript</code> HTML tag directive in your file.</li>
|
||
<li><code>favicon.html</code>: the favicon</li>
|
||
<li><code>heading.html</code>: side-wide configuration to change the pages title headings.</li>
|
||
<li><code>heading-pre.html</code>: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPre</code> setting into account.</li>
|
||
<li><code>heading-post.html</code>: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPost</code> setting into account.</li>
|
||
<li><code>logo.html</code>: the logo, on top left hand corner</li>
|
||
<li><code>meta.html</code>: HTML meta tags, if you want to change default behavior</li>
|
||
<li><code>menu-pre.html</code>: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s <code>menuPre</code> setting into account.</li>
|
||
<li><code>menu-post.html</code>: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s <code>menuPost</code> setting into account.</li>
|
||
<li><code>menu-footer.html</code>: footer of the left menu</li>
|
||
<li><code>toc.html</code>: table of contents</li>
|
||
<li><code>content.html</code>: the content page itself. This can be overridden if you want to display page’s meta data above or below the content.</li>
|
||
<li><code>content-header.html</code>: header above the title, has a default implementation but you can overwrite it if you don’t like it.</li>
|
||
<li><code>content-footer.html</code>: footer below the content, has a default implementation but you can overwrite it if you don’t like it.</li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="stylesheet-generator">Stylesheet generator</h1>
|
||
|
||
<p>This interactive tool may help you to generate your own color variant stylesheet.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-b7e39aa004bc41f8d6ead2c66e54fe7c" aria-controls="R-expandcontent-b7e39aa004bc41f8d6ead2c66e54fe7c" >
|
||
<label class="expand-label" for="R-expand-b7e39aa004bc41f8d6ead2c66e54fe7c" >
|
||
<i class="fa-fw fas fa-chevron-down"></i>
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
Show usage instructions
|
||
</label>
|
||
<div id="R-expandcontent-b7e39aa004bc41f8d6ead2c66e54fe7c" class="expand-content">
|
||
|
||
<p>To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.</p>
|
||
<p>The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph <strong>and the page</strong> will update accordingly.</p>
|
||
<p>The arrowed lines reflect how colors are inherited through different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.</p>
|
||
<p>To better understand this select the <code>neon</code> variant and modify the different heading colors. There, colors for the heading <code>h2</code>, <code>h3</code> and <code>h4</code> are explicitly set. <code>h5</code> is not set and inherits its value from <code>h4</code>. <code>h6</code> is also not set and inherits its value from <code>h5</code>.</p>
|
||
<p>Once you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can <strong>browse to other pages</strong> and even close the browser <strong>without losing your changes</strong>.</p>
|
||
<p>Once you are satisfied, you can download the new variants file and copy it into your site’s <code>assets/css</code> directory. Afterwards you have to adjust the <code>themeVariant</code> parameter in your <code>hugo.toml</code> to your chosen file name.</p>
|
||
<p>Eg. if your new variants file is named <code>theme-my-custom-variant.css</code>, you have to set <code>themeVariant='my-custom-variant'</code> to use it.</p>
|
||
<p>See the docs for <a href="/hugo-theme-relearn/basics/branding/index.html">further configuration options</a></p>
|
||
</div>
|
||
</div>
|
||
<p><span class="btn cstyle interactive secondary"><button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button"><i class="fa-fw fas fa-download"></i> <span class="title">Download variant</span></button></span>
|
||
<span class="btn cstyle interactive warning"><button onclick="window.variants&&variants.resetVariant();this.blur();" type="button"><i class="fa-fw fas fa-trash"></i> <span class="title">Reset variant</span></button></span></p>
|
||
<div id="R-vargenerator" class="mermaid zoomable" style="background-color: var(--INTERNAL-MAIN-TEXT-color);">Graph</div>
|
||
<p><span class="btn cstyle interactive secondary"><button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button"><i class="fa-fw fas fa-download"></i> <span class="title">Download variant</span></button></span>
|
||
<span class="btn cstyle interactive warning"><button onclick="window.variants&&variants.resetVariant();this.blur();" type="button"><i class="fa-fw fas fa-trash"></i> <span class="title">Reset variant</span></button></span></p>
|
||
<script>
|
||
window.variants && variants.generator( '#R-vargenerator' );
|
||
</script>
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list 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/theming/index.html">Theming</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="topbar-modification">Topbar Modification</h1>
|
||
|
||
<p>The theme comes with a reasonably configured topbar.</p>
|
||
<p><a href="#R-image-37063595deb7f7e8ec89cd8e6150a367" class="lightbox-link"><img alt="Topbar on mobile devices" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/topbar/topbar-closed.png" style=" height: auto; width: auto;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-37063595deb7f7e8ec89cd8e6150a367"><img alt="Topbar on mobile devices" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/topbar/topbar-closed.png"></a></p>
|
||
<p>Nevertheless, your requirements may differ from this configuration. Luckily the theme got you covered as the themebar, its buttons and the functionality behind these buttons is fully configurable by you.</p>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>All mentioned file names below can be clicked and show you the implementation for a better understanding.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="areas">Areas</h2>
|
||
<p>The default configuration comes with three predefined areas that may contain an arbitrary set of buttons.</p>
|
||
<p><a href="#R-image-9fec1673c0168d6c735ec80cdde727cc" class="lightbox-link"><img alt="Topbar with default areas marked" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/basics/topbar/topbar-areas.png" style=" height: auto; width: auto;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-9fec1673c0168d6c735ec80cdde727cc"><img alt="Topbar with default areas marked" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/basics/topbar/topbar-areas.png"></a></p>
|
||
<ul>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/start.html" rel="external" target="_blank"><strong>start</strong></a>: shown between menu and breadcrumb</li>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html" rel="external" target="_blank"><strong>end</strong></a>: shown on the opposite breadcrumb side in comparison to the <em>start</em> area</li>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/more.html" rel="external" target="_blank"><strong>more</strong></a>: shown when pressing the <span class="btn cstyle transparent"><span><i class="fa-fw fas fa-ellipsis-v"></i></span></span> <em>more</em> button in the topbar</li>
|
||
</ul>
|
||
<p>While you can not add additional areas in the topbar, you are free to configure additional buttons that behave like the <em>more</em> button, providing further user defined areas.</p>
|
||
<h2 id="buttons">Buttons</h2>
|
||
<p>The theme ships with the following predefined buttons (from left to right in the screenshot)</p>
|
||
<ul>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-bars"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/sidebar.html" rel="external" target="_blank"><strong>sidebar</strong></a>: opens the sidebar flyout if in mobile layout</li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-list-alt"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" rel="external" target="_blank"><strong>toc</strong></a>: opens the table of contents in an overlay</li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-pen"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/edit.html" rel="external" target="_blank"><strong>edit</strong></a>: browses to the editable page if the <code>editURL</code> <a href="/hugo-theme-relearn/basics/configuration/index.html">parameter is set</a></li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-print"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" rel="external" target="_blank"><strong>print</strong></a>: browses to the chapters printable page if <a href="/hugo-theme-relearn/basics/customization/index.html#activate-print-support">print support</a> was activated</li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-chevron-left"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/prev.html" rel="external" target="_blank"><strong>prev</strong></a>: browses to the previous page if there is one</li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-chevron-right"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/next.html" rel="external" target="_blank"><strong>next</strong></a>: browses to the next page if there is one</li>
|
||
<li><span class="btn cstyle transparent"><span><i class="fa-fw fas fa-ellipsis-v"></i></span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" rel="external" target="_blank"><strong>more</strong></a>: opens the overlay for the <em>more</em> area</li>
|
||
</ul>
|
||
<p>Not all buttons are displayed at every given time. This is configurable (see below if interested).</p>
|
||
<h2 id="redefining-areas">Redefining Areas</h2>
|
||
<p>Each predefined area and button comes in their own file. By that it is easy for you to overwrite an area file in your installation reusing only the buttons you like.</p>
|
||
<p>Eg. you can redefine the predefined <em>end</em> area by adding the file <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html" rel="external" target="_blank"><code>layouts/partials/topbar/area/end.html</code></a> in your installation (not in the theme itself) to remove all but the <em>more</em> button.</p>
|
||
<p>The below example sets an explicit value for the <code>onempty</code> parameter, overriding the specific default value for this button (these defaults vary depending on the button). The parameter causes the <em>more</em> button to always be displayed instead of hiding once its content is empty.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"topbar/button/more.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"onempty"</span> <span class="s">"disable"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div><h2 id="defining-own-buttons">Defining own Buttons</h2>
|
||
<h3 id="button-types">Button Types</h3>
|
||
<p>The theme distinguishes between two types of buttons:</p>
|
||
<ul>
|
||
<li><a href="/hugo-theme-relearn/basics/topbar/index.html#button"><strong>button</strong></a>: a clickable button that either browses to another site, triggers a user defined script or opens an overlay containing user defined content</li>
|
||
<li><a href="/hugo-theme-relearn/basics/topbar/index.html#area-button"><strong>area-button</strong></a>: the template for the <span class="btn cstyle transparent"><span><i class="fa-fw fas fa-ellipsis-v"></i></span></span> <em>more</em> button, to define your own area overlay buttons</li>
|
||
</ul>
|
||
<h3 id="button-parameter">Button Parameter</h3>
|
||
<h4 id="screen-widths-and-actions">Screen Widths and Actions</h4>
|
||
<p>Depending on the screen width you can configure how the button should behave. Screen width is divided into three classes:</p>
|
||
<ul>
|
||
<li><strong>s</strong>: (controlled by the <code>onwidths</code> parameter) mobile layout where the menu sidebar is hidden</li>
|
||
<li><strong>m</strong>: (controlled by the <code>onwidthm</code> parameter) desktop layout with visible sidebar while the content area width still resizes</li>
|
||
<li><strong>l</strong>: (controlled by the <code>onwidthl</code> parameter) desktop layout with visible sidebar once the content area reached its maximum width</li>
|
||
</ul>
|
||
<p>For each width class, you can configure one of the following actions:</p>
|
||
<ul>
|
||
<li><code>show</code>: the button is displayed in its given area</li>
|
||
<li><code>hide</code>: the button is removed</li>
|
||
<li><code>area-XXX</code>: the button is moved from its given area into the area <code>XXX</code>; eg. this is used to move buttons to the <em>more</em> area overlay in the mobile layout</li>
|
||
</ul>
|
||
<h4 id="hiding-and-disabling-stuff">Hiding and Disabling Stuff</h4>
|
||
<p>While hiding a button depending on the screen size can be configured with the above described <em>hide</em> action, you may want to hide the button on certain other conditions as well.</p>
|
||
<p>For example, the <em>print</em> button in its default configuration should only be displayed if print support was configured. This is done in your button template by checking the conditions first before displaying the button (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>).</p>
|
||
<p>Another preferred condition for hiding a button is, if the displayed overlay is empty. This is the case for the <em>toc</em> (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>) as well as the <em>more</em> button (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>) and controlled by the parameter <code>onempty</code>.</p>
|
||
<p>This parameter can have one of the following values:</p>
|
||
<ul>
|
||
<li><code>disable</code>: the button displayed in disabled state if the overlay is empty</li>
|
||
<li><code>hide</code>: the button is removed if the overlay is empty</li>
|
||
</ul>
|
||
<p>If you want to disable a button containing <em>no overlay</em>, this can be achieved by an empty <code>href</code> parameter. An example can be seen in the <em>prev</em> button (see <code>layouts/partials/topbar/button/prev.html</code>) where the URL for the previous site may be empty.</p>
|
||
<h2 id="reference">Reference</h2>
|
||
<h3 id="button">Button</h3>
|
||
<p>Contains the basic button functionality and is used as a base implementation for all other buttons (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/button.html" rel="external" target="_blank"><code>layouts/partials/topbar/func/button.html</code></a>).</p>
|
||
<p>Call this from your own button templates if you want to implement a button without an overlay like the <em>print</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>) or with an overlay containing arbitrary content like the <em>toc</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>).</p>
|
||
<p>For displaying an area in the button’s overlay, see <a href="/hugo-theme-relearn/basics/topbar/index.html#area-button">Area-Button</a>.</p>
|
||
<h4 id="parameter">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>page</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference to the page.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>class</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory unique class name for this button. Displaying two buttons with the same value for <strong>class</strong> is undefined.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>href</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Either the destination URL for the button or JavaScript code to be executed on click.<br><br>- if starting with <code>javascript:</code> all following text will be executed in your browser<br>- every other string will be interpreted as URL<br>- if empty the button will be displayed in disabled state regardless of its <strong>content</strong></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>disable</code></td>
|
||
<td>Defines what to do with the button if the content parameter was set but ends up empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>hint</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text displayed in the tooltip.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text for the button.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>content</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary HTML to put into the content overlay. This parameter may be empty. In this case no overlay will be generated.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="area-button">Area-Button</h3>
|
||
<p>Contains the basic functionality to display area overlay buttons (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/area-button.html" rel="external" target="_blank"><code>layouts/partials/topbar/func/area-button.html</code></a>).</p>
|
||
<p>Call this from your own button templates if you want to implement a button with an area overlay like the <em>more</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" rel="external" target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>).</p>
|
||
<h4 id="parameter-1">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>page</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference to the page.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>area</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory unique area name for this area. Displaying two areas with the same value for <strong>area</strong> is undefined.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>disable</code></td>
|
||
<td>Defines what to do with the button if the content overlay is empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>hint</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text displayed in the tooltip.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text for the button.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="predefined-buttons">Predefined Buttons</h3>
|
||
<p>The predefined buttons by the theme (all other buttons besides the <em>more</em> and <em>toc</em> button in <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button" rel="external" target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
|
||
<p>Call these from your own redefined area templates if you want to use default button behavior.</p>
|
||
<p>The <code><varying></code> parameter values are different for each button and configured for standard behavior as seen on this page.</p>
|
||
<h4 id="parameter-2">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>page</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference to the page.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="predefined-overlay-buttons">Predefined Overlay-Buttons</h3>
|
||
<p>The predefined buttons by the theme that open an overlay (the <em>more</em> and <em>toc</em> button in <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button" rel="external" target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
|
||
<p>Call these from your own redefined area templates if you want to use default button behavior utilizing overlay functionality.</p>
|
||
<p>The <code><varying></code> parameter values are different for each button and configured for standard behavior as seen on this page.</p>
|
||
<h4 id="parameter-3">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>page</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference to the page.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>disable</code></td>
|
||
<td>Defines what to do with the button if the content overlay is empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="history">History</h1>
|
||
|
||
<div class="include hide-first-heading">
|
||
<h1 id="changelog">Changelog</h1>
|
||
<h2 id="5270-2024-04-07">5.27.0 (2024-04-07)</h2>
|
||
<h3 id="enhancements">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: simplify title generation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/825" rel="external" target="_blank">#825</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust to Hugo’s build-in code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/824" rel="external" target="_blank">#824</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] link: warn if fragment is not found <a href="https://github.com/McShelby/hugo-theme-relearn/issues/823" rel="external" target="_blank">#823</a></li>
|
||
<li>[<strong>feature</strong>] theme: add styling for selected HTML elements <a href="https://github.com/McShelby/hugo-theme-relearn/issues/822" rel="external" target="_blank">#822</a></li>
|
||
<li>[<strong>feature</strong>] a11y: improve search box <a href="https://github.com/McShelby/hugo-theme-relearn/issues/821" rel="external" target="_blank">#821</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] dependencies: make loader more versatile <a href="https://github.com/McShelby/hugo-theme-relearn/issues/820" rel="external" target="_blank">#820</a></li>
|
||
<li>[<strong>feature</strong>] nav: scroll to prev/next heading using keyboard shortcut <a href="https://github.com/McShelby/hugo-theme-relearn/issues/819" rel="external" target="_blank">#819</a></li>
|
||
<li>[<strong>feature</strong>] breadcrumb: use .LinkTitle instead of .Title if available <a href="https://github.com/McShelby/hugo-theme-relearn/issues/816" rel="external" target="_blank">#816</a></li>
|
||
</ul>
|
||
<h3 id="fixes">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile <a href="https://github.com/McShelby/hugo-theme-relearn/issues/808" rel="external" target="_blank">#808</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5262-2024-03-18">5.26.2 (2024-03-18)</h2>
|
||
<h3 id="enhancements-1">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] icons: use fixed width to ease layout <a href="https://github.com/McShelby/hugo-theme-relearn/issues/812" rel="external" target="_blank">#812</a></li>
|
||
</ul>
|
||
<h3 id="fixes-1">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: broken since version 5.26.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/813" rel="external" target="_blank">#813</a></li>
|
||
<li>[<strong>bug</strong>] search: fix result links for pages in root <a href="https://github.com/McShelby/hugo-theme-relearn/issues/810" rel="external" target="_blank">#810</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5261-2024-03-17">5.26.1 (2024-03-17)</h2>
|
||
<h3 id="fixes-2">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: show reset button after pan <a href="https://github.com/McShelby/hugo-theme-relearn/issues/807" rel="external" target="_blank">#807</a></li>
|
||
<li>[<strong>bug</strong>] openapi: make it run for <code>file://</code> protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/806" rel="external" target="_blank">#806</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix relative path detection if <code>relativeURLs=false</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/804" rel="external" target="_blank">#804</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5260-2024-03-16">5.26.0 (2024-03-16)</h2>
|
||
<h3 id="enhancements-2">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] image: add lazy loading image effect option <a href="https://github.com/McShelby/hugo-theme-relearn/issues/803" rel="external" target="_blank">#803</a></li>
|
||
<li>[<strong>feature</strong>] render-hook: support Markdown attributes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/795" rel="external" target="_blank">#795</a></li>
|
||
<li>[<strong>feature</strong>] theme: support full page width <a href="https://github.com/McShelby/hugo-theme-relearn/issues/752" rel="external" target="_blank">#752</a></li>
|
||
</ul>
|
||
<h3 id="fixes-3">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] clipboard: fix broken style if block code is in table <a href="https://github.com/McShelby/hugo-theme-relearn/issues/790" rel="external" target="_blank">#790</a></li>
|
||
<li>[<strong>bug</strong>] nav: browser back navigation does not jump to the correct position <a href="https://github.com/McShelby/hugo-theme-relearn/issues/509" rel="external" target="_blank">#509</a></li>
|
||
</ul>
|
||
<h3 id="maintenance">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: update all available actions to nodejs 20 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/802" rel="external" target="_blank">#802</a></li>
|
||
<li>[<strong>task</strong>] openapi: update swagger-ui to 5.11.10 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/798" rel="external" target="_blank">#798</a></li>
|
||
<li>[<strong>task</strong>] mermaid: update to 10.9.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/797" rel="external" target="_blank">#797</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5250-2024-02-29">5.25.0 (2024-02-29)</h2>
|
||
<h3 id="enhancements-3">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: print out GitInfo in page footer if configured <a href="https://github.com/McShelby/hugo-theme-relearn/issues/786" rel="external" target="_blank">#786</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] resources: new shortcode to deprecate attachments shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/22" rel="external" target="_blank">#22</a></li>
|
||
</ul>
|
||
<h3 id="fixes-4">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: fix compat warning <a href="https://github.com/McShelby/hugo-theme-relearn/issues/787" rel="external" target="_blank">#787</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5243-2024-02-28">5.24.3 (2024-02-28)</h2>
|
||
<h3 id="fixes-5">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: avoid crash on 404 if author settings want to warn <a href="https://github.com/McShelby/hugo-theme-relearn/issues/785" rel="external" target="_blank">#785</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5242-2024-02-24">5.24.2 (2024-02-24)</h2>
|
||
<h3 id="enhancements-4">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] image: adjust to Hugo 0.123 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/777" rel="external" target="_blank">#777</a></li>
|
||
</ul>
|
||
<h3 id="fixes-6">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] link: resolve fragments <a href="https://github.com/McShelby/hugo-theme-relearn/issues/775" rel="external" target="_blank">#775</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5241-2024-02-18">5.24.1 (2024-02-18)</h2>
|
||
<h3 id="enhancements-5">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] link: make resolution reporting configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/774" rel="external" target="_blank">#774</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5240-2024-02-17">5.24.0 (2024-02-17)</h2>
|
||
<h3 id="enhancements-6">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: compatibility with Hugo 0.123 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/771" rel="external" target="_blank">#771</a></li>
|
||
<li>[<strong>feature</strong>] topbar: support editURL in frontmatter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/764" rel="external" target="_blank">#764</a></li>
|
||
<li>[<strong>feature</strong>] menu: use –MENU-WIDTH-S to adjust mobile flyout <a href="https://github.com/McShelby/hugo-theme-relearn/issues/761" rel="external" target="_blank">#761</a></li>
|
||
<li>[<strong>feature</strong>] figure: support built-in shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/746" rel="external" target="_blank">#746</a></li>
|
||
<li>[<strong>feature</strong>] theme: make heading a template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/744" rel="external" target="_blank">#744</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: make arrow nav browse through terms <a href="https://github.com/McShelby/hugo-theme-relearn/issues/742" rel="external" target="_blank">#742</a></li>
|
||
<li>[<strong>feature</strong>] theme: switch from config.toml to hugo.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/741" rel="external" target="_blank">#741</a></li>
|
||
<li>[<strong>feature</strong>] button: make non-interactive if used as mock <a href="https://github.com/McShelby/hugo-theme-relearn/issues/740" rel="external" target="_blank">#740</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] topbar: allow text for button <a href="https://github.com/McShelby/hugo-theme-relearn/issues/739" rel="external" target="_blank">#739</a></li>
|
||
<li>[<strong>feature</strong>] theme: run hugo demo site without warning <a href="https://github.com/McShelby/hugo-theme-relearn/issues/736" rel="external" target="_blank">#736</a></li>
|
||
<li>[<strong>feature</strong>] menu: make swipe handler passive <a href="https://github.com/McShelby/hugo-theme-relearn/issues/735" rel="external" target="_blank">#735</a></li>
|
||
<li>[<strong>feature</strong>] i18n: support standard Hugo options <a href="https://github.com/McShelby/hugo-theme-relearn/issues/733" rel="external" target="_blank">#733</a></li>
|
||
<li>[<strong>feature</strong>] a11y: show tab focus on images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/730" rel="external" target="_blank">#730</a></li>
|
||
<li>[<strong>feature</strong>] a11y: improve discovering links on keyboard navigation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/726" rel="external" target="_blank">#726</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] variant: increase contrast for light themes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/722" rel="external" target="_blank">#722</a></li>
|
||
<li>[<strong>feature</strong>] theme: break build if minimum Hugo version is not matched <a href="https://github.com/McShelby/hugo-theme-relearn/issues/719" rel="external" target="_blank">#719</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: humanize term on missing term title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/713" rel="external" target="_blank">#713</a></li>
|
||
</ul>
|
||
<h3 id="fixes-7">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] taxonomy: display translated title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/772" rel="external" target="_blank">#772</a></li>
|
||
<li>[<strong>bug</strong>] highlight: fix codefence syntax in Hugo >= 0.121.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/749" rel="external" target="_blank">#749</a></li>
|
||
<li>[<strong>bug</strong>] link: fix links to pages containing dots in their name <a href="https://github.com/McShelby/hugo-theme-relearn/issues/748" rel="external" target="_blank">#748</a></li>
|
||
<li>[<strong>bug</strong>] image: get resource images if link is prefixed with <code>./</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/747" rel="external" target="_blank">#747</a></li>
|
||
<li>[<strong>bug</strong>] theme: switch dependency colors on OS color scheme change <a href="https://github.com/McShelby/hugo-theme-relearn/issues/745" rel="external" target="_blank">#745</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: fix O(n²) buttons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/738" rel="external" target="_blank">#738</a></li>
|
||
<li>[<strong>bug</strong>] button: fix whitespacing in FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/737" rel="external" target="_blank">#737</a></li>
|
||
<li>[<strong>bug</strong>] i18n: fix warning messages for zh-CN <a href="https://github.com/McShelby/hugo-theme-relearn/issues/732" rel="external" target="_blank">#732</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: fix zoom button <a href="https://github.com/McShelby/hugo-theme-relearn/issues/725" rel="external" target="_blank">#725</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix JS errors on <code>hugo --minifiy</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/724" rel="external" target="_blank">#724</a></li>
|
||
<li>[<strong>bug</strong>] include: fix whitespacing in codefences <a href="https://github.com/McShelby/hugo-theme-relearn/issues/723" rel="external" target="_blank">#723</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5232-2023-11-03">5.23.2 (2023-11-03)</h2>
|
||
<h3 id="enhancements-7">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: improve taxonomy page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/712" rel="external" target="_blank">#712</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: warn on missing term title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/709" rel="external" target="_blank">#709</a></li>
|
||
</ul>
|
||
<h3 id="fixes-8">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] taxonomy: fix sorting of terms on content pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/710" rel="external" target="_blank">#710</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5231-2023-10-30">5.23.1 (2023-10-30)</h2>
|
||
<h3 id="enhancements-8">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: improve term page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/705" rel="external" target="_blank">#705</a></li>
|
||
</ul>
|
||
<h3 id="fixes-9">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix typo in chroma-learn.css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/708" rel="external" target="_blank">#708</a></li>
|
||
<li>[<strong>bug</strong>] links: ignore local markdown links linking to files with extension <a href="https://github.com/McShelby/hugo-theme-relearn/issues/707" rel="external" target="_blank">#707</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5230-2023-10-29">5.23.0 (2023-10-29)</h2>
|
||
<h3 id="enhancements-9">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: allow for content on term pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/701" rel="external" target="_blank">#701</a></li>
|
||
<li>[<strong>feature</strong>] theme: write full file path on warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/699" rel="external" target="_blank">#699</a></li>
|
||
<li>[<strong>feature</strong>] theme: show anchor link and copy to clipboard button on mobile <a href="https://github.com/McShelby/hugo-theme-relearn/issues/697" rel="external" target="_blank">#697</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] config: adjust to changes in Hugo 0.120 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/693" rel="external" target="_blank">#693</a></li>
|
||
<li>[<strong>feature</strong>] variants: add more contrast to neon <a href="https://github.com/McShelby/hugo-theme-relearn/issues/692" rel="external" target="_blank">#692</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: only show zoom reset button if zoomed <a href="https://github.com/McShelby/hugo-theme-relearn/issues/691" rel="external" target="_blank">#691</a></li>
|
||
<li>[<strong>feature</strong>] menu: add additional sort options <a href="https://github.com/McShelby/hugo-theme-relearn/issues/684" rel="external" target="_blank">#684</a></li>
|
||
<li>[<strong>feature</strong>] theme: add social media meta information <a href="https://github.com/McShelby/hugo-theme-relearn/issues/683" rel="external" target="_blank">#683</a></li>
|
||
<li>[<strong>feature</strong>] theme: simplify additional JS dependencies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/682" rel="external" target="_blank">#682</a></li>
|
||
<li>[<strong>feature</strong>] links: warn if ref/relref is used falsly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/681" rel="external" target="_blank">#681</a></li>
|
||
<li>[<strong>feature</strong>] menu: make width configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/677" rel="external" target="_blank">#677</a></li>
|
||
<li>[<strong>feature</strong>] tabs: use color for link of inactive tabs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/675" rel="external" target="_blank">#675</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: modularize term list generation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/671" rel="external" target="_blank">#671</a></li>
|
||
<li>[<strong>feature</strong>] theme: remove warnings with <code>hugo --printI18nWarnings</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/670" rel="external" target="_blank">#670</a></li>
|
||
<li>[<strong>feature</strong>] theme: implement portable linking <a href="https://github.com/McShelby/hugo-theme-relearn/issues/377" rel="external" target="_blank">#377</a></li>
|
||
</ul>
|
||
<h3 id="fixes-10">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] links: extra space before link text <a href="https://github.com/McShelby/hugo-theme-relearn/issues/700" rel="external" target="_blank">#700</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: reset zoom correctly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/690" rel="external" target="_blank">#690</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix mobile layout for width=48rem <a href="https://github.com/McShelby/hugo-theme-relearn/issues/676" rel="external" target="_blank">#676</a></li>
|
||
<li>[<strong>bug</strong>] frontmatter: resemble documented shortcode style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/672" rel="external" target="_blank">#672</a></li>
|
||
<li>[<strong>bug</strong>] taxonomy: display terms in pages if <code>removePathAccents=true</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/669" rel="external" target="_blank">#669</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-1">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update mermaid to 10.6.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/703" rel="external" target="_blank">#703</a></li>
|
||
<li>[<strong>task</strong>] openapi: update swagger-ui to 5.9.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/702" rel="external" target="_blank">#702</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5221-2023-10-02">5.22.1 (2023-10-02)</h2>
|
||
<h3 id="enhancements-10">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Swahili translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/666" rel="external" target="_blank">#666</a></li>
|
||
<li>[<strong>feature</strong>] math: hide unrendered math <a href="https://github.com/McShelby/hugo-theme-relearn/issues/663" rel="external" target="_blank">#663</a></li>
|
||
<li>[<strong>feature</strong>] tabs: improve a11y by removing duplicate hidden title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/662" rel="external" target="_blank">#662</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: improve zoom UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/659" rel="external" target="_blank">#659</a></li>
|
||
</ul>
|
||
<h3 id="fixes-11">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix sidebar-flyout borders color for zen <a href="https://github.com/McShelby/hugo-theme-relearn/issues/667" rel="external" target="_blank">#667</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: fix RTL location of tooltip <a href="https://github.com/McShelby/hugo-theme-relearn/issues/661" rel="external" target="_blank">#661</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: ignore RTL for code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/660" rel="external" target="_blank">#660</a></li>
|
||
<li>[<strong>bug</strong>] expand: fix aria-controls <a href="https://github.com/McShelby/hugo-theme-relearn/issues/658" rel="external" target="_blank">#658</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix id generation for markdownified titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/657" rel="external" target="_blank">#657</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: avoid graph bombing on hugo –minify <a href="https://github.com/McShelby/hugo-theme-relearn/issues/656" rel="external" target="_blank">#656</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: fix width for some graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/655" rel="external" target="_blank">#655</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5220-2023-09-26">5.22.0 (2023-09-26)</h2>
|
||
<h3 id="enhancements-11">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: add pan&zoom reset <a href="https://github.com/McShelby/hugo-theme-relearn/issues/651" rel="external" target="_blank">#651</a></li>
|
||
<li>[<strong>feature</strong>] markdown: add interlace color for tables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/648" rel="external" target="_blank">#648</a></li>
|
||
<li>[<strong>feature</strong>] search: add breadcrumb to dedicated search results <a href="https://github.com/McShelby/hugo-theme-relearn/issues/647" rel="external" target="_blank">#647</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: optionally disable index pages for sections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/642" rel="external" target="_blank">#642</a></li>
|
||
</ul>
|
||
<h3 id="fixes-12">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variants: restore generator zoom <a href="https://github.com/McShelby/hugo-theme-relearn/issues/650" rel="external" target="_blank">#650</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: malused Fontawesome style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/649" rel="external" target="_blank">#649</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: avoid id collisions between headings and theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/646" rel="external" target="_blank">#646</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove HTML validation errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/644" rel="external" target="_blank">#644</a></li>
|
||
<li>[<strong>bug</strong>] breadcrumb: remove superflous whitespace between items <a href="https://github.com/McShelby/hugo-theme-relearn/issues/643" rel="external" target="_blank">#643</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5210-2023-09-18">5.21.0 (2023-09-18)</h2>
|
||
<h3 id="enhancements-12">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] topbar: make buttons configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/639" rel="external" target="_blank">#639</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: fix footer padding <a href="https://github.com/McShelby/hugo-theme-relearn/issues/637" rel="external" target="_blank">#637</a></li>
|
||
</ul>
|
||
<h3 id="fixes-13">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] breadcrumb: don’t ignore spaces for separator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/636" rel="external" target="_blank">#636</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix snyk code issues <a href="https://github.com/McShelby/hugo-theme-relearn/issues/633" rel="external" target="_blank">#633</a></li>
|
||
<li>[<strong>bug</strong>] images: apply image effects to lightbox images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/631" rel="external" target="_blank">#631</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-2">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] openapi: update to swagger 5.7.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/641" rel="external" target="_blank">#641</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5200-2023-08-26">5.20.0 (2023-08-26)</h2>
|
||
<h3 id="enhancements-13">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: support for colored borders between menu and content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/626" rel="external" target="_blank">#626</a></li>
|
||
<li>[<strong>feature</strong>] image: allow option to apply image effects globally <a href="https://github.com/McShelby/hugo-theme-relearn/issues/623" rel="external" target="_blank">#623</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] openapi: switch to light syntaxhighlightning where applicable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/621" rel="external" target="_blank">#621</a></li>
|
||
<li>[<strong>feature</strong>] images: document usage of images with links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/576" rel="external" target="_blank">#576</a></li>
|
||
</ul>
|
||
<h3 id="fixes-14">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] highlight: fix rendering for Hugo < 0.111 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/630" rel="external" target="_blank">#630</a></li>
|
||
<li>[<strong>bug</strong>] search: remove link underline on dedicated search page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/627" rel="external" target="_blank">#627</a></li>
|
||
<li>[<strong>bug</strong>] highlight: don’t switch to block view if hl_inline=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/618" rel="external" target="_blank">#618</a></li>
|
||
<li>[<strong>bug</strong>] variant: minor adjustments to zen variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/617" rel="external" target="_blank">#617</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: lazy render graph if it is initially hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/187" rel="external" target="_blank">#187</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-3">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] openapi: update to swagger 5.4.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/620" rel="external" target="_blank">#620</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5190-2023-08-12">5.19.0 (2023-08-12)</h2>
|
||
<h3 id="enhancements-14">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] highlight: add title parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/616" rel="external" target="_blank">#616</a></li>
|
||
<li>[<strong>feature</strong>] variant: signal variant switch as event <a href="https://github.com/McShelby/hugo-theme-relearn/issues/614" rel="external" target="_blank">#614</a></li>
|
||
<li>[<strong>feature</strong>] variant: add zen variant in light and dark <a href="https://github.com/McShelby/hugo-theme-relearn/issues/613" rel="external" target="_blank">#613</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Hungarian translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/604" rel="external" target="_blank">#604</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: update to 10.3.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/601" rel="external" target="_blank">#601</a></li>
|
||
</ul>
|
||
<h3 id="fixes-15">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] siteparam: avoid halt if param is a map/slice <a href="https://github.com/McShelby/hugo-theme-relearn/issues/611" rel="external" target="_blank">#611</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: fix broken zoom since update to v10 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/608" rel="external" target="_blank">#608</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: variant generator diagram does not respond to events <a href="https://github.com/McShelby/hugo-theme-relearn/issues/607" rel="external" target="_blank">#607</a></li>
|
||
<li>[<strong>bug</strong>] print: avoid chroma leak for relearn-dark <a href="https://github.com/McShelby/hugo-theme-relearn/issues/605" rel="external" target="_blank">#605</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-4">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to 10.3.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/610" rel="external" target="_blank">#610</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5180-2023-07-27">5.18.0 (2023-07-27)</h2>
|
||
<h3 id="enhancements-15">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] shortcodes: add more deprecation warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/598" rel="external" target="_blank">#598</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] shortcodes: change <code>context</code> parameter to <code>page</code> if called as partial <a href="https://github.com/McShelby/hugo-theme-relearn/issues/595" rel="external" target="_blank">#595</a></li>
|
||
<li>[<strong>feature</strong>] siteparam: support nested parameters and text formatting <a href="https://github.com/McShelby/hugo-theme-relearn/issues/590" rel="external" target="_blank">#590</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] a11y: improve when tabbing through links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/581" rel="external" target="_blank">#581</a></li>
|
||
</ul>
|
||
<h3 id="fixes-16">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] openapi: inherit RTL setting from Hugo content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/600" rel="external" target="_blank">#600</a></li>
|
||
<li>[<strong>bug</strong>] 404: fix display in RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/597" rel="external" target="_blank">#597</a></li>
|
||
<li>[<strong>bug</strong>] highlight: fix position of copy-to-clipboard button in RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/594" rel="external" target="_blank">#594</a></li>
|
||
<li>[<strong>bug</strong>] openapi: fix spelling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/593" rel="external" target="_blank">#593</a></li>
|
||
<li>[<strong>bug</strong>] search: fix typo in output format <a href="https://github.com/McShelby/hugo-theme-relearn/issues/591" rel="external" target="_blank">#591</a></li>
|
||
<li>[<strong>bug</strong>] tabs: fix tab selection by groupid <a href="https://github.com/McShelby/hugo-theme-relearn/issues/582" rel="external" target="_blank">#582</a></li>
|
||
<li>[<strong>bug</strong>] theme: restore compat with Hugo 0.95.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/580" rel="external" target="_blank">#580</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: improve display of links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/577" rel="external" target="_blank">#577</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5171-2023-06-22">5.17.1 (2023-06-22)</h2>
|
||
<h3 id="enhancements-16">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] highlight: make copy to clipboard appear on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/574" rel="external" target="_blank">#574</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5170-2023-06-22">5.17.0 (2023-06-22)</h2>
|
||
<h3 id="enhancements-17">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] highlight: add configurable line breaks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/169" rel="external" target="_blank">#169</a></li>
|
||
</ul>
|
||
<h3 id="fixes-17">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: support Hugo 0.114.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/573" rel="external" target="_blank">#573</a></li>
|
||
<li>[<strong>bug</strong>] taxonomy: fix number tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/570" rel="external" target="_blank">#570</a></li>
|
||
<li>[<strong>bug</strong>] highlight: improve copy to clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/569" rel="external" target="_blank">#569</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5162-2023-06-10">5.16.2 (2023-06-10)</h2>
|
||
<h3 id="enhancements-18">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: revamp 404 page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/566" rel="external" target="_blank">#566</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5161-2023-06-09">5.16.1 (2023-06-09)</h2>
|
||
<h3 id="enhancements-19">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add deprecation warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/565" rel="external" target="_blank">#565</a></li>
|
||
</ul>
|
||
<h3 id="fixes-18">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: allow for YAML frontmatter inside of graph <a href="https://github.com/McShelby/hugo-theme-relearn/issues/564" rel="external" target="_blank">#564</a></li>
|
||
<li>[<strong>bug</strong>] alias: fix redirect URLs in case of empty BaseURL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/562" rel="external" target="_blank">#562</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5160-2023-06-08">5.16.0 (2023-06-08)</h2>
|
||
<h3 id="enhancements-20">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: add title and icon option <a href="https://github.com/McShelby/hugo-theme-relearn/issues/552" rel="external" target="_blank">#552</a></li>
|
||
<li>[<strong>feature</strong>] shortcodes: add style option to mimic code box color scheme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/551" rel="external" target="_blank">#551</a></li>
|
||
<li>[<strong>feature</strong>] tabs: support color options <a href="https://github.com/McShelby/hugo-theme-relearn/issues/550" rel="external" target="_blank">#550</a></li>
|
||
<li>[<strong>feature</strong>] favicon: add light & dark option for OS’s preferred color scheme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/549" rel="external" target="_blank">#549</a></li>
|
||
</ul>
|
||
<h3 id="fixes-19">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] icon: remove whitespace on start <a href="https://github.com/McShelby/hugo-theme-relearn/issues/560" rel="external" target="_blank">#560</a></li>
|
||
<li>[<strong>bug</strong>] shortcodes: avoid superflous margin at start and end of content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/558" rel="external" target="_blank">#558</a></li>
|
||
<li>[<strong>bug</strong>] expand: fix html encoding of finishing content tag <a href="https://github.com/McShelby/hugo-theme-relearn/issues/557" rel="external" target="_blank">#557</a></li>
|
||
<li>[<strong>bug</strong>] icon: fix ouput “raw HTML omitted” with goldmark config unsafe=false <a href="https://github.com/McShelby/hugo-theme-relearn/issues/555" rel="external" target="_blank">#555</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5152-2023-05-29">5.15.2 (2023-05-29)</h2>
|
||
<h3 id="enhancements-21">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: add support for category default taxonomy <a href="https://github.com/McShelby/hugo-theme-relearn/issues/541" rel="external" target="_blank">#541</a></li>
|
||
</ul>
|
||
<h3 id="fixes-20">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: work for Hugo < 0.112 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/546" rel="external" target="_blank">#546</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5151-2023-05-25">5.15.1 (2023-05-25)</h2>
|
||
<h3 id="fixes-21">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shortcodes: intermediately use random ids instead of .Ordinal <a href="https://github.com/McShelby/hugo-theme-relearn/issues/543" rel="external" target="_blank">#543</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5150-2023-05-25">5.15.0 (2023-05-25)</h2>
|
||
<h3 id="enhancements-22">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tab: new shortcode to display single tab <a href="https://github.com/McShelby/hugo-theme-relearn/issues/538" rel="external" target="_blank">#538</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: treat groupid as unique if not set <a href="https://github.com/McShelby/hugo-theme-relearn/issues/537" rel="external" target="_blank">#537</a></li>
|
||
<li>[<strong>feature</strong>] expand: indent expanded content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/536" rel="external" target="_blank">#536</a></li>
|
||
<li>[<strong>feature</strong>] notice: make boxes more prominent <a href="https://github.com/McShelby/hugo-theme-relearn/issues/535" rel="external" target="_blank">#535</a></li>
|
||
</ul>
|
||
<h3 id="fixes-22">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: fix build error since Hugo 0.112 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/540" rel="external" target="_blank">#540</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-5">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update Mermaid to 9.4.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/534" rel="external" target="_blank">#534</a></li>
|
||
<li>[<strong>task</strong>] mermaid: update to 10.2.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/499" rel="external" target="_blank">#499</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5143-2023-05-20">5.14.3 (2023-05-20)</h2>
|
||
<h3 id="fixes-23">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: show taxonomy toc for standard installation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/533" rel="external" target="_blank">#533</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5142-2023-05-20">5.14.2 (2023-05-20)</h2>
|
||
<h3 id="fixes-24">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: translate breadcrumb and title for taxonomy <a href="https://github.com/McShelby/hugo-theme-relearn/issues/532" rel="external" target="_blank">#532</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5141-2023-05-20">5.14.1 (2023-05-20)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="5140-2023-05-19">5.14.0 (2023-05-19)</h2>
|
||
<h3 id="enhancements-23">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: improve search index for tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/531" rel="external" target="_blank">#531</a></li>
|
||
<li>[<strong>feature</strong>] tags: increase readability of taxonomy pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/530" rel="external" target="_blank">#530</a></li>
|
||
<li>[<strong>feature</strong>] nav: make breadcrumb separator configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/529" rel="external" target="_blank">#529</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add translation for default taxonomies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/528" rel="external" target="_blank">#528</a></li>
|
||
<li>[<strong>feature</strong>] theme: set appropriate defaults for all theme specific params <a href="https://github.com/McShelby/hugo-theme-relearn/issues/516" rel="external" target="_blank">#516</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow to display tags below article <a href="https://github.com/McShelby/hugo-theme-relearn/issues/513" rel="external" target="_blank">#513</a></li>
|
||
</ul>
|
||
<h3 id="fixes-25">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shortcode: make .context always a page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/527" rel="external" target="_blank">#527</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5132-2023-05-17">5.13.2 (2023-05-17)</h2>
|
||
<h3 id="fixes-26">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: enable print for pages with _build options <a href="https://github.com/McShelby/hugo-theme-relearn/issues/522" rel="external" target="_blank">#522</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5131-2023-05-16">5.13.1 (2023-05-16)</h2>
|
||
<h3 id="fixes-27">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] openapi: allow toc to scroll page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/526" rel="external" target="_blank">#526</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5130-2023-05-14">5.13.0 (2023-05-14)</h2>
|
||
<h3 id="enhancements-24">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] openapi: replace implementation with swagger-ui <a href="https://github.com/McShelby/hugo-theme-relearn/issues/523" rel="external" target="_blank">#523</a></li>
|
||
</ul>
|
||
<h3 id="fixes-28">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: avoid leaking shadows in neon print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/524" rel="external" target="_blank">#524</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5126-2023-05-04">5.12.6 (2023-05-04)</h2>
|
||
<h3 id="enhancements-25">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: better HTML titles and breadcrumbs for search and tag pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/521" rel="external" target="_blank">#521</a></li>
|
||
</ul>
|
||
<h3 id="fixes-29">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: avoid hiding of expander on hover when active item has children <a href="https://github.com/McShelby/hugo-theme-relearn/issues/520" rel="external" target="_blank">#520</a></li>
|
||
<li>[<strong>bug</strong>] menu: showVisitedLinks not working for some theme variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/518" rel="external" target="_blank">#518</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix resource URLs for 404 page on subdirectories <a href="https://github.com/McShelby/hugo-theme-relearn/issues/515" rel="external" target="_blank">#515</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5125-2023-03-28">5.12.5 (2023-03-28)</h2>
|
||
<h3 id="fixes-30">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] expand: not properly exanded when used in bullet point list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/508" rel="external" target="_blank">#508</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5124-2023-03-24">5.12.4 (2023-03-24)</h2>
|
||
<h3 id="fixes-31">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: disableExplicitIndexURLs param is not working as expected <a href="https://github.com/McShelby/hugo-theme-relearn/issues/505" rel="external" target="_blank">#505</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5123-2023-03-14">5.12.3 (2023-03-14)</h2>
|
||
<h3 id="fixes-32">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: fix links if only one language is present <a href="https://github.com/McShelby/hugo-theme-relearn/issues/503" rel="external" target="_blank">#503</a></li>
|
||
<li>[<strong>bug</strong>] shortcodes: allow markdown for title and content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/502" rel="external" target="_blank">#502</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5122-2023-03-03">5.12.2 (2023-03-03)</h2>
|
||
<h3 id="fixes-33">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix state for alwaysopen=false + collapsibleMenu=false <a href="https://github.com/McShelby/hugo-theme-relearn/issues/498" rel="external" target="_blank">#498</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5121-2023-02-26">5.12.1 (2023-02-26)</h2>
|
||
<h3 id="enhancements-26">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: add relearn bright theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/493" rel="external" target="_blank">#493</a></li>
|
||
</ul>
|
||
<h3 id="fixes-34">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] generator: fix setting of colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/494" rel="external" target="_blank">#494</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120-2023-02-24">5.12.0 (2023-02-24)</h2>
|
||
<h3 id="enhancements-27">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] frontmatter: support VSCode Front Matter extension <a href="https://github.com/McShelby/hugo-theme-relearn/issues/481" rel="external" target="_blank">#481</a></li>
|
||
<li>[<strong>feature</strong>] theme: make expand and image ids stable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/477" rel="external" target="_blank">#477</a></li>
|
||
<li>[<strong>feature</strong>] variant: set scrollbar color to dark for dark variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/471" rel="external" target="_blank">#471</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add full RTL support <a href="https://github.com/McShelby/hugo-theme-relearn/issues/470" rel="external" target="_blank">#470</a></li>
|
||
<li>[<strong>feature</strong>] piratify: fix some quirks, arrr <a href="https://github.com/McShelby/hugo-theme-relearn/issues/469" rel="external" target="_blank">#469</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimization for huge screen sizes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/466" rel="external" target="_blank">#466</a></li>
|
||
</ul>
|
||
<h3 id="fixes-35">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: write code ltr even for rtl languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/492" rel="external" target="_blank">#492</a></li>
|
||
<li>[<strong>bug</strong>] anchor: fix link in FF when served from file system <a href="https://github.com/McShelby/hugo-theme-relearn/issues/482" rel="external" target="_blank">#482</a></li>
|
||
<li>[<strong>bug</strong>] shortcodes: don’t break build and render for invalid parameters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/480" rel="external" target="_blank">#480</a></li>
|
||
<li>[<strong>bug</strong>] nav: restore scroll position on browser back <a href="https://github.com/McShelby/hugo-theme-relearn/issues/476" rel="external" target="_blank">#476</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid style leak for auto style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/473" rel="external" target="_blank">#473</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-6">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add imagebot <a href="https://github.com/McShelby/hugo-theme-relearn/issues/485" rel="external" target="_blank">#485</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5112-2023-02-07">5.11.2 (2023-02-07)</h2>
|
||
<h3 id="fixes-36">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tabs: nested tabs content is not displayed <a href="https://github.com/McShelby/hugo-theme-relearn/issues/468" rel="external" target="_blank">#468</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5111-2023-02-06">5.11.1 (2023-02-06)</h2>
|
||
<h3 id="fixes-37">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: include missing <code>theme-auto.css</code> in distribution <a href="https://github.com/McShelby/hugo-theme-relearn/issues/467" rel="external" target="_blank">#467</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110-2023-02-05">5.11.0 (2023-02-05)</h2>
|
||
<h3 id="enhancements-28">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Czech translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/455" rel="external" target="_blank">#455</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] lightbox: switch to CSS-only solution <a href="https://github.com/McShelby/hugo-theme-relearn/issues/451" rel="external" target="_blank">#451</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] variant: add support for <code>prefers-color-scheme</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/445" rel="external" target="_blank">#445</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] expand: refactor for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/339" rel="external" target="_blank">#339</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: make zoom configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/144" rel="external" target="_blank">#144</a></li>
|
||
</ul>
|
||
<h3 id="fixes-38">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid errors when using invalid rapi-doc fragment ids <a href="https://github.com/McShelby/hugo-theme-relearn/issues/465" rel="external" target="_blank">#465</a></li>
|
||
<li>[<strong>bug</strong>] search: fix oddities in keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/463" rel="external" target="_blank">#463</a></li>
|
||
<li>[<strong>bug</strong>] badge: fix text color for IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/462" rel="external" target="_blank">#462</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: rerender graph if search term is present and variant is switched <a href="https://github.com/McShelby/hugo-theme-relearn/issues/460" rel="external" target="_blank">#460</a></li>
|
||
<li>[<strong>bug</strong>] tags: show tag on pages when tag has space <a href="https://github.com/McShelby/hugo-theme-relearn/issues/459" rel="external" target="_blank">#459</a></li>
|
||
<li>[<strong>bug</strong>] edit: remove double slash on root page link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/450" rel="external" target="_blank">#450</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-7">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add moving version tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/453" rel="external" target="_blank">#453</a></li>
|
||
<li>[<strong>task</strong>][<strong>change</strong>] theme: remove jQuery <a href="https://github.com/McShelby/hugo-theme-relearn/issues/452" rel="external" target="_blank">#452</a></li>
|
||
<li>[<strong>task</strong>] build: check for release notes before release <a href="https://github.com/McShelby/hugo-theme-relearn/issues/448" rel="external" target="_blank">#448</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5102-2023-01-25">5.10.2 (2023-01-25)</h2>
|
||
<h3 id="fixes-39">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumb for huge installations <a href="https://github.com/McShelby/hugo-theme-relearn/issues/446" rel="external" target="_blank">#446</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5101-2023-01-25">5.10.1 (2023-01-25)</h2>
|
||
<h3 id="fixes-40">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix image links with relative path <a href="https://github.com/McShelby/hugo-theme-relearn/issues/444" rel="external" target="_blank">#444</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100-2023-01-25">5.10.0 (2023-01-25)</h2>
|
||
<h3 id="enhancements-29">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shortcodes: support for accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/440" rel="external" target="_blank">#440</a></li>
|
||
<li>[<strong>feature</strong>] shortcodes: add color parameter where applicable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/438" rel="external" target="_blank">#438</a></li>
|
||
<li>[<strong>feature</strong>] theme: announce translations as alternate links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/422" rel="external" target="_blank">#422</a></li>
|
||
</ul>
|
||
<h3 id="fixes-41">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumbs for deeply nested sections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/442" rel="external" target="_blank">#442</a></li>
|
||
<li>[<strong>bug</strong>] theme: improve whitespacing in tables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/441" rel="external" target="_blank">#441</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="594-2023-01-23">5.9.4 (2023-01-23)</h2>
|
||
<h3 id="fixes-42">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix search icon and text color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/437" rel="external" target="_blank">#437</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="593-2023-01-22">5.9.3 (2023-01-22)</h2>
|
||
<h3 id="fixes-43">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix left/right navigation for horizontal scrolling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/435" rel="external" target="_blank">#435</a></li>
|
||
<li>[<strong>bug</strong>][<strong>breaking</strong>] theme: allow pages on top level <a href="https://github.com/McShelby/hugo-theme-relearn/issues/434" rel="external" target="_blank">#434</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-8">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: switch to wildcard version of actions <a href="https://github.com/McShelby/hugo-theme-relearn/issues/428" rel="external" target="_blank">#428</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="592-2022-12-30">5.9.2 (2022-12-30)</h2>
|
||
<h3 id="fixes-44">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: apply dependency scripts for Hindi and Japanese <a href="https://github.com/McShelby/hugo-theme-relearn/issues/427" rel="external" target="_blank">#427</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="591-2022-12-23">5.9.1 (2022-12-23)</h2>
|
||
<h3 id="enhancements-30">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: make external link target configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/426" rel="external" target="_blank">#426</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="590-2022-12-23">5.9.0 (2022-12-23)</h2>
|
||
<h3 id="enhancements-31">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: open external links in separate tab <a href="https://github.com/McShelby/hugo-theme-relearn/issues/419" rel="external" target="_blank">#419</a></li>
|
||
<li>[<strong>feature</strong>] theme: make it a Hugo module <a href="https://github.com/McShelby/hugo-theme-relearn/issues/417" rel="external" target="_blank">#417</a></li>
|
||
</ul>
|
||
<h3 id="fixes-45">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] attachments: fix incorrect links for defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/425" rel="external" target="_blank">#425</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="581-2022-12-11">5.8.1 (2022-12-11)</h2>
|
||
<h3 id="fixes-46">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix alias for home page if defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/414" rel="external" target="_blank">#414</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580-2022-12-08">5.8.0 (2022-12-08)</h2>
|
||
<h3 id="enhancements-32">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] icon: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/412" rel="external" target="_blank">#412</a></li>
|
||
<li>[<strong>feature</strong>] theme: style and document markdown extensions <a href="https://github.com/McShelby/hugo-theme-relearn/issues/411" rel="external" target="_blank">#411</a></li>
|
||
<li>[<strong>feature</strong>] badge: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/410" rel="external" target="_blank">#410</a></li>
|
||
<li>[<strong>feature</strong>] theme: add accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/409" rel="external" target="_blank">#409</a></li>
|
||
</ul>
|
||
<h3 id="fixes-47">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix spacing for tag flyout in FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/413" rel="external" target="_blank">#413</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570-2022-11-29">5.7.0 (2022-11-29)</h2>
|
||
<h3 id="enhancements-33">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] button: refactor for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/372" rel="external" target="_blank">#372</a></li>
|
||
</ul>
|
||
<h3 id="fixes-48">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: don’t freeze browser on long search terms <a href="https://github.com/McShelby/hugo-theme-relearn/issues/408" rel="external" target="_blank">#408</a></li>
|
||
<li>[<strong>bug</strong>] search: fix searchbox placeholder color in FF and IE <a href="https://github.com/McShelby/hugo-theme-relearn/issues/405" rel="external" target="_blank">#405</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] i18n: rename Korean translation from country to lang code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/404" rel="external" target="_blank">#404</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-9">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] search: update lunr languages to 1.10.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/403" rel="external" target="_blank">#403</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="566-2022-11-23">5.6.6 (2022-11-23)</h2>
|
||
<h3 id="enhancements-34">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] search: make build and js forgiving against config errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/400" rel="external" target="_blank">#400</a></li>
|
||
</ul>
|
||
<h3 id="fixes-49">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: minor color adjustments <a href="https://github.com/McShelby/hugo-theme-relearn/issues/402" rel="external" target="_blank">#402</a></li>
|
||
<li>[<strong>bug</strong>] variant: fix generator for use of neon <a href="https://github.com/McShelby/hugo-theme-relearn/issues/401" rel="external" target="_blank">#401</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="565-2022-11-19">5.6.5 (2022-11-19)</h2>
|
||
<h3 id="fixes-50">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: relax usage of background color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/399" rel="external" target="_blank">#399</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="564-2022-11-19">5.6.4 (2022-11-19)</h2>
|
||
<h3 id="fixes-51">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make alias pages usable by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/398" rel="external" target="_blank">#398</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="563-2022-11-19">5.6.3 (2022-11-19)</h2>
|
||
<h3 id="fixes-52">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: be compatible with Hugo >= 0.95.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/397" rel="external" target="_blank">#397</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="562-2022-11-19">5.6.2 (2022-11-19)</h2>
|
||
<h3 id="fixes-53">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: build breaks sites without “output” section in config <a href="https://github.com/McShelby/hugo-theme-relearn/issues/396" rel="external" target="_blank">#396</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="561-2022-11-19">5.6.1 (2022-11-19)</h2>
|
||
<h3 id="fixes-54">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix image distortion <a href="https://github.com/McShelby/hugo-theme-relearn/issues/395" rel="external" target="_blank">#395</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560-2022-11-18">5.6.0 (2022-11-18)</h2>
|
||
<h3 id="enhancements-35">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: improve keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/390" rel="external" target="_blank">#390</a></li>
|
||
<li>[<strong>feature</strong>] search: improve keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/387" rel="external" target="_blank">#387</a></li>
|
||
<li>[<strong>feature</strong>] search: add dedicated search page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/386" rel="external" target="_blank">#386</a></li>
|
||
<li>[<strong>feature</strong>] theme: make creation of generator meta tag configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/383" rel="external" target="_blank">#383</a></li>
|
||
<li>[<strong>feature</strong>] theme: increase build performance <a href="https://github.com/McShelby/hugo-theme-relearn/issues/380" rel="external" target="_blank">#380</a></li>
|
||
</ul>
|
||
<h3 id="fixes-55">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: avoid leading whitespace <a href="https://github.com/McShelby/hugo-theme-relearn/issues/394" rel="external" target="_blank">#394</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix build errors when referencing SVGs in markdown <a href="https://github.com/McShelby/hugo-theme-relearn/issues/393" rel="external" target="_blank">#393</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid neon to leak into IE11 fallback <a href="https://github.com/McShelby/hugo-theme-relearn/issues/392" rel="external" target="_blank">#392</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix urls for file:// protocol in sitemap <a href="https://github.com/McShelby/hugo-theme-relearn/issues/385" rel="external" target="_blank">#385</a></li>
|
||
<li>[<strong>bug</strong>] theme: add id to h1 elements <a href="https://github.com/McShelby/hugo-theme-relearn/issues/384" rel="external" target="_blank">#384</a></li>
|
||
<li>[<strong>bug</strong>] rss: fix display of hidden subpages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/382" rel="external" target="_blank">#382</a></li>
|
||
<li>[<strong>bug</strong>] nav: fix key navigation when pressing wrong modifiers <a href="https://github.com/McShelby/hugo-theme-relearn/issues/379" rel="external" target="_blank">#379</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-10">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to version 9.2.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/391" rel="external" target="_blank">#391</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="553-2022-11-10">5.5.3 (2022-11-10)</h2>
|
||
<h3 id="fixes-56">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: fix non-latin tag display on pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/378" rel="external" target="_blank">#378</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="552-2022-11-08">5.5.2 (2022-11-08)</h2>
|
||
<h3 id="fixes-57">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix typo in 404.html <a href="https://github.com/McShelby/hugo-theme-relearn/issues/376" rel="external" target="_blank">#376</a></li>
|
||
<li>[<strong>bug</strong>] theme: allow menu items and children to be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/375" rel="external" target="_blank">#375</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="551-2022-11-07">5.5.1 (2022-11-07)</h2>
|
||
<h3 id="fixes-58">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix overflowing issue with anchors and tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/364" rel="external" target="_blank">#364</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550-2022-11-06">5.5.0 (2022-11-06)</h2>
|
||
<h3 id="enhancements-36">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimize page load for images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/304" rel="external" target="_blank">#304</a></li>
|
||
</ul>
|
||
<h3 id="fixes-59">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix context in render hooks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/373" rel="external" target="_blank">#373</a></li>
|
||
<li>[<strong>bug</strong>] print: make canonical URL absolute <a href="https://github.com/McShelby/hugo-theme-relearn/issues/371" rel="external" target="_blank">#371</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="543-2022-11-05">5.4.3 (2022-11-05)</h2>
|
||
<h3 id="enhancements-37">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] history: refactor for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/341" rel="external" target="_blank">#341</a></li>
|
||
</ul>
|
||
<h3 id="fixes-60">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix multilang links when site served from subdirectory <a href="https://github.com/McShelby/hugo-theme-relearn/issues/370" rel="external" target="_blank">#370</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="542-2022-11-05">5.4.2 (2022-11-05)</h2>
|
||
<h3 id="maintenance-11">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: change set-output to env vars <a href="https://github.com/McShelby/hugo-theme-relearn/issues/348" rel="external" target="_blank">#348</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="541-2022-11-05">5.4.1 (2022-11-05)</h2>
|
||
<h3 id="fixes-61">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: fix Gantt chart width <a href="https://github.com/McShelby/hugo-theme-relearn/issues/365" rel="external" target="_blank">#365</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="540-2022-11-01">5.4.0 (2022-11-01)</h2>
|
||
<h3 id="enhancements-38">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] math: allow passing of parameters with codefence syntax <a href="https://github.com/McShelby/hugo-theme-relearn/issues/363" rel="external" target="_blank">#363</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Finnish translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/361" rel="external" target="_blank">#361</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: allow passing of parameters with codefence syntax <a href="https://github.com/McShelby/hugo-theme-relearn/issues/360" rel="external" target="_blank">#360</a></li>
|
||
<li>[<strong>feature</strong>] i18n: support RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/357" rel="external" target="_blank">#357</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] button: add option for target <a href="https://github.com/McShelby/hugo-theme-relearn/issues/351" rel="external" target="_blank">#351</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: allow to be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/349" rel="external" target="_blank">#349</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="533-2022-10-09">5.3.3 (2022-10-09)</h2>
|
||
<h3 id="fixes-62">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] archetypes: fix frontmatter on home.md template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/346" rel="external" target="_blank">#346</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="532-2022-10-08">5.3.2 (2022-10-08)</h2>
|
||
<h3 id="fixes-63">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: change defunct keyboard shortcuts <a href="https://github.com/McShelby/hugo-theme-relearn/issues/344" rel="external" target="_blank">#344</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="531-2022-10-08">5.3.1 (2022-10-08)</h2>
|
||
<h3 id="enhancements-39">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: update Spanish translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/343" rel="external" target="_blank">#343</a></li>
|
||
<li>[<strong>feature</strong>] theme: option to align images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/327" rel="external" target="_blank">#327</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530-2022-10-07">5.3.0 (2022-10-07)</h2>
|
||
<h3 id="enhancements-40">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] expander: improve whitespace between label and content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/338" rel="external" target="_blank">#338</a></li>
|
||
<li>[<strong>feature</strong>] swagger: improve print version <a href="https://github.com/McShelby/hugo-theme-relearn/issues/333" rel="external" target="_blank">#333</a></li>
|
||
</ul>
|
||
<h3 id="fixes-64">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix links of subsections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/340" rel="external" target="_blank">#340</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove W3C validator errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/337" rel="external" target="_blank">#337</a></li>
|
||
<li>[<strong>bug</strong>] children: remove unused <code>page</code> parameter from docs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/336" rel="external" target="_blank">#336</a></li>
|
||
<li>[<strong>bug</strong>] print: remove menu placeholder in Firefox <a href="https://github.com/McShelby/hugo-theme-relearn/issues/335" rel="external" target="_blank">#335</a></li>
|
||
<li>[<strong>bug</strong>] swagger: fix download button overflow <a href="https://github.com/McShelby/hugo-theme-relearn/issues/334" rel="external" target="_blank">#334</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] a11y: remove WCAG errors where applicable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/307" rel="external" target="_blank">#307</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="524-2022-10-02">5.2.4 (2022-10-02)</h2>
|
||
<h3 id="fixes-65">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove HTML5 validator errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/329" rel="external" target="_blank">#329</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="523-2022-09-12">5.2.3 (2022-09-12)</h2>
|
||
<h3 id="fixes-66">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: chapter pages overwrite font-size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/328" rel="external" target="_blank">#328</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="522-2022-08-23">5.2.2 (2022-08-23)</h2>
|
||
<h3 id="fixes-67">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix urls for uglyURLs=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/322" rel="external" target="_blank">#322</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="521-2022-08-05">5.2.1 (2022-08-05)</h2>
|
||
<h3 id="enhancements-41">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: improve Japanese translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/318" rel="external" target="_blank">#318</a></li>
|
||
</ul>
|
||
<h3 id="fixes-68">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: prev/next ignores ordersectionby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/320" rel="external" target="_blank">#320</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-12">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] task: bump Hugo minimum requirement to 0.95 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/319" rel="external" target="_blank">#319</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520-2022-08-03">5.2.0 (2022-08-03)</h2>
|
||
<h3 id="enhancements-42">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: expand collapsed menus if search term is found in submenus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/312" rel="external" target="_blank">#312</a></li>
|
||
</ul>
|
||
<h3 id="fixes-69">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: switch mermaid and swagger style before print <a href="https://github.com/McShelby/hugo-theme-relearn/issues/316" rel="external" target="_blank">#316</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix chapter margins on big screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/315" rel="external" target="_blank">#315</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="512-2022-07-18">5.1.2 (2022-07-18)</h2>
|
||
<h3 id="fixes-70">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: reset mermaid theme to light <a href="https://github.com/McShelby/hugo-theme-relearn/issues/313" rel="external" target="_blank">#313</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: header is showing up in FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/311" rel="external" target="_blank">#311</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="511-2022-07-15">5.1.1 (2022-07-15)</h2>
|
||
<h3 id="fixes-71">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: don’t count tags if page is hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/310" rel="external" target="_blank">#310</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510-2022-07-15">5.1.0 (2022-07-15)</h2>
|
||
<h3 id="enhancements-43">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] print: make print url deterministic <a href="https://github.com/McShelby/hugo-theme-relearn/issues/309" rel="external" target="_blank">#309</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow overriding partials for output formats <a href="https://github.com/McShelby/hugo-theme-relearn/issues/308" rel="external" target="_blank">#308</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="503-2022-07-07">5.0.3 (2022-07-07)</h2>
|
||
<h3 id="fixes-72">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] ie11: no styles after rework of archetypes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/306" rel="external" target="_blank">#306</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="502-2022-07-07">5.0.2 (2022-07-07)</h2>
|
||
<h3 id="fixes-73">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: load CSS if JS is disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/305" rel="external" target="_blank">#305</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="501-2022-07-07">5.0.1 (2022-07-07)</h2>
|
||
<h3 id="enhancements-44">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: optimize loading of js and css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/303" rel="external" target="_blank">#303</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500-2022-07-05">5.0.0 (2022-07-05)</h2>
|
||
<h3 id="enhancements-45">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] archetypes: modularize rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/300" rel="external" target="_blank">#300</a></li>
|
||
<li>[<strong>feature</strong>] history: don’t reload page when history gets cleared <a href="https://github.com/McShelby/hugo-theme-relearn/issues/299" rel="external" target="_blank">#299</a></li>
|
||
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/296" rel="external" target="_blank">#296</a></li>
|
||
<li>[<strong>feature</strong>] theme: align content with topbar icon limits <a href="https://github.com/McShelby/hugo-theme-relearn/issues/290" rel="external" target="_blank">#290</a></li>
|
||
<li>[<strong>feature</strong>] button: allow for empty href <a href="https://github.com/McShelby/hugo-theme-relearn/issues/288" rel="external" target="_blank">#288</a></li>
|
||
<li>[<strong>feature</strong>] i18n: make Simplified Chinese the standard language for the <code>zn</code> code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/287" rel="external" target="_blank">#287</a></li>
|
||
<li>[<strong>feature</strong>] clipboard: move head styles to stylesheet <a href="https://github.com/McShelby/hugo-theme-relearn/issues/286" rel="external" target="_blank">#286</a></li>
|
||
<li>[<strong>feature</strong>] math: add mathjax rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/235" rel="external" target="_blank">#235</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow for page heading modification <a href="https://github.com/McShelby/hugo-theme-relearn/issues/139" rel="external" target="_blank">#139</a></li>
|
||
</ul>
|
||
<h3 id="fixes-74">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] favicon: fix URL if site resides in subfolder <a href="https://github.com/McShelby/hugo-theme-relearn/issues/302" rel="external" target="_blank">#302</a></li>
|
||
<li>[<strong>bug</strong>] code: show copy-to-clipboard marker for blocklevel code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/298" rel="external" target="_blank">#298</a></li>
|
||
<li>[<strong>bug</strong>] menu: make active expander visible on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/297" rel="external" target="_blank">#297</a></li>
|
||
<li>[<strong>bug</strong>] print: disable arrow navigation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/294" rel="external" target="_blank">#294</a></li>
|
||
<li>[<strong>bug</strong>] print: add missing page break after index or section <a href="https://github.com/McShelby/hugo-theme-relearn/issues/292" rel="external" target="_blank">#292</a></li>
|
||
<li>[<strong>bug</strong>] theme: use more space on wide screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/291" rel="external" target="_blank">#291</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix size of chapter heading <a href="https://github.com/McShelby/hugo-theme-relearn/issues/289" rel="external" target="_blank">#289</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-13">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update RapiDoc 9.3.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/301" rel="external" target="_blank">#301</a></li>
|
||
<li>[<strong>task</strong>] chore: update Mermaid 9.1.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/293" rel="external" target="_blank">#293</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="425-2022-06-23">4.2.5 (2022-06-23)</h2>
|
||
<h3 id="fixes-75">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: javascript code does not load in documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/285" rel="external" target="_blank">#285</a></li>
|
||
<li>[<strong>bug</strong>] children: descriptions not working <a href="https://github.com/McShelby/hugo-theme-relearn/issues/284" rel="external" target="_blank">#284</a></li>
|
||
<li>[<strong>bug</strong>] print: fix empty page for shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/283" rel="external" target="_blank">#283</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="424-2022-06-23">4.2.4 (2022-06-23)</h2>
|
||
<h3 id="fixes-76">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix url for logo and home button <a href="https://github.com/McShelby/hugo-theme-relearn/issues/282" rel="external" target="_blank">#282</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="423-2022-06-23">4.2.3 (2022-06-23)</h2>
|
||
<h3 id="fixes-77">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>breaking</strong>] include: second parameter is ignored <a href="https://github.com/McShelby/hugo-theme-relearn/issues/281" rel="external" target="_blank">#281</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="422-2022-06-23">4.2.2 (2022-06-23)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="421-2022-06-23">4.2.1 (2022-06-23)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="420-2022-06-23">4.2.0 (2022-06-23)</h2>
|
||
<h3 id="enhancements-46">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: don’t change tab selection if panel does not contain item <a href="https://github.com/McShelby/hugo-theme-relearn/issues/279" rel="external" target="_blank">#279</a></li>
|
||
<li>[<strong>feature</strong>] shortcodes: convert to partials <a href="https://github.com/McShelby/hugo-theme-relearn/issues/277" rel="external" target="_blank">#277</a></li>
|
||
</ul>
|
||
<h3 id="fixes-78">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid builtin syntax-highlightning <a href="https://github.com/McShelby/hugo-theme-relearn/issues/280" rel="external" target="_blank">#280</a></li>
|
||
<li>[<strong>bug</strong>] search: fix console message for missing lunr translations <a href="https://github.com/McShelby/hugo-theme-relearn/issues/278" rel="external" target="_blank">#278</a></li>
|
||
<li>[<strong>bug</strong>] tabs: fix wrapping when having many tabs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/272" rel="external" target="_blank">#272</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="411-2022-06-18">4.1.1 (2022-06-18)</h2>
|
||
<h3 id="fixes-79">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] notice: fix layout when content starts with heading <a href="https://github.com/McShelby/hugo-theme-relearn/issues/275" rel="external" target="_blank">#275</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410-2022-06-12">4.1.0 (2022-06-12)</h2>
|
||
<h3 id="enhancements-47">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: support multilang content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/271" rel="external" target="_blank">#271</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="405-2022-06-12">4.0.5 (2022-06-12)</h2>
|
||
<h3 id="fixes-80">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: Vietnamese language with wrong lang code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/270" rel="external" target="_blank">#270</a></li>
|
||
<li>[<strong>bug</strong>] i18n: fix search for non western languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/269" rel="external" target="_blank">#269</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="404-2022-06-07">4.0.4 (2022-06-07)</h2>
|
||
<h3 id="enhancements-48">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve keyboard navigation for scrolling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/268" rel="external" target="_blank">#268</a></li>
|
||
</ul>
|
||
<h3 id="fixes-81">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: adjust font-size for method buttons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/267" rel="external" target="_blank">#267</a></li>
|
||
<li>[<strong>bug</strong>] menu: hide expander when only hidden subpages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/264" rel="external" target="_blank">#264</a></li>
|
||
<li>[<strong>bug</strong>] theme: make compatible with Hugo 0.100.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/263" rel="external" target="_blank">#263</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-14">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] swagger: update rapidoc to 9.3.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/266" rel="external" target="_blank">#266</a></li>
|
||
<li>[<strong>task</strong>] mermaid: update to 9.1.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/265" rel="external" target="_blank">#265</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="403-2022-06-05">4.0.3 (2022-06-05)</h2>
|
||
<h3 id="enhancements-49">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: add scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/262" rel="external" target="_blank">#262</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="402-2022-06-05">4.0.2 (2022-06-05)</h2>
|
||
<h3 id="fixes-82">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: let browser scroll page on CTRL+f <a href="https://github.com/McShelby/hugo-theme-relearn/issues/242" rel="external" target="_blank">#242</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="401-2022-06-05">4.0.1 (2022-06-05)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="400-2022-06-05">4.0.0 (2022-06-05)</h2>
|
||
<h3 id="enhancements-50">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shortcodes: add named parameter if missing <a href="https://github.com/McShelby/hugo-theme-relearn/issues/260" rel="external" target="_blank">#260</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: remove –MAIN-ANCHOR-color from stylesheet <a href="https://github.com/McShelby/hugo-theme-relearn/issues/256" rel="external" target="_blank">#256</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Italian translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/254" rel="external" target="_blank">#254</a></li>
|
||
<li>[<strong>feature</strong>] attachments: support for brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/252" rel="external" target="_blank">#252</a></li>
|
||
<li>[<strong>feature</strong>] notice: support for brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/251" rel="external" target="_blank">#251</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] config: remove custom_css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/248" rel="external" target="_blank">#248</a></li>
|
||
<li>[<strong>feature</strong>] theme: use proper file extension for page-meta.go <a href="https://github.com/McShelby/hugo-theme-relearn/issues/246" rel="external" target="_blank">#246</a></li>
|
||
<li>[<strong>feature</strong>] variant: add support for brand color variables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/239" rel="external" target="_blank">#239</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Polish translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/237" rel="external" target="_blank">#237</a></li>
|
||
</ul>
|
||
<h3 id="fixes-83">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shortcodes: accept boolean parameters if given as string <a href="https://github.com/McShelby/hugo-theme-relearn/issues/261" rel="external" target="_blank">#261</a></li>
|
||
<li>[<strong>bug</strong>] print: adjust button and tab size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/259" rel="external" target="_blank">#259</a></li>
|
||
<li>[<strong>bug</strong>] print: show Mermaid if requested in frontmatter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/255" rel="external" target="_blank">#255</a></li>
|
||
<li>[<strong>bug</strong>] theme: adjust thin scrollbar slider <a href="https://github.com/McShelby/hugo-theme-relearn/issues/244" rel="external" target="_blank">#244</a></li>
|
||
<li>[<strong>bug</strong>] mobile: fix broken scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/243" rel="external" target="_blank">#243</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix display of tooltip for heading anchor <a href="https://github.com/McShelby/hugo-theme-relearn/issues/241" rel="external" target="_blank">#241</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="341-2022-04-03">3.4.1 (2022-04-03)</h2>
|
||
<h3 id="fixes-84">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix IE11 incompatibilities <a href="https://github.com/McShelby/hugo-theme-relearn/issues/234" rel="external" target="_blank">#234</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
||
<h3 id="enhancements-51">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/233" rel="external" target="_blank">#233</a></li>
|
||
<li>[<strong>feature</strong>] menu: expand/collapse menu items without navigation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/231" rel="external" target="_blank">#231</a></li>
|
||
<li>[<strong>feature</strong>] print: add option to print whole chapter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/230" rel="external" target="_blank">#230</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: apply user supplied content footer below content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/229" rel="external" target="_blank">#229</a></li>
|
||
</ul>
|
||
<h3 id="fixes-85">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: scroll to heading on initial load <a href="https://github.com/McShelby/hugo-theme-relearn/issues/232" rel="external" target="_blank">#232</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
||
<h3 id="enhancements-52">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add CSS font variables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/227" rel="external" target="_blank">#227</a></li>
|
||
<li>[<strong>feature</strong>] swagger: add support for oas/swagger documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/226" rel="external" target="_blank">#226</a></li>
|
||
</ul>
|
||
<h3 id="fixes-86">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: make variant switch work on slow networks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/228" rel="external" target="_blank">#228</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="321-2022-03-25">3.2.1 (2022-03-25)</h2>
|
||
<h3 id="fixes-87">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix minor inconsistencies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/225" rel="external" target="_blank">#225</a></li>
|
||
<li>[<strong>bug</strong>] print: show more than just the title page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/224" rel="external" target="_blank">#224</a></li>
|
||
<li>[<strong>bug</strong>] theme: align content scrollbar to the right on big screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/223" rel="external" target="_blank">#223</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
||
<h3 id="enhancements-53">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differing themes for color variant switch <a href="https://github.com/McShelby/hugo-theme-relearn/issues/219" rel="external" target="_blank">#219</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: load javascript on demand <a href="https://github.com/McShelby/hugo-theme-relearn/issues/218" rel="external" target="_blank">#218</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-15">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to 8.14.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/220" rel="external" target="_blank">#220</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="311-2022-03-16">3.1.1 (2022-03-16)</h2>
|
||
<h3 id="enhancements-54">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Korean translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/217" rel="external" target="_blank">#217</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
||
<h3 id="enhancements-55">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: add icon parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/212" rel="external" target="_blank">#212</a></li>
|
||
<li>[<strong>feature</strong>] mobile: remove breadcrumb ellipsis <a href="https://github.com/McShelby/hugo-theme-relearn/issues/211" rel="external" target="_blank">#211</a></li>
|
||
</ul>
|
||
<h3 id="fixes-88">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make storage of multiple Hugo sites on same server distinct <a href="https://github.com/McShelby/hugo-theme-relearn/issues/214" rel="external" target="_blank">#214</a></li>
|
||
<li>[<strong>bug</strong>] variant: switch breadcrumb color in Chrome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/213" rel="external" target="_blank">#213</a></li>
|
||
<li>[<strong>bug</strong>] mobile: improve behavior of sidebar menu <a href="https://github.com/McShelby/hugo-theme-relearn/issues/210" rel="external" target="_blank">#210</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="304-2022-02-24">3.0.4 (2022-02-24)</h2>
|
||
<h3 id="enhancements-56">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve font loading <a href="https://github.com/McShelby/hugo-theme-relearn/issues/201" rel="external" target="_blank">#201</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] variant: fix inconsistent color variable naming <a href="https://github.com/McShelby/hugo-theme-relearn/issues/200" rel="external" target="_blank">#200</a></li>
|
||
</ul>
|
||
<h3 id="fixes-89">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix occasional fail when resetting generator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/208" rel="external" target="_blank">#208</a></li>
|
||
<li>[<strong>bug</strong>] docs: don’t move header on logo hover in IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/207" rel="external" target="_blank">#207</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid flash of menu header when non default variant is active <a href="https://github.com/McShelby/hugo-theme-relearn/issues/206" rel="external" target="_blank">#206</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix wrong HTML closing tag order in chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/205" rel="external" target="_blank">#205</a></li>
|
||
<li>[<strong>bug</strong>] theme: adjust breadcrumb and title for empty home page titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/202" rel="external" target="_blank">#202</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="303-2022-02-23">3.0.3 (2022-02-23)</h2>
|
||
<h3 id="enhancements-57">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: show tag count in taxonomy list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/195" rel="external" target="_blank">#195</a></li>
|
||
</ul>
|
||
<h3 id="fixes-90">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove Hugo build warning if page is not file based <a href="https://github.com/McShelby/hugo-theme-relearn/issues/197" rel="external" target="_blank">#197</a></li>
|
||
<li>[<strong>bug</strong>] tags: adhere to titleSeparator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/196" rel="external" target="_blank">#196</a></li>
|
||
<li>[<strong>bug</strong>] theme: hide footer divider and variant selector in IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/194" rel="external" target="_blank">#194</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="302-2022-02-23">3.0.2 (2022-02-23)</h2>
|
||
<h3 id="enhancements-58">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: sort by name <a href="https://github.com/McShelby/hugo-theme-relearn/issues/193" rel="external" target="_blank">#193</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="301-2022-02-23">3.0.1 (2022-02-23)</h2>
|
||
<h3 id="enhancements-59">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] children: set containerstyle automatically according to style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/192" rel="external" target="_blank">#192</a></li>
|
||
</ul>
|
||
<h3 id="fixes-91">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: revert fontawsome to version 5 for IE11 compat <a href="https://github.com/McShelby/hugo-theme-relearn/issues/191" rel="external" target="_blank">#191</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
||
<h3 id="enhancements-60">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: build a variant generator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/188" rel="external" target="_blank">#188</a></li>
|
||
<li>[<strong>feature</strong>] nav: only show toc if the page has headings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/182" rel="external" target="_blank">#182</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: change default colors to Relearn defaults <a href="https://github.com/McShelby/hugo-theme-relearn/issues/181" rel="external" target="_blank">#181</a></li>
|
||
<li>[<strong>feature</strong>] variant: add a variant selector <a href="https://github.com/McShelby/hugo-theme-relearn/issues/178" rel="external" target="_blank">#178</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] menu: rework footer UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/177" rel="external" target="_blank">#177</a></li>
|
||
<li>[<strong>feature</strong>] theme: support for dark mode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/175" rel="external" target="_blank">#175</a></li>
|
||
<li>[<strong>feature</strong>] docs: use light syntax highlightning theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/174" rel="external" target="_blank">#174</a></li>
|
||
<li>[<strong>feature</strong>] notice: tweak dull colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/173" rel="external" target="_blank">#173</a></li>
|
||
<li>[<strong>feature</strong>] theme: rework header UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/151" rel="external" target="_blank">#151</a></li>
|
||
</ul>
|
||
<h3 id="fixes-92">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: remove additional X in filled out search box in IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/190" rel="external" target="_blank">#190</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: localize tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/186" rel="external" target="_blank">#186</a></li>
|
||
<li>[<strong>bug</strong>] print: hide sidebar on Mac <a href="https://github.com/McShelby/hugo-theme-relearn/issues/183" rel="external" target="_blank">#183</a></li>
|
||
<li>[<strong>bug</strong>] menu: fix scrollbar height <a href="https://github.com/McShelby/hugo-theme-relearn/issues/180" rel="external" target="_blank">#180</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] search: fix color change for icons on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/176" rel="external" target="_blank">#176</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="296-2022-02-07">2.9.6 (2022-02-07)</h2>
|
||
<h3 id="fixes-93">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: remove debug output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/171" rel="external" target="_blank">#171</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="295-2022-02-07">2.9.5 (2022-02-07)</h2>
|
||
<h3 id="fixes-94">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: let arrow navigation respect ordersectionsby configuration <a href="https://github.com/McShelby/hugo-theme-relearn/issues/170" rel="external" target="_blank">#170</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="294-2022-02-06">2.9.4 (2022-02-06)</h2>
|
||
<h3 id="fixes-95">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] exampleSite: fix links in official documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/168" rel="external" target="_blank">#168</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="293-2022-02-06">2.9.3 (2022-02-06)</h2>
|
||
<h3 id="fixes-96">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: invalid URL when the shortcut is an internal link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/163" rel="external" target="_blank">#163</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="292-2021-11-26">2.9.2 (2021-11-26)</h2>
|
||
<h3 id="enhancements-61">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add theme version info to head <a href="https://github.com/McShelby/hugo-theme-relearn/issues/158" rel="external" target="_blank">#158</a></li>
|
||
</ul>
|
||
<h3 id="fixes-97">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix selection of *.ico files as favicons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/160" rel="external" target="_blank">#160</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="291-2021-11-22">2.9.1 (2021-11-22)</h2>
|
||
<h3 id="fixes-98">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix significantly low performance for collecting of meta info <a href="https://github.com/McShelby/hugo-theme-relearn/issues/157" rel="external" target="_blank">#157</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
||
<h3 id="fixes-99">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>breaking</strong>] relref: fix inconsistent behavior <a href="https://github.com/McShelby/hugo-theme-relearn/issues/156" rel="external" target="_blank">#156</a></li>
|
||
<li>[<strong>bug</strong>] search: make dropdown stick to search field when scrolling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/155" rel="external" target="_blank">#155</a></li>
|
||
<li>[<strong>bug</strong>] menu: align long text properly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/154" rel="external" target="_blank">#154</a></li>
|
||
<li>[<strong>bug</strong>] copyToClipBoard: add missing right border for inline code if <code>disableInlineCopyToClipBoard=true</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/153" rel="external" target="_blank">#153</a></li>
|
||
<li>[<strong>bug</strong>] menu: show hidden sibling pages reliably <a href="https://github.com/McShelby/hugo-theme-relearn/issues/152" rel="external" target="_blank">#152</a></li>
|
||
<li>[<strong>bug</strong>] menu: bring active item in sight for large menus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/149" rel="external" target="_blank">#149</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="283-2021-11-09">2.8.3 (2021-11-09)</h2>
|
||
<h3 id="fixes-100">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: let zoom reset to initial size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/145" rel="external" target="_blank">#145</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: remove whitespace from big graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/143" rel="external" target="_blank">#143</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="282-2021-11-08">2.8.2 (2021-11-08)</h2>
|
||
<h3 id="fixes-101">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: always load javascript to avoid break if code fences are used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/142" rel="external" target="_blank">#142</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="281-2021-11-04">2.8.1 (2021-11-04)</h2>
|
||
<h3 id="fixes-102">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: don’t break JS in multilang setup if search is disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/140" rel="external" target="_blank">#140</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
||
<h3 id="enhancements-62">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: make disableTOC globally available via config.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/133" rel="external" target="_blank">#133</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: only load javascript if necessary <a href="https://github.com/McShelby/hugo-theme-relearn/issues/95" rel="external" target="_blank">#95</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <a href="https://github.com/McShelby/hugo-theme-relearn/issues/83" rel="external" target="_blank">#83</a></li>
|
||
<li>[<strong>feature</strong>] theme: make favicon configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/2" rel="external" target="_blank">#2</a></li>
|
||
</ul>
|
||
<h3 id="fixes-103">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid is actually mermaid <a href="https://github.com/McShelby/hugo-theme-relearn/issues/136" rel="external" target="_blank">#136</a></li>
|
||
<li>[<strong>bug</strong>] menu: remove usage of Hugos UniqueID <a href="https://github.com/McShelby/hugo-theme-relearn/issues/131" rel="external" target="_blank">#131</a></li>
|
||
<li>[<strong>bug</strong>] theme: reduce margin for children shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/130" rel="external" target="_blank">#130</a></li>
|
||
<li>[<strong>bug</strong>] theme: left-align h3 in chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/129" rel="external" target="_blank">#129</a></li>
|
||
<li>[<strong>bug</strong>] theme: align copy link to clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/128" rel="external" target="_blank">#128</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
||
<h3 id="enhancements-63">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: support custom titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/124" rel="external" target="_blank">#124</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
||
<h3 id="fixes-104">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: generate correct links if theme served from subdirectory <a href="https://github.com/McShelby/hugo-theme-relearn/issues/120" rel="external" target="_blank">#120</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="251-2021-10-12">2.5.1 (2021-10-12)</h2>
|
||
<h3 id="fixes-105">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS for malicious image URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/117" rel="external" target="_blank">#117</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
||
<h3 id="enhancements-64">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] syntax highlight: provide default colors for unknown languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/113" rel="external" target="_blank">#113</a></li>
|
||
</ul>
|
||
<h3 id="fixes-106">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS for malicious URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/114" rel="external" target="_blank">#114</a></li>
|
||
<li>[<strong>bug</strong>] menu: write correct local shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/112" rel="external" target="_blank">#112</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="241-2021-10-07">2.4.1 (2021-10-07)</h2>
|
||
<h3 id="fixes-107">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove runtime styles from print <a href="https://github.com/McShelby/hugo-theme-relearn/issues/111" rel="external" target="_blank">#111</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
||
<h3 id="enhancements-65">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] lang: add vietnamese translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/109" rel="external" target="_blank">#109</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: simplify stylesheet for color variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/107" rel="external" target="_blank">#107</a></li>
|
||
<li>[<strong>feature</strong>] hidden pages: remove from RSS feed, JSON, taxonomy etc <a href="https://github.com/McShelby/hugo-theme-relearn/issues/102" rel="external" target="_blank">#102</a></li>
|
||
<li>[<strong>feature</strong>] theme: announce alternative content in header <a href="https://github.com/McShelby/hugo-theme-relearn/issues/101" rel="external" target="_blank">#101</a></li>
|
||
<li>[<strong>feature</strong>] menu: frontmatter option to change sort predicate <a href="https://github.com/McShelby/hugo-theme-relearn/issues/98" rel="external" target="_blank">#98</a></li>
|
||
<li>[<strong>feature</strong>] menu: add default setting for menu expansion <a href="https://github.com/McShelby/hugo-theme-relearn/issues/97" rel="external" target="_blank">#97</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/93" rel="external" target="_blank">#93</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/92" rel="external" target="_blank">#92</a></li>
|
||
</ul>
|
||
<h3 id="fixes-108">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] include: don’t generate additional HTML if file should be displayed “as is” <a href="https://github.com/McShelby/hugo-theme-relearn/issues/110" rel="external" target="_blank">#110</a></li>
|
||
<li>[<strong>bug</strong>] attachments: fix broken links if multilang config is used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/105" rel="external" target="_blank">#105</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix sticky header to remove horizontal scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/82" rel="external" target="_blank">#82</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-16">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update fontawesome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/94" rel="external" target="_blank">#94</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="232-2021-09-20">2.3.2 (2021-09-20)</h2>
|
||
<h3 id="fixes-109">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename history pirate translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/91" rel="external" target="_blank">#91</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="231-2021-09-20">2.3.1 (2021-09-20)</h2>
|
||
<h3 id="fixes-110">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename english pirate translation to avoid crash on rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/90" rel="external" target="_blank">#90</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
||
<h3 id="fixes-111">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix usage of section element <a href="https://github.com/McShelby/hugo-theme-relearn/issues/88" rel="external" target="_blank">#88</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-17">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: ensure IE11 compatibility <a href="https://github.com/McShelby/hugo-theme-relearn/issues/89" rel="external" target="_blank">#89</a></li>
|
||
<li>[<strong>task</strong>] docs: Arrr! showcase multilang featurrre <a href="https://github.com/McShelby/hugo-theme-relearn/issues/87" rel="external" target="_blank">#87</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
||
<h3 id="enhancements-66">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] sitemap: hide hidden pages from sitemap and SEO indexing <a href="https://github.com/McShelby/hugo-theme-relearn/issues/85" rel="external" target="_blank">#85</a></li>
|
||
</ul>
|
||
<h3 id="fixes-112">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/86" rel="external" target="_blank">#86</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-18">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: switch from data-vocabulary to schema <a href="https://github.com/McShelby/hugo-theme-relearn/issues/84" rel="external" target="_blank">#84</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
||
<h3 id="enhancements-67">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] search: open expand if it contains search term <a href="https://github.com/McShelby/hugo-theme-relearn/issues/80" rel="external" target="_blank">#80</a></li>
|
||
<li>[<strong>feature</strong>] menu: scroll active item into view <a href="https://github.com/McShelby/hugo-theme-relearn/issues/79" rel="external" target="_blank">#79</a></li>
|
||
<li>[<strong>feature</strong>] search: disable search in hidden pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/76" rel="external" target="_blank">#76</a></li>
|
||
<li>[<strong>feature</strong>] search: improve readablility of index.json <a href="https://github.com/McShelby/hugo-theme-relearn/issues/75" rel="external" target="_blank">#75</a></li>
|
||
<li>[<strong>feature</strong>] search: increase performance <a href="https://github.com/McShelby/hugo-theme-relearn/issues/74" rel="external" target="_blank">#74</a></li>
|
||
<li>[<strong>feature</strong>] search: improve search context preview <a href="https://github.com/McShelby/hugo-theme-relearn/issues/73" rel="external" target="_blank">#73</a></li>
|
||
</ul>
|
||
<h3 id="fixes-113">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] search: hide non-site content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/81" rel="external" target="_blank">#81</a></li>
|
||
<li>[<strong>bug</strong>] menu: always hide hidden sub pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/77" rel="external" target="_blank">#77</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
||
<h3 id="enhancements-68">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: enhance styling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/65" rel="external" target="_blank">#65</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve readability <a href="https://github.com/McShelby/hugo-theme-relearn/issues/64" rel="external" target="_blank">#64</a></li>
|
||
<li>[<strong>feature</strong>] menu: show hidden pages if accessed directly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/60" rel="external" target="_blank">#60</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: treat pages without title as hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/59" rel="external" target="_blank">#59</a></li>
|
||
<li>[<strong>feature</strong>] search: show search results if field gains focus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/58" rel="external" target="_blank">#58</a></li>
|
||
<li>[<strong>feature</strong>] theme: add partial templates for pre/post menu entries <a href="https://github.com/McShelby/hugo-theme-relearn/issues/56" rel="external" target="_blank">#56</a></li>
|
||
<li>[<strong>feature</strong>] theme: make chapter archetype more readable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/55" rel="external" target="_blank">#55</a></li>
|
||
<li>[<strong>feature</strong>] children: add parameter for container style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/53" rel="external" target="_blank">#53</a></li>
|
||
<li>[<strong>feature</strong>] theme: make content a template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/50" rel="external" target="_blank">#50</a></li>
|
||
<li>[<strong>feature</strong>] menu: control menu expansion with alwaysopen parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/49" rel="external" target="_blank">#49</a></li>
|
||
<li>[<strong>feature</strong>] include: new shortcode to include other files <a href="https://github.com/McShelby/hugo-theme-relearn/issues/43" rel="external" target="_blank">#43</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust print styles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/35" rel="external" target="_blank">#35</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] code highlighter: switch to standard hugo highlighter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/32" rel="external" target="_blank">#32</a></li>
|
||
</ul>
|
||
<h3 id="fixes-114">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] arrow-nav: default sorting ignores ordersectionsby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/63" rel="external" target="_blank">#63</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] children: default sorting ignores ordersectionsby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/62" rel="external" target="_blank">#62</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] arrow-nav: fix broken links on (and below) hidden pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/61" rel="external" target="_blank">#61</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove superfluous singular taxonomy from taxonomy title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/46" rel="external" target="_blank">#46</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: missing –MENU-HOME-LINK-HOVER-color in documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/45" rel="external" target="_blank">#45</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix home link when base URL has some path <a href="https://github.com/McShelby/hugo-theme-relearn/issues/44" rel="external" target="_blank">#44</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-19">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] docs: include changelog in exampleSite <a href="https://github.com/McShelby/hugo-theme-relearn/issues/33" rel="external" target="_blank">#33</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
||
<h3 id="enhancements-69">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: adjust copy-to-clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/29" rel="external" target="_blank">#29</a></li>
|
||
<li>[<strong>feature</strong>] attachments: adjust style between notice boxes and attachments <a href="https://github.com/McShelby/hugo-theme-relearn/issues/28" rel="external" target="_blank">#28</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust blockquote contrast <a href="https://github.com/McShelby/hugo-theme-relearn/issues/27" rel="external" target="_blank">#27</a></li>
|
||
<li>[<strong>feature</strong>] expand: add option to open on page load <a href="https://github.com/McShelby/hugo-theme-relearn/issues/25" rel="external" target="_blank">#25</a></li>
|
||
<li>[<strong>feature</strong>] expand: rework styling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/24" rel="external" target="_blank">#24</a></li>
|
||
<li>[<strong>feature</strong>] attachments: sort output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/23" rel="external" target="_blank">#23</a></li>
|
||
<li>[<strong>feature</strong>] notice: make restyling of notice boxes more robust <a href="https://github.com/McShelby/hugo-theme-relearn/issues/20" rel="external" target="_blank">#20</a></li>
|
||
<li>[<strong>feature</strong>] notice: fix contrast issues <a href="https://github.com/McShelby/hugo-theme-relearn/issues/19" rel="external" target="_blank">#19</a></li>
|
||
<li>[<strong>feature</strong>] notice: align box colors to common standards <a href="https://github.com/McShelby/hugo-theme-relearn/issues/18" rel="external" target="_blank">#18</a></li>
|
||
<li>[<strong>feature</strong>] notice: use distinct icons for notice box type <a href="https://github.com/McShelby/hugo-theme-relearn/issues/17" rel="external" target="_blank">#17</a></li>
|
||
</ul>
|
||
<h3 id="fixes-115">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: support i18n for attachment size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/21" rel="external" target="_blank">#21</a></li>
|
||
<li>[<strong>bug</strong>] notice: support i18n for box labels <a href="https://github.com/McShelby/hugo-theme-relearn/issues/16" rel="external" target="_blank">#16</a></li>
|
||
<li>[<strong>bug</strong>] notice: support multiple blocks in one box <a href="https://github.com/McShelby/hugo-theme-relearn/issues/15" rel="external" target="_blank">#15</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-20">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] dependency: upgrade jquery to 3.6.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/30" rel="external" target="_blank">#30</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="111-2021-07-04">1.1.1 (2021-07-04)</h2>
|
||
<h3 id="maintenance-21">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: prepare for new hugo theme registration <a href="https://github.com/McShelby/hugo-theme-relearn/issues/13" rel="external" target="_blank">#13</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
||
<h3 id="enhancements-70">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: expose options in config.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/4" rel="external" target="_blank">#4</a></li>
|
||
</ul>
|
||
<h3 id="fixes-116">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: config option for CDN url not used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/12" rel="external" target="_blank">#12</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: only highlight text in HTML elements <a href="https://github.com/McShelby/hugo-theme-relearn/issues/10" rel="external" target="_blank">#10</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: support pan & zoom for graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/9" rel="external" target="_blank">#9</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <a href="https://github.com/McShelby/hugo-theme-relearn/issues/6" rel="external" target="_blank">#6</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: search term on load may bomb chart <a href="https://github.com/McShelby/hugo-theme-relearn/issues/5" rel="external" target="_blank">#5</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-22">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to 8.10.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/7" rel="external" target="_blank">#7</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="101-2021-07-01">1.0.1 (2021-07-01)</h2>
|
||
<h3 id="maintenance-23">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Prepare for hugo showcase <a href="https://github.com/McShelby/hugo-theme-relearn/issues/3" rel="external" target="_blank">#3</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
||
<h3 id="maintenance-24">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Fork project <a href="https://github.com/McShelby/hugo-theme-relearn/issues/1" rel="external" target="_blank">#1</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">Chapter 2</div>
|
||
|
||
<h1 id="content">Content</h1>
|
||
|
||
<p>Find out how to create and organize your content quickly and intuitively.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Content</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="pages-organization">Pages organization</h1>
|
||
|
||
<p>In <strong>Hugo</strong>, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.</p>
|
||
<h2 id="folders">Folders</h2>
|
||
<p>Organize your site like <a href="https://gohugo.io/content/organization/" rel="external" target="_blank">any other Hugo project</a>. Typically, you will have a <em>content</em> folder with all your pages.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">content
|
||
</span></span><span class="line"><span class="cl">├── level-one
|
||
</span></span><span class="line"><span class="cl">│ ├── level-two
|
||
</span></span><span class="line"><span class="cl">│ │ ├── level-three
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── level-four
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── _index.md <-- /level-one/level-two/level-three
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b
|
||
</span></span><span class="line"><span class="cl">│ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c
|
||
</span></span><span class="line"><span class="cl">│ │ ├── _index.md <-- /level-one/level-two
|
||
</span></span><span class="line"><span class="cl">│ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a
|
||
</span></span><span class="line"><span class="cl">│ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b
|
||
</span></span><span class="line"><span class="cl">│ │ └── page-2-c.md <-- /level-one/level-two/page-2-c
|
||
</span></span><span class="line"><span class="cl">│ ├── _index.md <-- /level-one
|
||
</span></span><span class="line"><span class="cl">│ ├── page-1-a.md <-- /level-one/page-1-a
|
||
</span></span><span class="line"><span class="cl">│ ├── page-1-b.md <-- /level-one/page-1-b
|
||
</span></span><span class="line"><span class="cl">│ └── page-1-c.md <-- /level-one/page-1-c
|
||
</span></span><span class="line"><span class="cl">├── _index.md <-- /
|
||
</span></span><span class="line"><span class="cl">└── page-top.md <-- /page-top</span></span></code></pre></div>
|
||
<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><code>_index.md</code> is required in each folder, it’s your “folder home page”</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="create-your-project">Create your project</h2>
|
||
<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 to train by following <a href="https://gohugo.io/overview/quickstart/" rel="external" target="_blank">great documentation for beginners</a>.</p>
|
||
<p>Hugo provides a <code>new</code> command to create a new website.</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 site <new_project></span></span></code></pre></div><p>The Relearn theme provides <a href="/hugo-theme-relearn/cont/archetypes/index.html">archetypes</a> to help you create this kind of pages.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="frontmatter">Frontmatter</h1>
|
||
|
||
<p>Each Hugo page <strong>has to define</strong> a <a href="https://gohugo.io/content/front-matter/" rel="external" target="_blank">frontmatter</a>.</p>
|
||
<h2 id="all-frontmatter-options">All Frontmatter Options</h2>
|
||
<p>The values reflect example options. The defaults can be taken from the <a href="/hugo-theme-relearn/cont/frontmatter/index.html#annotated-frontmatter-options">annotated example</a> below.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierDisplayName</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierEmail</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">description</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPost</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPre</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">hidden</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">images</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'images/hero.png'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s1">'{}'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPost</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPre</span> <span class="p">=</span> <span class="s1">''</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s1">'{ "securityLevel": "loose" }'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s1">'weight'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Example Page'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">LastModifierDisplayName</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">LastModifierEmail</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">alwaysopen</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">collapsibleMenu</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">customMathJaxURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">customMermaidURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">customOpenapiURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableBreadcrumb</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableMathJax</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableMermaid</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableNextPrev</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableOpenapi</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">disableToc</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">editURL</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">headingPost</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">headingPre</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">hidden</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">highlightWrap</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">imageEffects</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">border</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lazy</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lightbox</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shadow</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">images</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="l">images/hero.png</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mathJaxInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{}'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">menuPost</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">menuPre</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mermaidInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "securityLevel": "loose" }'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mermaidZoom</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">ordersectionsby</span><span class="p">:</span><span class="w"> </span><span class="l">weight</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Example Page</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"LastModifierDisplayName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"LastModifierEmail"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"alwaysopen"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"collapsibleMenu"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customMathJaxURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customMermaidURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"customOpenapiURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableBreadcrumb"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableMathJax"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableMermaid"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableNextPrev"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableOpenapi"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableToc"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"editURL"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"headingPost"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"headingPre"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"hidden"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"highlightWrap"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"imageEffects"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"border"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lazy"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lightbox"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shadow"</span><span class="p">:</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"images"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"images/hero.png"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mathJaxInitialize"</span><span class="p">:</span> <span class="s2">"{}"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"menuPost"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"menuPre"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidInitialize"</span><span class="p">:</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidZoom"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"ordersectionsby"</span><span class="p">:</span> <span class="s2">"weight"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Example Page"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="annotated-frontmatter-options">Annotated Frontmatter Options</h2>
|
||
|
||
<div class="tab-panel" data-tab-group="26c2c3aad23563bbb2815b249debffff">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="toml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('26c2c3aad23563bbb2815b249debffff','toml')"
|
||
>
|
||
<span class="tab-nav-text">toml</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If an option value is said to be not set, you can achieve the same behavior</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># by giving it an empty string value.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hugo</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options usually apply to other themes as well.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The social media image of your page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is used for generating social media meta information for the opengraph</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># protocol and twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">images</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"images/hero.png"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of your page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A page without a title is treated as a hidden page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Example Page"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The description of your page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is used for generating HTML meta tags, social media meta information</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># for the opengraph protocol and twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used for the html</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># meta tag, social media meta information for the opengraph protocol and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">description</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Relearn Theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options are specific to the Relearn theme.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Topbar</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify the topbar appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the table of contents button.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the TOC button is hidden, also the keyboard shortcut is disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide the breadcrumbs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the breadcrumbs are hidden, the title of the displayed page will still be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># shown in the topbar.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide Next and Previous navigation buttons.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the navigation buttons are hidden, also the keyboard shortcuts are</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The URL prefix to edit a page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, an edit button will be shown in the topbar. If the button is hidden,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># also the keyboard shortcuts are disabled. The value can contain the macro</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># `${FilePath}` which will be replaced by the file path of your displayed page.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used. If the global</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># parameter is given but you want to hide the button for the displayed page,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set the value to an empty string. If instead of hiding you want to have</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># an disabled button, you can set the value to a string containing just spaces.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This is useful if you want to give the opportunity for people to create merge</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># request for your content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">editURL</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Menu</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify the menu appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Prefix for the title in main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page in the menu will be prefixed by this HTML content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPre</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Suffix for the title in main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page in the menu will be suffixed by this HTML content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPost</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The order of main menu submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "expirydate", "publishdate", "date", "length" or "default" (adhering to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hugo's default sort order).</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the value of the parent menu entry is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"weight"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The initial expand state of submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This controls whether submenus will be expanded (true), or collapsed (false)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># in the menu. If not set, the first menu level is set to false, all others</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># levels are set to true. If not set, the value of the parent menu entry is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If the displayed page has submenus, they will always been displayed expanded</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># regardless of this option.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Shows expander for submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set to true, a submenu in the sidebar will be displayed in a collapsible</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># tree view and a clickable expander is set in front of the entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hidden pages</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how hidden pages are treated.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A page flagged as hidden, is only removed from the main menu if you are</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># currently not on this page or the hidden page is not part of current page's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ancestors. For all other functionality in Hugo a hidden page behaves like any</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># other page if not otherwise configured.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide a page's menu entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If this value is true, the page is hidden from the menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">hidden</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Content</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options modify how your content is displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Prefix for the title in the content area.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page heading will be prefixed by this HTML content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPre</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Suffix for the title in the content area.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page heading will be suffixed by this HTML content.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPost</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Display name of the page's last editor.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, it will be displayed in the default footer.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierDisplayName</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Email address of the page's last editor.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set together with LastModifierDisplayName, it will be displayed in the</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># default footer.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierEmail</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Highlight</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how code is displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Wrap for code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># By default lines of code blocks wrap around if the line is too long to be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># displayed on screen. If you dislike this behavior, you can reconfigure it</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># here.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Note that lines always wrap in print mode regardless of this option.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used or given as a</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># parameter to individual code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Images</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how images are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Image effects.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># See the documentation for how you can even add your own arbitrary effects to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># the list.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># All effect values default to the values of your site's hugo.toml and can be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># overridden through URL parameter given to the image. See the documentation for</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># details.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how math formulae are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initialization options for MathJax.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See the MathJaxdocumentation for possible parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{}"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load MathJax if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Math shortcode is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMathJax=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external MathJax library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the MathJax library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Mermaid</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how Mermaid graphs are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Make graphs panable and zoomable</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For huge graphs it can be helpful to make them zoomable. Zoomable graphs come</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># with a reset button for the zoom.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used or given as a</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># parameter to individual graphs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initialization options for Mermaid.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See the Mermaid documentation for possible parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load Mermaid if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Mermaid shortcode or codefence is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Mermaid will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableMermaid=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external Mermaid library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the Mermaid library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenApi</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These options configure how OpenAPI specifications are displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only load OpenAPI if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a OpenAPI shortcode is found, the option will be ignored and</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenAPI will be loaded regardlessly. The option is still useful in case you</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># are using scripting to set up your graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence is involved and the library is not loaded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># you can set `disableOpenapi=false` in your frontmatter to force the library to</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be loaded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL for external OpenAPI library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies the remote location of the OpenAPI library. By default the shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If not set, the set value of your site's hugo.toml is used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="some-detailed-examples">Some Detailed Examples</h2>
|
||
<h3 id="add-icon-to-a-menu-entry">Add Icon to a Menu Entry</h3>
|
||
<p>In the page frontmatter, add a <code>menuPre</code> param to insert any HTML code before the menu label. The example below uses the GitHub icon.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPre</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-github'></i> "</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'GitHub repo'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">menuPre</span><span class="p">:</span><span class="w"> </span><span class="s1">'<i class=''fab fa-github''></i> '</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">GitHub repo</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"menuPre"</span><span class="p">:</span> <span class="s2">"\u003ci class='fab fa-github'\u003e\u003c/i\u003e "</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p><a href="#R-image-f19cf7fc0622f436a3a8976a0ea89837" class="lightbox-link"><img alt="Title with icon" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/cont/frontmatter/frontmatter-icon.png?width=18.75rem" style=" height: auto; width: 18.75rem;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-f19cf7fc0622f436a3a8976a0ea89837"><img alt="Title with icon" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/cont/frontmatter/frontmatter-icon.png?width=18.75rem"></a></p>
|
||
<h3 id="ordering-sibling-menupage-entries">Ordering Sibling Menu/Page Entries</h3>
|
||
<p>Hugo provides a <a href="https://gohugo.io/content/ordering/" rel="external" target="_blank">flexible way</a> to handle order for your pages.</p>
|
||
<p>The simplest way is to set <code>weight</code> parameter to a number.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'My page'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">5</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">My page</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">5</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"title"</span><span class="p">:</span> <span class="s2">"My page"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">5</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="using-a-custom-title-for-menu-entries">Using a Custom Title for Menu Entries</h3>
|
||
<p>By default, the Relearn theme will use a page’s <code>title</code> attribute for the menu item.</p>
|
||
<p>But a page’s title has to be descriptive on its own while the menu is a hierarchy. Hugo adds the <code>linkTitle</code> parameter for that purpose:</p>
|
||
<p>For example (for a page named <code>content/install/linux.md</code>):</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">linkTitle</span> <span class="p">=</span> <span class="s1">'Linux'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Install on Linux'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">linkTitle</span><span class="p">:</span><span class="w"> </span><span class="l">Linux</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Install on Linux</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"linkTitle"</span><span class="p">:</span> <span class="s2">"Linux"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Install on Linux"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="override-expand-state-rules-for-menu-entries">Override Expand State Rules for Menu Entries</h3>
|
||
<p>You can change how the theme expands menu entries on the side of the content with the <code>alwaysopen</code> setting on a per page basis. If <code>alwaysopen=false</code> for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.</p>
|
||
<p>The theme generates the menu based on the following rules:</p>
|
||
<ul>
|
||
<li>all parent entries of the active page including their siblings are shown regardless of any settings</li>
|
||
<li>immediate children entries of the active page are shown regardless of any settings</li>
|
||
<li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li>
|
||
<li>if not overridden, all other entries of levels besides the first behave like they would have been given <code>alwaysopen=true</code></li>
|
||
<li>all visible entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursively</li>
|
||
<li>all remaining entries are not shown</li>
|
||
</ul>
|
||
<p>You can see this feature in action on the example page for <a href="/hugo-theme-relearn/shortcodes/children/index.html">children shortcode</a> and its children pages.</p>
|
||
<h2 id="disable-section-pages">Disable Section Pages</h2>
|
||
<p>You may want to structure your pages in a hierarchical way but don’t want to generate pages for those sections? The theme got you covered.</p>
|
||
<p>To stay with the initial example: Suppose you want <code>level-one</code> appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.</p>
|
||
<p>For this, open <code>content/level-one/_index.md</code> and add the following frontmatter</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">_build</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">render</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">collapsibleMenu</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"_build"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"render"</span><span class="p">:</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"collapsibleMenu"</span><span class="p">:</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="archetypes">Archetypes</h1>
|
||
|
||
<p>Using the command: <code>hugo new [relative new content path]</code>, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: <a href="https://gohugo.io/content/archetypes/" rel="external" target="_blank">archetypes</a>. These are preconfigured skeleton pages with default frontmatter.</p>
|
||
<p>The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.</p>
|
||
<h2 id="predefined-archetypes">Predefined Archetypes</h2>
|
||
<h3 id="archetypes-home">Home</h3>
|
||
<p>A <strong>Home</strong> page is the starting page of your project. It’s best to have only one page of this kind in your project.</p>
|
||
<p><a href="#R-image-906a008929d9473e1e827a3f58bd9aa2" class="lightbox-link"><img alt="Home page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-home.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-906a008929d9473e1e827a3f58bd9aa2"><img alt="Home page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-home.png?width=60pc"></a></p>
|
||
<p>To create a home page, run the following command</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 home _index.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
|
||
|
||
<div class="tab-panel" data-tab-group="c64d58143af37ee615cbbbd98371fb47">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="_indexmd"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('c64d58143af37ee615cbbbd98371fb47','_indexmd')"
|
||
>
|
||
<span class="tab-nav-text">_index.md</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="_indexmd"
|
||
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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">archetype</span> <span class="p">=</span> <span class="s2">"home"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"{{ replace .Name "</span><span class="nx">-</span><span class="s2">" "</span> <span class="s2">" | title }}"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">Ipsum</span><span class="p">.</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h3 id="archetypes-chapter">Chapter</h3>
|
||
<p>A <strong>Chapter</strong> displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.</p>
|
||
<p><a href="#R-image-d3a5e238ac0732dab547a4dfa4e8d7cd" class="lightbox-link"><img alt="Chapter page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-chapter.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-d3a5e238ac0732dab547a4dfa4e8d7cd"><img alt="Chapter page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-chapter.png?width=60pc"></a></p>
|
||
<p>To create a chapter page, run the following command</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 <name>/_index.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
|
||
|
||
<div class="tab-panel" data-tab-group="51b7cf43afb109b32632aad9856a7bb0">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="_indexmd"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('51b7cf43afb109b32632aad9856a7bb0','_indexmd')"
|
||
>
|
||
<span class="tab-nav-text">_index.md</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="_indexmd"
|
||
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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">archetype</span> <span class="p">=</span> <span class="s2">"chapter"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"{{ replace .Name "</span><span class="nx">-</span><span class="s2">" "</span> <span class="s2">" | title }}"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">Ipsum</span><span class="p">.</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>The <code>weight</code> number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.</p>
|
||
<h3 id="archetypes-default">Default</h3>
|
||
<p>A <strong>Default</strong> page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.</p>
|
||
<p><a href="#R-image-42f3fb7267cde83968ed15066cdd7adb" class="lightbox-link"><img alt="Default page" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-default.png?width=60pc" style=" height: auto; width: 60pc;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-42f3fb7267cde83968ed15066cdd7adb"><img alt="Default page" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/cont/archetypes/pages-default.png?width=60pc"></a></p>
|
||
<p>To create a default page, run either one of the following commands</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 <chapter>/<name>/_index.md</span></span></code></pre></div><p>or</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 <chapter>/<name>.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
|
||
|
||
<div class="tab-panel" data-tab-group="4f4e1cadf898210d29f592b3e6646cdc">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="md"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('4f4e1cadf898210d29f592b3e6646cdc','md')"
|
||
>
|
||
<span class="tab-nav-text">*.md</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="md"
|
||
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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"{{ replace .Name "</span><span class="nx">-</span><span class="s2">" "</span> <span class="s2">" | title }}"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">Ipsum</span><span class="p">.</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="self-defined-archetypes">Self defined Archetypes</h2>
|
||
<p>If you are in need of further archetypes you can define your own or even redefine existing ones.</p>
|
||
<h3 id="template">Template</h3>
|
||
<p>Define a template file in your project at <code>archetypes/<kind>.md</code> and make sure it has at least the frontmatter parameter for that archetype like</p>
|
||
|
||
<div class="tab-panel" data-tab-group="7099fbc596c57cc48733c83a2ff732c9">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="ltkindgtmd"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('7099fbc596c57cc48733c83a2ff732c9','ltkindgtmd')"
|
||
>
|
||
<span class="tab-nav-text"><kind>.md</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="ltkindgtmd"
|
||
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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">archetype</span> <span class="p">=</span> <span class="s2">"<kind>"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>Afterwards you can generate new content files of that kind with the following command</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 <kind> <name>/_index.md</span></span></code></pre></div><h3 id="partials">Partials</h3>
|
||
<p>To define how your archetypes are rendered, define corresponding partial files in your projects directory <code>layouts/partials/archetypes/<kind></code>.</p>
|
||
<p>If you use an unknown archetype in your frontmatter, the <code>default</code> archetype will be used to generate the page.</p>
|
||
<p>Related to each archetype, several <em>hook</em> partial files in the form of <code><hook>.html</code> can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.</p>
|
||
<p>The following hooks are used:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>styleclass</td>
|
||
<td>Defines a set of CSS classes to be added to the HTML’s <code><main></code> element. You can use these classes to define own CSS rules in your <code>custom-header.html</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>article</td>
|
||
<td>Defines the HTML how to render your content</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Take a look at the existing archetypes of this theme to get an idea how to utilize it.</p>
|
||
<h4 id="output-formats">Output formats</h4>
|
||
<p>Each hook file can be overridden of a specific <a href="https://gohugo.io/templates/output-formats/" rel="external" target="_blank">output format</a>. Eg. if you define a new output format <code>PLAINTEXT</code> in your <code>hugo.toml</code>, you can add a file <code>layouts/partials/archetypes/default.plaintext.html</code> to change the way how normal content is written for that output format.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/content/index.html">Content</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="markdown-syntax">Markdown Syntax</h1>
|
||
|
||
<p>Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
|
||
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
|
||
<p>Some of the key benefits are:</p>
|
||
<ol>
|
||
<li>Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.</li>
|
||
<li>Less chance of errors when writing in Markdown.</li>
|
||
<li>Produces valid HTML output.</li>
|
||
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
|
||
<li>Write in any text editor or Markdown application you like.</li>
|
||
<li>Markdown is a joy to use!</li>
|
||
</ol>
|
||
<p>John Gruber, the author of Markdown, puts it like this:</p>
|
||
<blockquote>
|
||
<p>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
||
<cite>John Gruber</cite></p>
|
||
</blockquote>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p><i class="fa-fw fas fa-bookmark"></i> Bookmark this page for easy future reference!</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="standard-and-extensions">Standard and Extensions</h2>
|
||
<p>If not otherwise noted, the showed examples adhere to the <a href="https://commonmark.org/help/" rel="external" target="_blank">Commonmark</a> standard. In addition the theme supports the following extensions:</p>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Extension on top of standard Markdown adhering to <a href="https://github.github.com/gfm/" rel="external" target="_blank">GitHub Flavored Markdown</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Extension on top of standard Markdown adhering to <a href="https://michelf.ca/projects/php-markdown/extra/" rel="external" target="_blank">PHP Markdown</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i></span><span class="badge-content" style="background-color: darkorange;">Pants</span></span> Extension by John Gruber adhering to <a href="https://daringfireball.net/projects/smartypants/" rel="external" target="_blank">SmartyPants</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-puzzle-piece"></i></span><span class="badge-content" style="background-color: #7dc903;">Relearn</span></span> Extension specific to this theme.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> If the <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_blank">usage of HTML</a> is allowed in your <code>hugo.toml</code> the theme supports styling for further elements not accessible using Markdown alone.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="paragraphs">Paragraphs</h2>
|
||
<p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p>
|
||
<p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
|
||
<p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="headings">Headings</h2>
|
||
<p>A good idea is to structure your content using headings and subheadings. HTML-headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level.</p>
|
||
<p>In Hugo you usually don’t use <code>h1</code> as this is generated by your theme and you should only have one such element in a document.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="gh"># h1 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">## h2 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">### h3 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">#### h4 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">##### h5 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl">###### h6 Heading</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<h1 id="h1-heading">h1 Heading</h1>
|
||
<h2 id="h2-heading">h2 Heading</h2>
|
||
<h3 id="h3-heading">h3 Heading</h3>
|
||
<h4 id="h4-heading">h4 Heading</h4>
|
||
<h5 id="h5-heading">h5 Heading</h5>
|
||
<h6 id="h6-heading">h6 Heading</h6>
|
||
</div>
|
||
</div>
|
||
<h2 id="horizontal-rules">Horizontal Rules</h2>
|
||
<p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes <code>---</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">---
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
|
||
<hr>
|
||
<p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="text-markers">Text Markers</h2>
|
||
<h3 id="bold">Bold</h3>
|
||
<p>You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks <code>**</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered with **bold text**</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>I am rendered with <strong>bold text</strong></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="italics">Italics</h3>
|
||
<p>You can emphasize a snippet of text with italics by enclosing it with underscores <code>_</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered with _italicized text_</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>I am rendered with <em>italicized text</em></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="strikethrough">Strikethrough</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> You can do strikethroughs by enclosing text with two tildes <code>~~</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">~~Strike through this text~~</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><del>Strike through this text</del></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="marked-text">Marked Text</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> You can mark text in the predefined accent color of your stylesheet.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">mark</span><span class="p">></span>Parts<span class="p"></</span><span class="nt">mark</span><span class="p">></span> of this text <span class="p"><</span><span class="nt">mark</span><span class="p">></span>are marked!<span class="p"></</span><span class="nt">mark</span><span class="p">></span></span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><mark>Parts</mark> of this text <mark>are marked!</mark></p>
|
||
</div>
|
||
</div>
|
||
<h2 id="special-typesetting">Special Typesetting</h2>
|
||
<h3 id="text-substitution">Text Substitution</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i></span><span class="badge-content" style="background-color: darkorange;">Pants</span></span> You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Double quotes <span class="sb">`"`</span> and single quotes <span class="sb">`'`</span> of enclosed text are replaced by <span class="ge">**</span>"double curly quotes"** and <span class="ge">**</span>'single curly quotes'**.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double dashes <span class="sb">`--`</span> and triple dashes <span class="sb">`---`</span> are replaced by en-dash <span class="ge">**</span>--** and em-dash <span class="ge">**</span>---** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double arrows pointing left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> are replaced by arrow <span class="ge">**</span><span class="err"><<</span>** and <span class="ge">**</span>>>** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> are replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p>
|
||
<p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p>
|
||
<p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p>
|
||
<p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="keyboard-shortcuts">Keyboard Shortcuts</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> You can use the <code><kbd></code> element to style keyboard shortcuts.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Press <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>STRG<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>ALT<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>DEL<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> to end your shift early.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Press <kbd>STRG</kbd> <kbd>ALT</kbd> <kbd>DEL</kbd> to end your shift early.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="sub-and-super-script">Sub and Super Script</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> You can also use the <code><sub></code> and <code><sup></code> elements. For more complex stuff or if your configuration does not allow HTML, you can use the <a href="/hugo-theme-relearn/shortcodes/math/index.html"><code>math</code> shortcode</a>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">How many liters H<span class="p"><</span><span class="nt">sub</span><span class="p">></span>2<span class="p"></</span><span class="nt">sub</span><span class="p">></span>O fit into 1dm<span class="p"><</span><span class="nt">sup</span><span class="p">></span>3<span class="p"></</span><span class="nt">sup</span><span class="p">></span>?</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>How many liters H<sub>2</sub>O fit into 1dm<sup>3</sup>?</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="lists">Lists</h2>
|
||
<h3 id="unordered">Unordered</h3>
|
||
<p>You can write a list of items in which the order of the items does not explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for each list item but should not switch between those symbols inside one whole list.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">-</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> Consectetur adipiscing elit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
|
||
</span></span><span class="line"><span class="cl">- Faucibus porta lacus fringilla vel</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ul>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipiscing elit
|
||
<ul>
|
||
<li>Vestibulum laoreet porttitor sem</li>
|
||
<li>Ac tristique libero volutpat at</li>
|
||
</ul>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ul>
|
||
<li>Phasellus iaculis neque</li>
|
||
<li>Purus sodales ultricies</li>
|
||
</ul>
|
||
</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="ordered">Ordered</h3>
|
||
<p>You can create a list of items in which the order of items does explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">1.</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">3.</span> Consectetur adipiscing elit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Integer molestie lorem at massa
|
||
</span></span><span class="line"><span class="cl"> <span class="k">7.</span> Facilisis in pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl"><span class="k">99.</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Faucibus porta lacus fringilla vel
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Aenean sit amet erat nunc
|
||
</span></span><span class="line"><span class="cl">17. Eget porttitor lorem</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ol>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipiscing elit
|
||
<ol>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis in pretium nisl aliquet</li>
|
||
</ol>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ol>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
</ol>
|
||
</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<h3 id="tasks">Tasks</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> You can add task lists resulting in checked or unchecked non-clickable items</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">- [x]</span> Basic Test
|
||
</span></span><span class="line"><span class="cl"><span class="k">- [ ]</span> More Tests
|
||
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> View
|
||
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> Hear
|
||
</span></span><span class="line"><span class="cl"> - [ ] Smell</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ul>
|
||
<li><input checked="" disabled="" type="checkbox"> Basic Test</li>
|
||
<li><input disabled="" type="checkbox"> More Tests
|
||
<ul>
|
||
<li><input checked="" disabled="" type="checkbox"> View</li>
|
||
<li><input checked="" disabled="" type="checkbox"> Hear</li>
|
||
<li><input disabled="" type="checkbox"> Smell</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="definitions">Definitions</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p>
|
||
<p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p>
|
||
<p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Apple
|
||
</span></span><span class="line"><span class="cl">: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
|
||
</span></span><span class="line"><span class="cl">: An American computer company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Orange
|
||
</span></span><span class="line"><span class="cl">: The fruit of an evergreen tree of the genus Citrus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can make juice out of it.
|
||
</span></span><span class="line"><span class="cl">: A telecommunication company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can't make juice out of it.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<dl>
|
||
<dt>Apple</dt>
|
||
<dd>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</dd>
|
||
<dd>An American computer company.</dd>
|
||
<dt>Orange</dt>
|
||
<dd>The fruit of an evergreen tree of the genus Citrus.
|
||
<p>You can make juice out of it.</p>
|
||
</dd>
|
||
<dd>A telecommunication company.
|
||
<p>You can’t make juice out of it.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
<h2 id="code">Code</h2>
|
||
<h3 id="inline-code">Inline Code</h3>
|
||
<p>Inline snippets of code can be wrapped with backticks <code>`</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">In this example, <span class="sb">`<div></div>`</span> is marked as code.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>In this example, <code><div></div></code> is marked as code.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="indented-code-block">Indented Code Block</h3>
|
||
<p>A simple code block can be generated by indenting several lines of code by at least two spaces.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Be impressed by my advanced code:
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> // Some comments
|
||
</span></span><span class="line"><span class="cl"> line 1 of code
|
||
</span></span><span class="line"><span class="cl"> line 2 of code
|
||
</span></span><span class="line"><span class="cl"> line 3 of code</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Be impressed by my advanced code:</p>
|
||
<pre><code>// Some comments
|
||
line 1 of code
|
||
line 2 of code
|
||
line 3 of code
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
<h3 id="fenced-code-block">Fenced Code Block</h3>
|
||
<p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> You can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p>
|
||
<p>See <a href="/hugo-theme-relearn/shortcodes/highlight/index.html">Code Highlighting</a> for additional documentation.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```js
|
||
</span></span><span class="line"><span class="cl">{
|
||
</span></span><span class="line"><span class="cl"> name: "Claus",
|
||
</span></span><span class="line"><span class="cl"> surname: "Santa",
|
||
</span></span><span class="line"><span class="cl"> profession: "courier",
|
||
</span></span><span class="line"><span class="cl"> age: 666,
|
||
</span></span><span class="line"><span class="cl"> address: {
|
||
</span></span><span class="line"><span class="cl"> city: "North Pole",
|
||
</span></span><span class="line"><span class="cl"> postalCode: 1,
|
||
</span></span><span class="line"><span class="cl"> country: "Arctic"
|
||
</span></span><span class="line"><span class="cl"> },
|
||
</span></span><span class="line"><span class="cl"> friends: [ "Dasher", "Dancer", "Prancer", "Vixen", "Comet", "Cupid", "Donder", "Blitzen", "Rudolph" ]
|
||
</span></span><span class="line"><span class="cl">};
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span><span class="o">:</span> <span class="s2">"Claus"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">surname</span><span class="o">:</span> <span class="s2">"Santa"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">profession</span><span class="o">:</span> <span class="s2">"courier"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">age</span><span class="o">:</span> <span class="mi">666</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">address</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">city</span><span class="o">:</span> <span class="s2">"North Pole"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">postalCode</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">country</span><span class="o">:</span> <span class="s2">"Arctic"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">friends</span><span class="o">:</span> <span class="p">[</span> <span class="s2">"Dasher"</span><span class="p">,</span> <span class="s2">"Dancer"</span><span class="p">,</span> <span class="s2">"Prancer"</span><span class="p">,</span> <span class="s2">"Vixen"</span><span class="p">,</span> <span class="s2">"Comet"</span><span class="p">,</span> <span class="s2">"Cupid"</span><span class="p">,</span> <span class="s2">"Donder"</span><span class="p">,</span> <span class="s2">"Blitzen"</span><span class="p">,</span> <span class="s2">"Rudolph"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">};</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<h2 id="tables">Tables</h2>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> You can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Option | Description |
|
||
</span></span><span class="line"><span class="cl">|--------|-------------|
|
||
</span></span><span class="line"><span class="cl">| data | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | extension to be used for dest files. |</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>data</td>
|
||
<td>path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>engine</td>
|
||
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h3 id="aligned-columns">Aligned Columns</h3>
|
||
<p>Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Option | Number | Description |
|
||
</span></span><span class="line"><span class="cl">|-------:|:------:|:------------|
|
||
</span></span><span class="line"><span class="cl">| data | 1 | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | 3 | extension to be used for dest files. |</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:right">Option</th>
|
||
<th style="text-align:center">Number</th>
|
||
<th style="text-align:left">Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:right">data</td>
|
||
<td style="text-align:center">1</td>
|
||
<td style="text-align:left">path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">engine</td>
|
||
<td style="text-align:center">2</td>
|
||
<td style="text-align:left">engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">ext</td>
|
||
<td style="text-align:center">3</td>
|
||
<td style="text-align:left">extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h2 id="blockquotes">Blockquotes</h2>
|
||
<p>For quoting blocks of content from another source within your document add <code>></code> before any text you want to quote.</p>
|
||
<p>Blockquotes can also be nested.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
|
||
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">>
|
||
</span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>>
|
||
</span></span><span class="line"><span class="cl">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<blockquote>
|
||
<p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.</p>
|
||
<blockquote>
|
||
<p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p>
|
||
</blockquote>
|
||
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
<h2 id="links">Links</h2>
|
||
<h3 id="autolink">Autolink</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Absolute URLs will automatically be converted into a link.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">This is a link to https://example.com.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>This is a link to <a href="https://example.com" rel="external" target="_blank">https://example.com</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="basic-link">Basic Link</h3>
|
||
<p>You can explicitly define links in case you want to use non-absolute URLs or want to give different text.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">Assemble</span>](<span class="na">http://assemble.io</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="http://assemble.io" rel="external" target="_blank">Assemble</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-with-tooltip">Link with Tooltip</h3>
|
||
<p>For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">Upstage</span>](<span class="na">https://github.com/upstage/ "Visit Upstage!"</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="https://github.com/upstage/" rel="external" target="_blank" title="Visit Upstage!">Upstage</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-references">Link References</h3>
|
||
<p>Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[Example][somelinkID]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[somelinkID]: https://example.com "Go to example domain"</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="https://example.com" rel="external" target="_blank" title="Go to example domain">Example</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="footnotes">Footnotes</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p>
|
||
<p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p>
|
||
<p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">That's some text with a footnote[^1]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^1]: And that's the footnote.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">That's some more text with a footnote.[^someid]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^someid]:
|
||
</span></span><span class="line"><span class="cl"> Anything of interest goes here.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Blue light glows blue.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>That’s some text with a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
||
<p>That’s some more text with a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>And that’s the footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anything of interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="images">Images</h2>
|
||
<h3 id="basic-images">Basic Images</h3>
|
||
<p>Images have a similar syntax to links but include a preceding exclamation mark.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spock</span>](<span class="na">https://octodex.github.com/images/spocktocat.png</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-4d3884356c934056178742cc261e53d4" class="lightbox-link"><img alt="Spock" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/spocktocat.png?width=20vw" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-4d3884356c934056178742cc261e53d4"><img alt="Spock" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spocktocat.png?width=20vw"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-with-tooltip">Image with Tooltip</h3>
|
||
<p>Like links, images can also be given a tooltip.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Picard</span>](<span class="na">https://octodex.github.com/images/jean-luc-picat.jpg "Jean Luc Picard"</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-a39f731b2e553e29ce69b3c06426d0e2" class="lightbox-link"><img alt="Picard" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" style=" height: auto; width: 20vw;" title="Jean Luc Picard"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-a39f731b2e553e29ce69b3c06426d0e2"><img alt="Picard" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" title="Jean Luc Picard"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-references">Image References</h3>
|
||
<p>Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![La Forge][laforge]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-3a6bad7aec9e8703286fb24aa4eecaca" class="lightbox-link"><img alt="La Forge" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/trekkie.jpg?width=20vw" style=" height: auto; width: 20vw;" title="Geordi La Forge"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3a6bad7aec9e8703286fb24aa4eecaca"><img alt="La Forge" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/trekkie.jpg?width=20vw" title="Geordi La Forge"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-effects">Image Effects</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-puzzle-piece"></i></span><span class="badge-content" style="background-color: #7dc903;">Relearn</span></span> This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default <a href="/hugo-theme-relearn/cont/imageeffects/index.html">behavior is configurable</a> through your <code>hugo.toml</code> or frontmatter parameter.</p>
|
||
<h4 id="resizing">Resizing</h4>
|
||
<p>Add query parameter <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?width=20vw</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-520cfc1338a80e0d7754fcd92737ded5" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?width=20vw" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-520cfc1338a80e0d7754fcd92737ded5"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?width=20vw"></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-1581d2e893c59157e9eac98fc7e39065" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px" style=" height: 50px; width: auto;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-1581d2e893c59157e9eac98fc7e39065"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px"></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px&width=40vw</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-0ea9bd03b5c8a35feb6de90753fddf37" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" style=" height: 50px; width: 40vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-0ea9bd03b5c8a35feb6de90753fddf37"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px&width=40vw"></a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="css-classes">CSS Classes</h4>
|
||
<p>Add a query parameter <code>classes</code> to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.</p>
|
||
<h5 id="shadow">Shadow</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=shadow</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-b28303a8adb71fa1d56df289f8bb98fc" class="lightbox-link"><img alt="Spidertocat" class="bg-white border lazy lightbox noborder shadow figure-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-b28303a8adb71fa1d56df289f8bb98fc"><img alt="Spidertocat" class="bg-white border lazy lightbox noborder shadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="border">Border</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=border</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-e27f5641e171afb4c4b09959c2945033" class="lightbox-link"><img alt="DrOctocat" class="bg-white border lazy lightbox noshadow noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-e27f5641e171afb4c4b09959c2945033"><img alt="DrOctocat" class="bg-white border lazy lightbox noshadow noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="left">Left</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=left</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-14ef5ccdab9e9764469774cf8d87b969" class="lightbox-link"><img alt="Supertocat" class="bg-white border lazy left lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-14ef5ccdab9e9764469774cf8d87b969"><img alt="Supertocat" class="bg-white border lazy left lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="right">Right</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=right</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-3ed2450ad3de3f6475aa0d234a834010" class="lightbox-link"><img alt="Riddlocat" class="bg-white border lazy lightbox right noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3ed2450ad3de3f6475aa0d234a834010"><img alt="Riddlocat" class="bg-white border lazy lightbox right noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="inline">Inline</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=inline</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-0936041bc2a45cd2ceb5792ff38af8b1" class="lightbox-link"><img alt="Spidertocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-0936041bc2a45cd2ceb5792ff38af8b1"><img alt="Spidertocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline"></a>
|
||
<a href="#R-image-d93a7fd015408933e7e3b3ac274036dd" class="lightbox-link"><img alt="DrOctocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-d93a7fd015408933e7e3b3ac274036dd"><img alt="DrOctocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline"></a>
|
||
<a href="#R-image-855e2c35461b3f8261a558bef5597c81" class="lightbox-link"><img alt="Supertocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-855e2c35461b3f8261a558bef5597c81"><img alt="Supertocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline"></a>
|
||
<a href="#R-image-965be1c7e786095b9bcdd62f6d2a6346" class="lightbox-link"><img alt="Riddlocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-965be1c7e786095b9bcdd62f6d2a6346"><img alt="Riddlocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="combination">Combination</h5>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">X-tocat</span>](<span class="na">https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-93550ce85fa3b5a68a9763b6bddfa97e" class="lightbox-link"><img alt="X-tocat" class="bg-white border lazy left lightbox shadow figure-image" loading="lazy" src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" style=" height: auto; width: 20vw;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-93550ce85fa3b5a68a9763b6bddfa97e"><img alt="X-tocat" class="bg-white border lazy left lightbox shadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left"></a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="lightbox">Lightbox</h4>
|
||
<p>Add the query parameter <code>lightbox=false</code> to the image link to disable the lightbox.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><img alt="Homercat" class="bg-white border lazy nolightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style=" height: auto; width: 20vw;"></p>
|
||
</div>
|
||
</div>
|
||
|
||
<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>If you want to wrap an image in a link and <code>lightbox=true</code> is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">![Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)](https://octodex.github.com/#homercat)</span></span></code></pre></div><p><a href="https://octodex.github.com/#homercat" rel="external" target="_blank"><img alt="Homercat" class="bg-white border lazy nolightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style=" height: auto; width: 20vw;"></a></p>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="image-effects">Image Effects</h1>
|
||
|
||
<p>The theme supports non-standard <a href="/hugo-theme-relearn/cont/markdown/index.html#image-effects">image effects</a>.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>border</td>
|
||
<td>Draws a light thin border around the image</td>
|
||
</tr>
|
||
<tr>
|
||
<td>lazy</td>
|
||
<td>Lets the image be lazy loaded</td>
|
||
</tr>
|
||
<tr>
|
||
<td>lightbox</td>
|
||
<td>The image will be clickable to show it enlarged</td>
|
||
</tr>
|
||
<tr>
|
||
<td>shadow</td>
|
||
<td>Draws a shadow around the image to make it appear hovered/glowing</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>As <a href="/hugo-theme-relearn/cont/markdown/index.html#image-effects">described</a>, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.</p>
|
||
<p>Instead, you can configure the defaults in your <code>hugo.toml</code> as well as overriding these default in the pages frontmatter.</p>
|
||
<p>Explicitly set URL query parameter will override the defaults in effect for a page.</p>
|
||
<p>Without any settings in your <code>hugo.toml</code> this defaults to</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">imageEffects</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">border</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lazy</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lightbox</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shadow</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"imageEffects"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"border"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lazy"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lightbox"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shadow"</span><span class="p">:</span> <span class="kc">false</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>This can be overridden in a pages frontmatter by eg.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">imageEffects</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">border</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"imageEffects"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"border"</span><span class="p">:</span> <span class="kc">true</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Or by explicitly override settings by URL query parameter</p>
|
||
|
||
<div class="tab-panel" data-tab-group="9e0b0f84c80345c71c9c7c65d2ab799c">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="url"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('9e0b0f84c80345c71c9c7c65d2ab799c','url')"
|
||
>
|
||
<span class="tab-nav-text">URL</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="url"
|
||
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-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?lightbox=false&bg-white=true</span>)</span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>The settings applied to the above image would be</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="nx">bg-white</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lazy</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">bg-white</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">border</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">lazy</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">lightbox</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">shadow</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">"bg-white"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"border"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lazy"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lightbox"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shadow"</span><span class="p">:</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>This ends up in the following HTML where the parameter are converted to CSS classes.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="6dae4fb20804f2aca6c8c278bcd023b9">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="html"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('6dae4fb20804f2aca6c8c278bcd023b9','html')"
|
||
>
|
||
<span class="tab-nav-text">HTML</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="html"
|
||
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-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"https://octodex.github.com/images/minion.png?lightbox=false&bg-white=true"</span> <span class="na">loading</span><span class="o">=</span><span class="s">"lazy"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Minion"</span> <span class="na">class</span><span class="o">=</span><span class="s">"bg-white border lazy nolightbox noshadow"</span><span class="p">></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="extending">Extending</h2>
|
||
<p>As you can see in the above example, the <code>bg-white</code> parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your <code>hugo.toml</code> or pages frontmatter.</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>If no extended parameter like <code>bg-white</code> in the example is set on the URL, a <code>class="nobg-white"</code> in the HTML will only be generated if a default value was set in the <code>hugo.toml</code> or pages frontmatter.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="menu-extra-shortcuts">Menu extra shortcuts</h1>
|
||
|
||
<p>You can define additional menu entries or shortcuts in the navigation menu without any link to content.</p>
|
||
<h2 id="basic-configuration">Basic configuration</h2>
|
||
<p>Edit the website configuration <code>hugo.toml</code> and add a <code>[[menu.shortcuts]]</code> entry for each link your want to add.</p>
|
||
<p>Example from the current website:</p>
|
||
|
||
<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">menu</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'ds'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fab fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://github.com/McShelby/hugo-theme-relearn'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'showcase/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'hugodoc'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bookmark'></i> Hugo Documentation"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://gohugo.io/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bullhorn'></i> Credits"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'more/credits/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'tags/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span></span></span></code></pre></div></div>
|
||
</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">menu</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shortcuts</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">ds</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fab fa-github'></i> GitHub repo</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://github.com/McShelby/hugo-theme-relearn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">10</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-camera'></i> Showcases</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">showcase/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">11</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">hugodoc</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bookmark'></i> Hugo Documentation</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://gohugo.io/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">20</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bullhorn'></i> Credits</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">more/credits/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">30</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-tags'></i> Tags</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">tags/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">40</span></span></span></code></pre></div></div>
|
||
</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">"menu"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shortcuts"</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">"identifier"</span><span class="p">:</span> <span class="s2">"ds"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">10</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"showcase/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">11</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"hugodoc"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://gohugo.io/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">20</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"more/credits/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">30</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"tags/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">40</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>By default, shortcuts are preceded by a title. This title can be disabled by setting <code>disableShortcutsTitle=true</code>.
|
||
However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.</p>
|
||
<p>For example, in your local <code>i18n/en.toml</code> file, add the following content</p>
|
||
|
||
<div class="tab-panel" data-tab-group="f1ab0347ed4b34604b39e6399e6f1c0d">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="entoml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('f1ab0347ed4b34604b39e6399e6f1c0d','entoml')"
|
||
>
|
||
<span class="tab-nav-text">en.toml</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="entoml"
|
||
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">Shortcuts-Title</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">other</span> <span class="p">=</span> <span class="s2">"<Your value>"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>Read more about <a href="https://gohugo.io/extras/menus/" rel="external" target="_blank">hugo menu</a> and <a href="https://gohugo.io/content-management/multilingual/#translation-of-strings" rel="external" target="_blank">hugo i18n translation strings</a></p>
|
||
<h2 id="i18n">Configuration for Multilingual mode</h2>
|
||
<p>When using a multilingual website, you can set different menus for each language. In the <code>hugo.toml</code> file, prefix your menu configuration by <code>Languages.<language-id></code>.</p>
|
||
<p>Example from the current website:</p>
|
||
|
||
<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">languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s1">'English'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s1">'Hugo Relearn Theme'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'ds'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fab fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://github.com/McShelby/hugo-theme-relearn'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'showcase/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'hugodoc'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bookmark'></i> Hugo Documentation"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://gohugo.io/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bullhorn'></i> Credits"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'more/credits/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'tags/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-home'></i> Home"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s1">'Arrr! Pirrrates'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'ds'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fab fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://github.com/McShelby/hugo-theme-relearn'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'showcase/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s1">'hugodoc'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bookmark'></i> Cap'n Hugo Documentat'n"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'https://gohugo.io/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-bullhorn'></i> Crrredits"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'more/credits/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-tags'></i> Arrr! Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">pageRef</span> <span class="p">=</span> <span class="s1">'tags/'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-home'></i> Arrr! Home"</span></span></span></code></pre></div></div>
|
||
</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">languages</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">en</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">languageName</span><span class="p">:</span><span class="w"> </span><span class="l">English</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">menu</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shortcuts</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">ds</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fab fa-github'></i> GitHub repo</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://github.com/McShelby/hugo-theme-relearn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">10</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-camera'></i> Showcases</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">showcase/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">11</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">hugodoc</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bookmark'></i> Hugo Documentation</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://gohugo.io/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">20</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bullhorn'></i> Credits</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">more/credits/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">30</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-tags'></i> Tags</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">tags/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">40</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">landingPageName</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-home'></i> Home</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Hugo Relearn Theme</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pir</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">languageName</span><span class="p">:</span><span class="w"> </span><span class="l">Arrr! Pirrrates</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">menu</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shortcuts</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">ds</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fab fa-github'></i> GitHub repo</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://github.com/McShelby/hugo-theme-relearn</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">10</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-camera'></i> Showcases</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">showcase/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">11</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">identifier</span><span class="p">:</span><span class="w"> </span><span class="l">hugodoc</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bookmark'></i> Cap'n Hugo Documentat'n</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">https://gohugo.io/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">20</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-bullhorn'></i> Crrredits</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">more/credits/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">30</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-tags'></i> Arrr! Tags</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pageRef</span><span class="p">:</span><span class="w"> </span><span class="l">tags/</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">40</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">landingPageName</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-home'></i> Arrr! Home</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Cap'n Hugo Relearrrn Theme</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">1</span></span></span></code></pre></div></div>
|
||
</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">"languages"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"en"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"languageName"</span><span class="p">:</span> <span class="s2">"English"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"menu"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shortcuts"</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">"identifier"</span><span class="p">:</span> <span class="s2">"ds"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">10</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"showcase/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">11</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"hugodoc"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://gohugo.io/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">20</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"more/credits/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">30</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"tags/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">40</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>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"landingPageName"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Hugo Relearn Theme"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pir"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"languageName"</span><span class="p">:</span> <span class="s2">"Arrr! Pirrrates"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"menu"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shortcuts"</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">"identifier"</span><span class="p">:</span> <span class="s2">"ds"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">10</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"showcase/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">11</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="nt">"identifier"</span><span class="p">:</span> <span class="s2">"hugodoc"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"https://gohugo.io/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">20</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Crrredits"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"more/credits/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">30</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Arrr! Tags"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pageRef"</span><span class="p">:</span> <span class="s2">"tags/"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">40</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>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"landingPageName"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Home"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">1</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Read more about <a href="https://gohugo.io/extras/menus/" rel="external" target="_blank">hugo menu</a> and <a href="https://gohugo.io/content-management/multilingual/#menus" rel="external" target="_blank">hugo multilingual menus</a></p>
|
||
<h2 id="shortcuts-to-pages-inside-of-your-project">Shortcuts to pages inside of your project</h2>
|
||
<p>If you have shortcuts to pages inside of your project and you don’t want them to show up in page menu section, you have two choices:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Make the page file for the shortcut a <a href="https://gohugo.io/content-management/page-bundles/#headless-bundle" rel="external" target="_blank">headless branch bundle</a> (contained in its own subdirectory and called <code>_index.md</code>) and add the following frontmatter configuration to the file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its content to <strong>not</strong> be ontained in the sitemap.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Showcase'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s1">'always'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">_build</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">list</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">publishResources</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">render</span><span class="p">:</span><span class="w"> </span><span class="l">always</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Showcase</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"_build"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"list"</span><span class="p">:</span> <span class="s2">"never"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"publishResources"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"render"</span><span class="p">:</span> <span class="s2">"always"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Showcase"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
<li>
|
||
<p>Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>). <strong>Don’t give this page a <code>title</code></strong> as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s1">'never'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">_build</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">list</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">publishResources</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">render</span><span class="p">:</span><span class="w"> </span><span class="l">never</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"_build"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"list"</span><span class="p">:</span> <span class="s2">"never"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"publishResources"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"render"</span><span class="p">:</span> <span class="s2">"never"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its content to be contained in the sitemap.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Credits'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Credits</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"title"</span><span class="p">:</span> <span class="s2">"Credits"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="multilingual-and-i18n">Multilingual and i18n</h1>
|
||
|
||
<p>The Relearn theme is fully compatible with Hugo multilingual mode.</p>
|
||
<ul>
|
||
<li>Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute!</li>
|
||
<li>Full support for languages written right to left</li>
|
||
<li>Automatic menu generation from multilingual content</li>
|
||
<li>In-browser language switching</li>
|
||
</ul>
|
||
<p><a href="#R-image-48fd429964f201addb83f2cf703416cb" class="lightbox-link"><img alt="I18n menu" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/cont/i18n/i18n-menu.gif?width=18.75rem" style=" height: auto; width: 18.75rem;"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-48fd429964f201addb83f2cf703416cb"><img alt="I18n menu" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/cont/i18n/i18n-menu.gif?width=18.75rem"></a></p>
|
||
<h2 id="basic-configuration">Basic configuration</h2>
|
||
<p>After learning <a href="https://gohugo.io/content-management/multilingual" rel="external" target="_blank">how Hugo handle multilingual websites</a>, define your languages in your <code>hugo.toml</code> file.</p>
|
||
<p>For example with current English and Piratized English website.</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>Make sure your default language is defined as the first one in the <code>[languages]</code> array, as the theme needs to make assumptions on it</p>
|
||
</div>
|
||
</div>
|
||
|
||
<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="nx">defaultContentLanguage</span> <span class="p">=</span> <span class="s1">'en'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s1">'English'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s1">'Hugo Relearn Theme'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s1">'Arrr! Pirrrates'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">2</span></span></span></code></pre></div></div>
|
||
</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">defaultContentLanguage</span><span class="p">:</span><span class="w"> </span><span class="l">en</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">languages</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">en</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">languageName</span><span class="p">:</span><span class="w"> </span><span class="l">English</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Hugo Relearn Theme</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pir</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">languageName</span><span class="p">:</span><span class="w"> </span><span class="l">Arrr! Pirrrates</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Cap'n Hugo Relearrrn Theme</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">2</span></span></span></code></pre></div></div>
|
||
</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">"defaultContentLanguage"</span><span class="p">:</span> <span class="s2">"en"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"languages"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"en"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"languageName"</span><span class="p">:</span> <span class="s2">"English"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Hugo Relearn Theme"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"pir"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"languageName"</span><span class="p">:</span> <span class="s2">"Arrr! Pirrrates"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="mi">2</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Then, for each new page, append the <em>id</em> of the language to the file.</p>
|
||
<ul>
|
||
<li>Single file <code>my-page.md</code> is split in two files:
|
||
<ul>
|
||
<li>in English: <code>my-page.md</code></li>
|
||
<li>in Piratized English: <code>my-page.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
<li>Single file <code>_index.md</code> is split in two files:
|
||
<ul>
|
||
<li>in English: <code>_index.md</code></li>
|
||
<li>in Piratized English: <code>_index.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="box notices cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<div class="box-content">
|
||
|
||
<p>Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>Use <a href="https://gohugo.io/content-management/multilingual/#translate-your-content" rel="external" target="_blank">slug</a> frontmatter parameter to translate urls too.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="search">Search</h2>
|
||
<p>In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.</p>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
|
||
<p>Although the theme supports a wide variety of supported languages, the site’s search via the <a href="https://lunrjs.com" rel="external" target="_blank">Lunr</a> search library does not.
|
||
You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:</p>
|
||
<ul>
|
||
<li>Czech</li>
|
||
<li>Indonesian</li>
|
||
<li>Polish</li>
|
||
<li>Swahili</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="search-with-mixed-language-support">Search with mixed language support</h3>
|
||
<p>In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your <code>hugo.toml</code> to broaden search.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'en'</span><span class="p">]</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">additionalContentLanguage</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">en</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"additionalContentLanguage"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"en"</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>As this is an array, you can add multiple additional languages.</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>Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in <code>zh-CN</code>, you have to add just <code>zh</code> to this parameter.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="overwrite-translation-strings">Overwrite translation strings</h2>
|
||
<p>Translations strings are used for common default values used in the theme (<em>Edit</em> button, <em>Search placeholder</em> and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.</p>
|
||
<p>To override these values, create a new file in your local i18n folder <code>i18n/<idlanguage>.toml</code> and inspire yourself from the theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
|
||
<h2 id="disable-language-switching">Disable language switching</h2>
|
||
<p>Switching the language in the browser is a great feature, but for some reasons you may want to disable it.</p>
|
||
<p>Just set <code>disableLanguageSwitchingButton=true</code> in your <code>hugo.toml</code></p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLanguageSwitchingButton</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">disableLanguageSwitchingButton</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"disableLanguageSwitchingButton"</span><span class="p">:</span> <span class="kc">true</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/tutorial/index.html">Tutorial</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="taxonomy">Taxonomy</h1>
|
||
|
||
<p>The Relearn theme supports Hugo’s default taxonomies <em>tag</em> and <em>category</em> out of the box.</p>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>Just add tags and/or categories to any page. They can be given as a single string or an array of strings.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">categories</span> <span class="p">=</span> <span class="p">[</span><span class="s1">'taxonomy'</span><span class="p">,</span> <span class="s1">'content'</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">tags</span> <span class="p">=</span> <span class="s1">'tutorial'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s1">'Taxonomy'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">categories</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="l">taxonomy</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span>- <span class="l">content</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">tags</span><span class="p">:</span><span class="w"> </span><span class="l">tutorial</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l">Taxonomy</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"taxonomy"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"content"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"tags"</span><span class="p">:</span> <span class="s2">"tutorial"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"Taxonomy"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="behavior">Behavior</h2>
|
||
<p>The tags are displayed at the top of the page in alphabetical order.</p>
|
||
<p>The categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own <code>content-footer.html</code> partial.</p>
|
||
<p>Each item is a link to a taxonomy page displaying all the articles with the given term.</p>
|
||
<h2 id="list-all-the-tags">List all the tags</h2>
|
||
<p>In the <code>hugo.toml</code> file you can add a shortcut to display all the tags and categories</p>
|
||
|
||
<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">menu</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'/tags'</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fa-fw fas fa-layer-group'></i> Categories"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s1">'/categories'</span></span></span></code></pre></div></div>
|
||
</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">menu</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">shortcuts</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-tags'></i> Tags</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">/tags</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l"><i class='fa-fw fas fa-layer-group'></i> Categories</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l">/categories</span></span></span></code></pre></div></div>
|
||
</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">"menu"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"shortcuts"</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">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"/tags"</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="nt">"name"</span><span class="p">:</span> <span class="s2">"\u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"url"</span><span class="p">:</span> <span class="s2">"/categories"</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="customization">Customization</h2>
|
||
<p>If you define <a href="https://gohugo.io/content-management/taxonomies/#configure-taxonomies" rel="external" target="_blank">custom taxonomies</a> and want to display a list of them somewhere on your page (often in the <code>layouts/partials/content-footer.html</code>) you can call a partial that does the job for you:</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"term-list.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"taxonomy"</span> <span class="s">"categories"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"layer-group"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)</span> <span class="p">}}</span></span></span></code></pre></div><h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>page</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference to the page.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>taxonomy</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>The plural name of the taxonomy to display as used in your frontmatter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>class</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Additional CSS classes set on the outermost generated HTML element.<br><br>If set to <code>tags</code> you will get the visuals for displaying the <em>tags</em> taxonomy, otherwise it will be a simple list of links as for the <em>categories</em> taxonomy.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>primary</code></td>
|
||
<td>The style scheme used if <strong>class</strong> is <code>tags</code>.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used if <strong>class</strong> is <code>tags</code>. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>An optional <a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the list.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list 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/content/index.html">Content</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/categories/taxonomy/index.html">Taxonomy</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">Chapter 3</div>
|
||
|
||
<h1 id="shortcodes">Shortcodes</h1>
|
||
|
||
<p>Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.</p>
|
||
<p>But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.</p>
|
||
<p>To avoid this limitations, Hugo created <a href="https://gohugo.io/extras/shortcodes/" rel="external" target="_blank">shortcodes</a>. A shortcode is a simple snippet inside a page.</p>
|
||
<p>The Relearn theme provides multiple shortcodes on top of existing ones.</p>
|
||
|
||
<div class="children children-h2 children-sort-">
|
||
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/badge/index.html">Badge</a></h2><p>Marker badges to display in your text</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/button/index.html">Button</a></h2><p>Clickable buttons</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/children/index.html">Children</a></h2><p>List the child pages of a page</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/expand/index.html">Expand</a></h2><p>Expandable/collapsible sections of text</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/highlight/index.html">Highlight</a></h2><p>Render code with a syntax highlighter</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/icon/index.html">Icon</a></h2><p>Nice icons for your page</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/include/index.html">Include</a></h2><p>Displays content from other files</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/math/index.html">Math</a></h2><p>Beautiful math and chemical formulae</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/mermaid/index.html">Mermaid</a></h2><p>Generate diagrams and flowcharts from text</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/notice/index.html">Notice</a></h2><p>Disclaimers to help you structure your page</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/openapi/index.html">OpenAPI</a></h2><p>UI for your OpenAPI / Swagger specifications</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/resources/index.html">Resources</a></h2><p>List resources contained in a page bundle</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/siteparam/index.html">SiteParam</a></h2><p>Get value of site params</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/tab/index.html">Tab</a></h2><p>Show content in a single tab</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/tabs/index.html">Tabs</a></h2><p>Show content in tabbed views</p>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Shortcodes</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="badge">Badge</h1>
|
||
|
||
<p>The <code>badge</code> shortcode displays little markers in your text with adjustable color, title and icon.</p>
|
||
<p><span class="badge cstyle default"><span class="badge-content">Important</span></span>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content">Captain</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Info</span><span class="badge-content">New</span></span>
|
||
<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;">Awesome</span></span></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Important</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">New</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Important"</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 class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"primary"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Version"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"6.6.6"</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 class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"red"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"angle-double-up"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Captain"</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 class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"info"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"New"</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 class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"color"</span> <span class="s">"fuchsia"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"fab fa-hackerrank"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Awesome"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>default</code></td>
|
||
<td>The style scheme used for the badge.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text for the badge title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text for the badge.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="style">Style</h3>
|
||
<h4 id="by-severity">By Severity</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">New</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"note"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Change</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Optional</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Breaking</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Info</span><span class="badge-content">New</span></span>
|
||
<span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i> Note</span><span class="badge-content">Change</span></span>
|
||
<span class="badge cstyle tip badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i> Tip</span><span class="badge-content">Optional</span></span>
|
||
<span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</span><span class="badge-content">Breaking</span></span></p>
|
||
<h4 id="by-brand-colors">By Brand Colors</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Mandatory</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"secondary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Optional</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"accent"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Special</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Mandatory</span></span>
|
||
<span class="badge cstyle secondary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Optional</span></span>
|
||
<span class="badge cstyle accent badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Special</span></span></p>
|
||
<h4 id="by-color">By Color</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Blue</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"green"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Green</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"grey"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Grey</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Orange</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Red</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle blue badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Blue</span></span>
|
||
<span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Green</span></span>
|
||
<span class="badge cstyle grey badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Grey</span></span>
|
||
<span class="badge cstyle orange badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Orange</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Red</span></span></p>
|
||
<h4 id="by-special-color">By Special Color</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Default</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"transparent"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Transparent</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Default</span></span>
|
||
<span class="badge cstyle transparent badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Transparent</span></span></p>
|
||
<h3 id="variants">Variants</h3>
|
||
<h4 id="without-icon-and-title-text">Without Icon and Title Text</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">" "</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default"><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info"><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red"><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="without-icon">Without Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title">Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title">Info</span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title">Rank</span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="without-title-text">Without Title Text</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"star"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-star"></i></span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i></span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="all-set">All Set</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"star"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-star"></i> Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Info</span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="override-for-severity">Override for Severity</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"rocket"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Feature"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-rocket"></i> Feature</span><span class="badge-content">Awesome</span></span>
|
||
<h3 id="other">Other</h3>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title-and-content">With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"**Font**"</span> <span class="o">%</span><span class="p">}}</span><span class="o">**</span><span class="nx">Awesome</span><span class="o">**</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i> <strong>Font</strong></span><span class="badge-content" style="background-color: fuchsia;"><strong>Awesome</strong></span></span>
|
||
<h4 id="with-icon-content">With Icon Content</h4>
|
||
<p>You can combine the badge with the <a href="/hugo-theme-relearn/shortcodes/icon/index.html"><code>icon</code> shortcode</a> to create even more stunning visuals.</p>
|
||
<p>In this case you need to declare <code>{{< badge >}}</code> instead of <code>{{% badge %}}</code>. Note, that in this case it is not possible to put markdown in the content.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span></span></span></code></pre></div><p><span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span></p>
|
||
<h4 id="inside-of-text">Inside of Text</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">ipsum</span> <span class="nx">dolor</span> <span class="nx">sit</span> <span class="nx">amet</span><span class="p">,</span> <span class="nx">graecis</span> <span class="nx">denique</span> <span class="nx">ei</span> <span class="nx">vel</span><span class="p">,</span> <span class="nx">at</span> <span class="nx">duo</span> <span class="nx">primis</span> <span class="nx">mandamus</span><span class="p">.</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"rocket"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Et</span> <span class="nx">legere</span> <span class="nx">ocurreret</span> <span class="nx">pri</span><span class="p">,</span> <span class="nx">animal</span> <span class="nx">tacimates</span> <span class="nx">complectitur</span> <span class="nx">ad</span> <span class="nx">cum</span><span class="p">.</span> <span class="nx">Cu</span> <span class="nx">eum</span> <span class="nx">inermis</span> <span class="nx">inimicus</span> <span class="nx">efficiendi</span><span class="p">.</span> <span class="nx">Labore</span> <span class="nx">officiis</span> <span class="nx">his</span> <span class="nx">ex</span><span class="p">,</span> <span class="nx">soluta</span> <span class="nx">officiis</span> <span class="nx">concludaturque</span> <span class="nx">ei</span> <span class="nx">qui</span><span class="p">,</span> <span class="nx">vide</span> <span class="nx">sensibus</span> <span class="nx">vim</span> <span class="nx">ad</span><span class="p">.</span></span></span></code></pre></div><p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. <span class="badge cstyle blue badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-rocket"></i></span><span class="badge-content">Awesome</span></span> Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="button">Button</h1>
|
||
|
||
<p>The <code>button</code> shortcode displays a clickable button with adjustable color, title and icon.</p>
|
||
<p><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive warning"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-dragon"></i> <span class="title">Get Hugo</span></a></span></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"dragon"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/button.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"href"</span> <span class="s">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Get Hugo"</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 class="nx">partial</span> <span class="s">"shortcodes/button.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"href"</span> <span class="s">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"warning"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"dragon"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Get Hugo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Once the button is clicked, it opens another browser tab for the given URL.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>href</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.<br><br>- if starting with <code>javascript:</code> all following text will be executed in your browser<br>- every other string will be interpreted as URL</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>transparent</code></td>
|
||
<td>The style scheme used for the button.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>iconposition</strong></td>
|
||
<td><code>left</code></td>
|
||
<td>Places the icon to the <code>left</code> or <code>right</code> of the title.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>target</strong></td>
|
||
<td>see notes</td>
|
||
<td>The destination frame/window if <strong>href</strong> is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:<br><br>- the setting of <code>externalLinkTarget</code> or <code>_blank</code> if not set, for any address starting with <code>http://</code> or <code>https://</code><br>- no specific value for all other links</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>type</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type" rel="external" target="_blank">button type</a> if <strong>href</strong> is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to <code>button</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text for the button title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="style">Style</h3>
|
||
<h4 id="by-severity">By Severity</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"note"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="btn cstyle interactive info"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-info-circle"></i> <span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive note"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-exclamation-circle"></i> <span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive tip"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-lightbulb"></i> <span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive warning"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-exclamation-triangle"></i> <span class="title">Get Hugo</span></a></span></p>
|
||
<h4 id="by-brand-colors">By Brand Colors</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"secondary"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"accent"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="btn cstyle interactive primary"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive secondary"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive accent"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span></p>
|
||
<h4 id="by-color">By Color</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"green"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"grey"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="btn cstyle interactive blue"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive green"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive grey"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive orange"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive red"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span></p>
|
||
<h4 id="by-special-color">By Special Color</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"transparent"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="btn cstyle interactive default"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span>
|
||
<span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span></a></span></p>
|
||
<h3 id="icon">Icon</h3>
|
||
<h4 id="empty">Empty</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"></a></span>
|
||
<h4 id="only">Only</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"download"</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-download"></i></a></span>
|
||
<h4 id="to-the-left">To the Left</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"download"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-download"></i> <span class="title">Get Hugo</span></a></span>
|
||
<h4 id="to-the-right">To the Right</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"download"</span> <span class="nx">iconposition</span><span class="p">=</span><span class="s">"right"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo</span> <i class="fa-fw fas fa-download"></i></a></span>
|
||
<h4 id="override-for-severity">Override for Severity</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"dragon"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive warning"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-dragon"></i> <span class="title">Get Hugo</span></a></span>
|
||
<h3 id="target">Target</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">target</span><span class="p">=</span><span class="s">"_self"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span> <span class="nx">in</span> <span class="nx">same</span> <span class="nx">window</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span> <span class="nx">in</span> <span class="nx">new</span> <span class="nx">Window</span><span class="o">/</span><span class="nf">Frame</span> <span class="p">(</span><span class="k">default</span><span class="p">){{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_self"><span class="title">Get Hugo in same Window/Frame</span></a></span>
|
||
<span class="btn cstyle interactive transparent"><a href="https://gohugo.io/" target="_blank"><span class="title">Get Hugo in new Window/Frame (default)</span></a></span></p>
|
||
<h3 id="other">Other</h3>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">With User-Defined Color, Font Awesome Brand Icon and Markdown Title</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="o">**</span><span class="nx">Hugo</span><span class="o">**</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive default" style="--VARIABLE-BOX-color: fuchsia;"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fab fa-hackerrank"></i> <span class="title">Get <strong>Hugo</strong></span></a></span>
|
||
<h4 id="severity-style-with-all-defaults">Severity Style with All Defaults</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive tip"><a href="https://gohugo.io/" target="_blank"><i class="fa-fw fas fa-lightbulb"></i> <span class="title">Tip</span></a></span>
|
||
<h4 id="button-to-internal-page">Button to Internal Page</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"/index.html"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Home</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive transparent"><a href="/index.html"><span class="title">Home</span></a></span>
|
||
<h4 id="button-with-javascript-action">Button with JavaScript Action</h4>
|
||
<p>If your JavaScript action does not change the focus afterwards, make sure to call <code>this.blur()</code> in the end to unselect the button.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">href</span><span class="p">=</span><span class="s">"javascript:alert('Hello world!');this.blur();"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Shout</span> <span class="nx">it</span> <span class="nx">out</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="btn cstyle interactive primary"><button onclick="alert('Hello world!');this.blur();" type="button"><i class="fa-fw fas fa-bullhorn"></i> <span class="title">Shout it out</span></button></span>
|
||
<h4 id="button-within-a-form-element">Button within a <code>form</code> Element</h4>
|
||
<p>To use native HTML elements in your Markdown, add this in your <code>hugo.toml</code></p>
|
||
<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">markup</span><span class="p">.</span><span class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div><div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">form</span> <span class="na">action</span><span class="o">=</span><span class="s">"../../search.html"</span> <span class="na">method</span><span class="o">=</span><span class="s">"get"</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">input</span> <span class="na">name</span><span class="o">=</span><span class="s">"search-by-detail"</span> <span class="na">class</span><span class="o">=</span><span class="s">"search-by"</span> <span class="na">type</span><span class="o">=</span><span class="s">"search"</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> {{% button type="submit" style="secondary" icon="search" %}}Search{{% /button %}}
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">form</span><span class="p">></span></span></span></code></pre></div><form action="../../search.html" method="get">
|
||
<div class="searchform" style="width: 20vw;">
|
||
<input name="search-by-detail" class="search-by" type="search" placeholder="Search...">
|
||
<span class="btn cstyle interactive secondary"><button onclick="" type="submit"><i class="fa-fw fas fa-search"></i> <span class="title">Search</span></button></span>
|
||
</div>
|
||
</form>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="children">Children</h1>
|
||
|
||
<p>The <code>children</code> shortcode lists the child pages of the current page and its descendants.</p>
|
||
|
||
<ul class="children children-li children-sort-weight">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a></li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"weight"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/children.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"sort"</span> <span class="s">"weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>containerstyle</strong></td>
|
||
<td><code>ul</code></td>
|
||
<td>Choose the style used to group all children. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>li</code></td>
|
||
<td>Choose the style used to display each descendant. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>showhidden</strong></td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code>, child pages hidden from the menu will be displayed as well.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>description</strong></td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - <a href="https://gohugo.io/content/summaries/" rel="external" target="_blank">read more info about summaries on gohugo.io</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>depth</strong></td>
|
||
<td><code>1</code></td>
|
||
<td>The depth of descendants to display. For example, if the value is <code>2</code>, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. <code>999</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>sort</strong></td>
|
||
<td><code>auto</code></td>
|
||
<td>The sort criteria of the displayed list.<br><br>- <code>auto</code> defaults to <a href="/hugo-theme-relearn/cont/frontmatter/index.html"><code>ordersectionsby</code> of the pages frontmatter</a><br> or to <a href="/hugo-theme-relearn/basics/configuration/index.html"><code>ordersectionsby</code> of the site configuration</a><br> or to <code>weight</code><br>- <code>weight</code><br>- <code>title</code><br>- <code>linktitle</code><br>- <code>modifieddate</code><br>- <code>expirydate</code><br>- <code>publishdate</code><br>- <code>date</code><br>- <code>length</code><br>- <code>default</code> adhering to Hugo’s default sort criteria</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="all-default">All Default</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a></li>
|
||
</ul>
|
||
<h3 id="with-description">With Description</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">description</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a><p>This is a plain page test, and the beginning of a YAML multiline description...
|
||
</p></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a><p>This is a demo child page</p></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a><p>This is a demo child page with no description.
|
||
So its content is used as description.</p></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a><p>This is a demo child page</p></li>
|
||
</ul>
|
||
<h3 id="infinite-depth-and-hidden-pages">Infinite Depth and Hidden Pages</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"999"</span> <span class="nx">showhidden</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a><ul>
|
||
</ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html">page 1-1</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 1-1-1 (hidden)</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html">page 1-1-1-1</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html">page 1-1-1-1-1 (hidden)</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html">page 1-1-1-1-1-1</a><ul>
|
||
</ul></li></ul></li></ul></li></ul></li>
|
||
<li><span>page 1-1-2 (headless)</span><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1</a><ul>
|
||
</ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2</a><ul>
|
||
</ul></li></ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a><ul>
|
||
</ul></li></ul></li></ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a><ul>
|
||
</ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a><ul>
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html">page 3-1</a><ul>
|
||
</ul></li></ul></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-4/index.html">page 4 (hidden)</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
<h3 id="heading-styles-for-container-and-elements">Heading Styles for Container and Elements</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"h2"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="nx">description</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="children children-h2 children-sort-">
|
||
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a></h2><p>This is a plain page test, and the beginning of a YAML multiline description...
|
||
</p>
|
||
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a></h2><p>This is a demo child page</p>
|
||
|
||
<h3><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></h3><p>This is a demo child page</p>
|
||
|
||
<h4><span>page 1-1-2 (headless)</span></h4><p>This is a demo child page</p>
|
||
<h4><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></h4><p>This is a demo child page</p>
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a></h2><p>This is a demo child page with no description.
|
||
So its content is used as description.</p>
|
||
|
||
<h2><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a></h2><p>This is a demo child page</p>
|
||
|
||
<h3><a href="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html">page 3-1</a></h3><p>This is a plain page test nested in a parent</p>
|
||
|
||
</div>
|
||
<h3 id="divs-for-group-and-element-styles">Divs for Group and Element Styles</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="children children-div children-sort-">
|
||
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X</a></div>
|
||
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1</a></div>
|
||
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></div>
|
||
|
||
<div><span>page 1-1-2 (headless)</span></div>
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></div>
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2</a></div>
|
||
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3</a></div>
|
||
|
||
<div><a href="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html">page 3-1</a></div>
|
||
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Children</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-x">page X</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1">page 1</h1>
|
||
|
||
<p>This is a demo child page.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1-1">page 1-1</h1>
|
||
|
||
<p>This is a demo child page with a hidden child. You can still access the hidden child <a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">directly</a> or via the search.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 1-1-1 (hidden)</a></li>
|
||
<li><span>page 1-1-2 (headless)</span></li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1-1</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1-1-2-headless">page 1-1-2 (headless)</h1>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1-1-2 (headless)</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1-1-2-1">page 1-1-2-1</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1-1-2-2">page 1-1-2-2</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-1-1-3">page 1-1-3</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-2">page 2</h1>
|
||
|
||
<p>This is a demo child page with no description.</p>
|
||
<p>So its content is used as description.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-3">page 3</h1>
|
||
|
||
<p>This is a demo child page.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html">page 3-1</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 3</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/non-hidden/index.html">Non-Hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="page-3-1">page 3-1</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="expand">Expand</h1>
|
||
|
||
<p>The <code>expand</code> shortcode displays an expandable/collapsible section of text.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-0f9a874fa7985afcf4d3a85d41eec4d8" aria-controls="R-expandcontent-0f9a874fa7985afcf4d3a85d41eec4d8" >
|
||
<label class="expand-label" for="R-expand-0f9a874fa7985afcf4d3a85d41eec4d8" >
|
||
<i class="fa-fw fas fa-chevron-down"></i>
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-0f9a874fa7985afcf4d3a85d41eec4d8" class="expand-content">
|
||
|
||
<p>Thank you!</p>
|
||
<p>That’s some text with a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
||
<p>That’s some more text with a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>And that’s the footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anything of interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/expand.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Expand me..."</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Thank you!"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>1</td>
|
||
<td><code>"Expand me..."</code></td>
|
||
<td>Arbitrary text to appear next to the expand/collapse icon.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>open</strong></td>
|
||
<td>2</td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> the content text will be initially shown as expanded.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text to be displayed on expand.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="all-defaults">All Defaults</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Yes</span><span class="p">,</span> <span class="nx">you</span> <span class="nx">did</span> <span class="nx">it</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-c97c85f987391974b5a7141fb18b8669" aria-controls="R-expandcontent-c97c85f987391974b5a7141fb18b8669" >
|
||
<label class="expand-label" for="R-expand-c97c85f987391974b5a7141fb18b8669" >
|
||
<i class="fa-fw fas fa-chevron-down"></i>
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-c97c85f987391974b5a7141fb18b8669" class="expand-content">
|
||
<p>
|
||
Yes, you did it!</div>
|
||
</div>
|
||
<h3 id="initially-expanded">Initially Expanded</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="nx">open</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">No</span> <span class="nx">need</span> <span class="nx">to</span> <span class="nx">press</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-5fcef3f2354a31324f6a62d14c3446f8" aria-controls="R-expandcontent-5fcef3f2354a31324f6a62d14c3446f8" checked>
|
||
<label class="expand-label" for="R-expand-5fcef3f2354a31324f6a62d14c3446f8" >
|
||
<i class="fa-fw fas fa-chevron-down"></i>
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-5fcef3f2354a31324f6a62d14c3446f8" class="expand-content">
|
||
<p>
|
||
No need to press you!</div>
|
||
</div>
|
||
<h3 id="arbitrary-text">Arbitrary Text</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Show me almost **endless** possibilities"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</span><span class="p">:</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">and</span> <span class="nx">even</span> <span class="o">**</span><span class="nx">_bold</span> <span class="nx">emphasized_</span><span class="o">**</span> <span class="nx">text</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
|
||
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-02afe7a027359d256b02be3b45486b65" aria-controls="R-expandcontent-02afe7a027359d256b02be3b45486b65" >
|
||
<label class="expand-label" for="R-expand-02afe7a027359d256b02be3b45486b65" >
|
||
<i class="fa-fw fas fa-chevron-down"></i>
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
Show me almost <strong>endless</strong> possibilities
|
||
</label>
|
||
<div id="R-expandcontent-02afe7a027359d256b02be3b45486b65" class="expand-content">
|
||
|
||
<p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" rel="external" target="_blank">links</a></li>
|
||
<li>etc.</li>
|
||
</ul>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code</span></span></code></pre></div><blockquote>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="highlight">Highlight</h1>
|
||
|
||
<p>The <code>highlight</code> shortcode renders your code with a syntax highlighter.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="78b1a500dbf7f0594db3c0b708df1ae3">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('78b1a500dbf7f0594db3c0b708df1ae3','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="highlight wrap-code" lineNos="true"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="ln">1</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>This shortcode is fully compatible with Hugo’s <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode" rel="external" target="_blank"><code>highlight</code> shortcode</a> but <strong>offers some extensions</strong>.</p>
|
||
<p>It is called interchangeably in the same way as Hugo’s own shortcode providing positional parameter or by simply using codefences.</p>
|
||
<p>You are free to also call this shortcode from your own partials. In this case it resembles Hugo’s <a href="https://gohugo.io/functions/highlight/" rel="external" target="_blank"><code>highlight</code> function</a> syntax if you call this shortcode as a partial using compatibility syntax.</p>
|
||
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial-compat"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial-compat')"
|
||
>
|
||
<span class="tab-nav-text">partial (compat)</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
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-md" data-lang="md"><span class="line"><span class="cl">```py { lineNos="true" wrap="true" title="python" }
|
||
</span></span><span class="line"><span class="cl">print("Hello World!")
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">lineNos</span><span class="p">=</span><span class="s">"true"</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"python"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">py</span> <span class="s">"lineNos=true,wrap=true,title=python"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/highlight.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"print(\"Hello World!\")"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"lineNos"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"type"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"wrap"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"python"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial-compat"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/highlight.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"print(\"Hello World!\")"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"options"</span> <span class="s">"lineNos=true,wrap=true,title=python"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"type"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>type</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>The language of the code to highlight. Choose from one of the <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" rel="external" target="_blank">supported languages</a>. Case-insensitive.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td><strong>Extension</strong>. Arbitrary title for code. This displays the code like a <a href="/hugo-theme-relearn/shortcodes/tab/index.html">single tab</a> if <code>hl_inline=false</code> (which is Hugo’s default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>wrap</strong></td>
|
||
<td></td>
|
||
<td>see notes</td>
|
||
<td><strong>Extension</strong>. When <code>true</code> the content may wrap on long lines otherwise it will be scrollable.<br><br>The default value can be set in your <code>hugo.toml</code> and overwritten via frontmatter. <a href="/hugo-theme-relearn/shortcodes/highlight/index.html#configuration">See below</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>options</strong></td>
|
||
<td>2</td>
|
||
<td><em><empty></em></td>
|
||
<td>An optional, comma-separated list of zero or more <a href="https://gohugo.io/functions/highlight/#options" rel="external" target="_blank">Hugo supported options</a> as well as extension parameter from this table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><option></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Any of <a href="https://gohugo.io/functions/highlight/#options" rel="external" target="_blank">Hugo’s supported options</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Your code to highlight.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>Default values for <a href="https://gohugo.io/functions/highlight/#options" rel="external" target="_blank">Hugo’s supported options</a> can be set via <a href="https://gohugo.io/getting-started/configuration-markup/#highlight" rel="external" target="_blank">goldmark settings</a> in your <code>hugo.toml</code></p>
|
||
<p>Default values for extension options can be set via params settings in your <code>hugo.toml</code> or be overwritten by frontmatter for each individual page.</p>
|
||
<h3 id="global-configuration-file">Global Configuration File</h3>
|
||
<p>You can configure the color style used for code blocks in your <a href="/hugo-theme-relearn/basics/branding/index.html#syntax-highlighting">color variants stylesheet</a> file.</p>
|
||
<h4 id="recommended-settings">Recommended Settings</h4>
|
||
|
||
<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">markup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lineNumbersInTable</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">noClasses</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">markup</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">highlight</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">lineNumbersInTable</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">noClasses</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span></span></span></code></pre></div></div>
|
||
</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">"markup"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"highlight"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"lineNumbersInTable"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"noClasses"</span><span class="p">:</span> <span class="kc">false</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></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="optional-settings">Optional Settings</h4>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">highlightWrap</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"highlightWrap"</span><span class="p">:</span> <span class="kc">true</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">highlightWrap</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"highlightWrap"</span><span class="p">:</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="line-numbers-with-starting-offset">Line Numbers with Starting Offset</h3>
|
||
<p>As mentioned above, line numbers in a <code>table</code> layout will shift if code is wrapping, so better use <code>inline</code>. To make things easier for you, set <code>lineNumbersInTable = false</code> in your <code>hugo.toml</code> and add <code>lineNos = true</code> when calling the shortcode instead of the specific values <code>table</code> or <code>inline</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">lineNos</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">lineNoStart</span><span class="p">=</span><span class="s">"666"</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">the</span> <span class="nx">hardest</span> <span class="nx">part</span> <span class="nx">is</span> <span class="nx">to</span> <span class="nx">start</span> <span class="nx">writing</span> <span class="nx">code</span><span class="p">;</span> <span class="nx">here</span><span class="err">'</span><span class="nx">s</span> <span class="nx">a</span> <span class="nx">kickstart</span><span class="p">;</span> <span class="nx">just</span> <span class="nx">copy</span> <span class="nx">and</span> <span class="nx">paste</span> <span class="nx">this</span><span class="p">;</span> <span class="nx">it</span><span class="err">'</span><span class="nx">s</span> <span class="nx">free</span><span class="p">;</span> <span class="nx">the</span> <span class="nx">next</span> <span class="nx">lines</span> <span class="nx">will</span> <span class="nx">cost</span> <span class="nx">you</span> <span class="nx">serious</span> <span class="nx">credits</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">" "</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"World"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="highlight wrap-code" lineNoStart="666" lineNos="true"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="ln">666</span><span class="cl"><span class="c1"># the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits</span>
|
||
</span></span><span class="line"><span class="ln">667</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">668</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">" "</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">669</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"World"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">670</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"!"</span><span class="p">)</span></span></span></code></pre></div>
|
||
<h3 id="codefence-with-title">Codefence with Title</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```py { title="python" }
|
||
</span></span><span class="line"><span class="cl"><span class="gh"># a bit shorter
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>print("Hello World!")
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="cbec875146b45e1a3d6a2122f6019ed6">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('cbec875146b45e1a3d6a2122f6019ed6','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
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-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># a bit shorter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h3 id="with-wrap">With Wrap</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">hl_lines</span><span class="p">=</span><span class="s">"2"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Quicksort</span> <span class="nx">Python</span> <span class="nx">One</span><span class="o">-</span><span class="nx">liner</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lambda</span> <span class="nx">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="nx">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">for</span> <span class="nx">x</span> <span class="nx">in</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="p"><</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">for</span> <span class="nx">x</span> <span class="nx">in</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="o">>=</span><span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Some</span> <span class="nx">more</span> <span class="nx">stuff</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="highlight wrap-code" hl_lines="2"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># Quicksort Python One-liner</span>
|
||
</span></span><span class="line hl"><span class="cl"><span class="k">lambda</span> <span class="n">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="n">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o"><</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o">>=</span><span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c1"># Some more stuff</span></span></span></code></pre></div>
|
||
<h3 id="without-wrap">Without Wrap</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"false"</span> <span class="nx">hl_lines</span><span class="p">=</span><span class="s">"2"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Quicksort</span> <span class="nx">Python</span> <span class="nx">One</span><span class="o">-</span><span class="nx">liner</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lambda</span> <span class="nx">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="nx">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">for</span> <span class="nx">x</span> <span class="nx">in</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="p"><</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">for</span> <span class="nx">x</span> <span class="nx">in</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="o">>=</span><span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Some</span> <span class="nx">more</span> <span class="nx">stuff</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># Quicksort Python One-liner</span>
|
||
</span></span><span class="line hl"><span class="cl"><span class="k">lambda</span> <span class="n">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="n">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o"><</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o">>=</span><span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c1"># Some more stuff</span></span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="icon">Icon</h1>
|
||
|
||
<p>The <code>icon</code> shortcode displays icons using the <a href="https://fontawesome.com" rel="external" target="_blank">Font Awesome</a> library.</p>
|
||
<p><i class="fa-fw fas fa-exclamation-triangle"></i>
|
||
<i class="fa-fw fas fa-angle-double-up"></i>
|
||
<i class="fa-fw fas fa-skull-crossbones"></i></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"exclamation-triangle"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">exclamation</span><span class="o">-</span><span class="nx">triangle</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">angle</span><span class="o">-</span><span class="nx">double</span><span class="o">-</span><span class="nx">up</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"exclamation-triangle"</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 class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"angle-double-up"</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 class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"skull-crossbones"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> to be displayed. It will be displayed in the text color of its according context.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="finding-an-icon">Finding an icon</h3>
|
||
<p>Browse through the available icons in the <a href="https://fontawesome.com/v6/search?m=free" rel="external" target="_blank">Font Awesome Gallery</a>. Notice that the <strong>free</strong> filter is enabled, as only the free icons are available by default.</p>
|
||
<p>Once on the Font Awesome page for a specific icon, for example the page for the <a href="https://fontawesome.com/v6/icons/heart?s=solid" rel="external" target="_blank">heart</a>, copy the icon name and paste into the Markdown content.</p>
|
||
<h3 id="customising-icons">Customising Icons</h3>
|
||
<p>Font Awesome provides many ways to modify the icon</p>
|
||
<ul>
|
||
<li>Change color (by default the icon will inherit the parent color)</li>
|
||
<li>Increase or decrease size</li>
|
||
<li>Rotate</li>
|
||
<li>Combine with other icons</li>
|
||
</ul>
|
||
<p>Check the full documentation on <a href="https://fontawesome.com/how-to-use/web-fonts-with-css" rel="external" target="_blank">web fonts with CSS</a> for more.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="standard-usage">Standard Usage</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Built</span> <span class="nx">with</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">heart</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">by</span> <span class="nx">Relearn</span> <span class="nx">and</span> <span class="nx">Hugo</span></span></span></code></pre></div><p>Built with <i class="fa-fw fas fa-heart"></i> by Relearn and Hugo</p>
|
||
<h3 id="advanced-html-usage">Advanced HTML Usage</h3>
|
||
<p>While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the <code><i></code> HTML into markup, and Font Awesome will load the relevant icon.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Built with <span class="p"><</span><span class="nt">i</span> <span class="na">class</span><span class="o">=</span><span class="s">"fas fa-heart"</span><span class="p">></</span><span class="nt">i</span><span class="p">></span> by Relearn and Hugo</span></span></code></pre></div><p>Built with <i class="fas fa-heart"></i> by Relearn and Hugo</p>
|
||
<p>To use these native HTML elements in your Markdown, add this in your <code>hugo.toml</code>:</p>
|
||
<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">markup</span><span class="p">.</span><span class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="include">Include</h1>
|
||
|
||
<p>The <code>include</code> shortcode includes other files from your project inside of the current page.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="nx">file</span><span class="p">=</span><span class="s">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="s">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/include .html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"file"</span> <span class="s">"shortcodes/INCLUDE_ME.md"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The included files can even contain Markdown and will be taken into account when generating the table of contents.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>file</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>The path to the file to be included. Path resolution adheres to <a href="https://gohugo.io/functions/readfile/" rel="external" target="_blank">Hugo’s build-in <code>readFile</code> function</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>hidefirstheading</strong></td>
|
||
<td>2</td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="arbitrary-content">Arbitrary Content</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="s">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" rel="external" target="_blank">links</a></li>
|
||
<li>etc.<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></li>
|
||
</ul>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code</span></span></code></pre></div><blockquote>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="math">Math</h1>
|
||
|
||
<p>The <code>math</code> shortcode generates beautiful formatted math and chemical formulae using the <a href="https://mathjax.org/" rel="external" target="_blank">MathJax</a> library.</p>
|
||
|
||
<span class="math align-center">
|
||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.</p>
|
||
<p>You are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
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-md" data-lang="md"><span class="line"><span class="cl">```math { align="center" }
|
||
</span></span><span class="line"><span class="cl">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">math</span> <span class="nx">align</span><span class="p">=</span><span class="s">"center"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">$$\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span> <span class="nx">b_k</span> <span class="err">\</span><span class="nx">right</span><span class="p">)^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">leq</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">b_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span><span class="err">$$</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">math</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/math.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"$$left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>align</strong></td>
|
||
<td><code>center</code></td>
|
||
<td>Allowed values are <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Your formulae.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files through a JSON object in your <code>hugo.toml</code> or override these settings per page through your pages frontmatter.</p>
|
||
<p>The JSON object of your <code>hugo.toml</code> / frontmatter is forwarded into MathJax’s configuration object.</p>
|
||
<p>See <a href="https://docs.mathjax.org/en/latest/options/index.html" rel="external" target="_blank">MathJax documentation</a> for all allowed settings.</p>
|
||
<h3 id="global-configuration-file">Global Configuration File</h3>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s1">'{ "chtml": { "displayAlign": "left" } }'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mathJaxInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "chtml": { "displayAlign": "left" } }'</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mathJaxInitialize"</span><span class="p">:</span> <span class="s2">"{ \"chtml\": { \"displayAlign\": \"left\" } }"</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s1">'{ "chtml": { "displayAlign": "left" } }'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mathJaxInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "chtml": { "displayAlign": "left" } }'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"mathJaxInitialize"</span><span class="p">:</span> <span class="s2">"{ \"chtml\": { \"displayAlign\": \"left\" } }"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="inline-math">Inline Math</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Inline math is generated if you use a single <span class="sb">`$`</span> as a delimiter around your formulae: {{<span class="p"><</span> <span class="nt">math</span> <span class="p">></span>}}$\sqrt{3}${{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div><p>Inline math is generated if you use a single <code>$</code> as a delimiter around your formulae:
|
||
<span class="math align-center">$\sqrt{3}$</span></p>
|
||
<h3 id="blocklevel-math-with-right-alignment">Blocklevel Math with Right Alignment</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">If you delimit your formulae by two consecutive <span class="sb">`$$`</span> it generates a new block.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="nt">math</span> <span class="na">align</span><span class="o">=</span><span class="s">"right"</span> <span class="p">></span>}}
|
||
</span></span><span class="line"><span class="cl">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div><p>If you delimit your formulae by two consecutive <code>$$</code> it generates a new block.</p>
|
||
|
||
<span class="math align-right">
|
||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span>
|
||
<h3 id="codefence">Codefence</h3>
|
||
<p>You can also use codefences.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```math
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"></span>$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
||
<span class="math align-center">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$</span><h3 id="chemical-formulae">Chemical Formulae</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">{{<span class="p"><</span> <span class="nt">math</span> <span class="p">></span>}}
|
||
</span></span><span class="line"><span class="cl">$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div>
|
||
<span class="math align-center">
|
||
$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
|
||
</span>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="mermaid">Mermaid</h1>
|
||
|
||
<p>The <code>mermaid</code> shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the <a href="https://mermaidjs.github.io/" rel="external" target="_blank">Mermaid</a> library.</p>
|
||
|
||
<pre class="mermaid align-center zoomable">
|
||
graph LR;
|
||
If --> Then
|
||
Then --> Else
|
||
</pre>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.</p>
|
||
<p>You are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
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-md" data-lang="md"><span class="line"><span class="cl">```mermaid { align="center" zoom="true" }
|
||
</span></span><span class="line"><span class="cl">graph LR;
|
||
</span></span><span class="line"><span class="cl"> If --> Then
|
||
</span></span><span class="line"><span class="cl"> Then --> Else
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">"center"</span> <span class="nx">zoom</span><span class="p">=</span><span class="s">"true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">If</span> <span class="o">--</span><span class="p">></span> <span class="nx">Then</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Then</span> <span class="o">--</span><span class="p">></span> <span class="nx">Else</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/mermaid.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"graph LR;\nIf --> Then\nThen --> Else"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"zoom"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The generated graphs can be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>align</strong></td>
|
||
<td><code>center</code></td>
|
||
<td>Allowed values are <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>zoom</strong></td>
|
||
<td>see notes</td>
|
||
<td>Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the <code>mermaidZoom</code> setting of the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#global-configuration-file">site</a> or the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#pages-frontmatter">pages frontmatter</a> or <code>false</code> if not set at all.<br><br>- <code>false</code>: no pan or zoom<br>- <code>true</code>: pan and zoom active</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Your Mermaid graph.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files through a JSON object in your <code>hugo.toml</code>, override these settings per page through your pages frontmatter or override these setting per diagramm through <a href="https://mermaid-js.github.io/mermaid/#/directives?id=directives" rel="external" target="_blank">diagram directives</a>.</p>
|
||
<p>The JSON object of your <code>hugo.toml</code> / frontmatter is forwarded into Mermaid’s <code>mermaid.initialize()</code> function.</p>
|
||
<p>See <a href="https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" rel="external" target="_blank">Mermaid documentation</a> for all allowed settings.</p>
|
||
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>hugo.toml</code>, frontmatter or diagram directives.</p>
|
||
<h3 id="global-configuration-file">Global Configuration File</h3>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s1">'{ "theme": "dark" }'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mermaidInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "theme": "dark" }'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mermaidZoom</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidInitialize"</span><span class="p">:</span> <span class="s2">"{ \"theme\": \"dark\" }"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidZoom"</span><span class="p">:</span> <span class="kc">true</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></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
|
||
<div class="tab-panel" data-tab-group="config-code">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</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="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s1">'{ "theme": "dark" }'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</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="nn">---</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mermaidInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "theme": "dark" }'</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">mermaidZoom</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nn">---</span></span></span></code></pre></div></div>
|
||
</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">"mermaidInitialize"</span><span class="p">:</span> <span class="s2">"{ \"theme\": \"dark\" }"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidZoom"</span><span class="p">:</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="flowchart-with-yaml-title">Flowchart with YAML-Title</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">---</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span><span class="p">:</span> <span class="nx">Example</span> <span class="nx">Diagram</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">---</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">A</span><span class="p">[</span><span class="nx">Hard</span> <span class="nx">edge</span><span class="p">]</span> <span class="o">--</span><span class="p">>|</span><span class="nx">Link</span> <span class="nx">text</span><span class="p">|</span> <span class="nf">B</span><span class="p">(</span><span class="nx">Round</span> <span class="nx">edge</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">B</span> <span class="o">--</span><span class="p">></span> <span class="nx">C</span><span class="p">{<</span><span class="nx">strong</span><span class="p">></span><span class="nx">Decision</span><span class="p"><</span><span class="o">/</span><span class="nx">strong</span><span class="p">>}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">C</span> <span class="o">--</span><span class="p">>|</span><span class="nx">One</span><span class="p">|</span> <span class="nx">D</span><span class="p">[</span><span class="nx">Result</span> <span class="nx">one</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">C</span> <span class="o">--</span><span class="p">>|</span><span class="nx">Two</span><span class="p">|</span> <span class="nx">E</span><span class="p">[</span><span class="nx">Result</span> <span class="nx">two</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
---
|
||
title: Example Diagram
|
||
---
|
||
graph LR;
|
||
A[Hard edge] -->|Link text| B(Round edge)
|
||
B --> C{<strong>Decision</strong>}
|
||
C -->|One| D[Result one]
|
||
C -->|Two| E[Result two]
|
||
</pre>
|
||
<h3 id="sequence-diagram-with-configuration-directive">Sequence Diagram with Configuration Directive</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">%%</span><span class="p">{</span><span class="nx">init</span><span class="p">:{</span><span class="s">"fontFamily"</span><span class="p">:</span><span class="s">"monospace"</span><span class="p">,</span> <span class="s">"sequence"</span><span class="p">:{</span><span class="s">"showSequenceNumbers"</span><span class="p">:</span><span class="kc">true</span><span class="p">}}}</span><span class="o">%%</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">sequenceDiagram</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Alice</span><span class="o">->></span><span class="nx">John</span><span class="p">:</span> <span class="nx">Hello</span> <span class="nx">John</span><span class="p">,</span> <span class="nx">how</span> <span class="nx">are</span> <span class="nx">you</span><span class="err">?</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">loop</span> <span class="nx">Healthcheck</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">->></span><span class="nx">John</span><span class="p">:</span> <span class="nx">Fight</span> <span class="nx">against</span> <span class="nx">hypochondria</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">end</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Note</span> <span class="nx">right</span> <span class="nx">of</span> <span class="nx">John</span><span class="p">:</span> <span class="nx">Rational</span> <span class="nx">thoughts</span><span class="p">!</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">-->></span><span class="nx">Alice</span><span class="p">:</span> <span class="nx">Great</span><span class="p">!</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">->></span><span class="nx">Bob</span><span class="p">:</span> <span class="nx">How</span> <span class="nx">about</span> <span class="nx">you</span><span class="err">?</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Bob</span><span class="o">-->></span><span class="nx">John</span><span class="p">:</span> <span class="nx">Jolly</span> <span class="nx">good</span><span class="p">!</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
|
||
sequenceDiagram
|
||
Alice->>John: Hello John, how are you?
|
||
loop Healthcheck
|
||
John->>John: Fight against hypochondria
|
||
end
|
||
Note right of John: Rational thoughts!
|
||
John-->>Alice: Great!
|
||
John->>Bob: How about you?
|
||
Bob-->>John: Jolly good!
|
||
</pre>
|
||
<h3 id="class-diagram-with-codefence-syntax">Class Diagram with Codefence Syntax</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">```mermaid
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">classDiagram
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Duck
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Fish
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Zebra
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal : +int age
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal : +String gender
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal: +isMammal()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal: +mate()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Duck{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +String beakColor
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +swim()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +quack()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> }
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Fish{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> -int sizeInFeet
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> -canEat()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> }
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Zebra{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +bool is_wild
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +run()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> }
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">classDiagram
|
||
Animal <|-- Duck
|
||
Animal <|-- Fish
|
||
Animal <|-- Zebra
|
||
Animal : +int age
|
||
Animal : +String gender
|
||
Animal: +isMammal()
|
||
Animal: +mate()
|
||
class Duck{
|
||
+String beakColor
|
||
+swim()
|
||
+quack()
|
||
}
|
||
class Fish{
|
||
-int sizeInFeet
|
||
-canEat()
|
||
}
|
||
class Zebra{
|
||
+bool is_wild
|
||
+run()
|
||
}</pre><h3 id="state-diagram-aligned-to-the-right">State Diagram Aligned to the Right</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">"right"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">stateDiagram</span><span class="o">-</span><span class="nx">v2</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Closed</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Locked</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">open</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Close</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Lock</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Unlock</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-right zoomable">
|
||
stateDiagram-v2
|
||
open: Open Door
|
||
closed: Closed Door
|
||
locked: Locked Door
|
||
open --> closed: Close
|
||
closed --> locked: Lock
|
||
locked --> closed: Unlock
|
||
closed --> open: Open
|
||
</pre>
|
||
<h3 id="entity-relationship-model-with-non-default-mermaid-theme">Entity Relationship Model with Non-Default Mermaid Theme</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">%%</span><span class="p">{</span><span class="nx">init</span><span class="p">:{</span><span class="s">"theme"</span><span class="p">:</span><span class="s">"forest"</span><span class="p">}}</span><span class="o">%%</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">erDiagram</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="p">}|..|{</span> <span class="nx">DELIVERY</span><span class="o">-</span><span class="nx">ADDRESS</span> <span class="p">:</span> <span class="nx">has</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">places</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">INVOICE</span> <span class="p">:</span> <span class="s">"liable for"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">DELIVERY</span><span class="o">-</span><span class="nx">ADDRESS</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">receives</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">INVOICE</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">covers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ORDER</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">ORDER</span><span class="o">-</span><span class="nx">ITEM</span> <span class="p">:</span> <span class="nx">includes</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">PRODUCT</span><span class="o">-</span><span class="nx">CATEGORY</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">PRODUCT</span> <span class="p">:</span> <span class="nx">contains</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">PRODUCT</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span><span class="o">-</span><span class="nx">ITEM</span> <span class="p">:</span> <span class="s">"ordered in"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
%%{init:{"theme":"forest"}}%%
|
||
erDiagram
|
||
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
||
CUSTOMER ||--o{ ORDER : places
|
||
CUSTOMER ||--o{ INVOICE : "liable for"
|
||
DELIVERY-ADDRESS ||--o{ ORDER : receives
|
||
INVOICE ||--|{ ORDER : covers
|
||
ORDER ||--|{ ORDER-ITEM : includes
|
||
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
|
||
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
||
</pre>
|
||
<h3 id="user-journey">User Journey</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">journey</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">My</span> <span class="nx">working</span> <span class="nx">day</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Go</span> <span class="nx">to</span> <span class="nx">work</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Make</span> <span class="nx">tea</span><span class="p">:</span> <span class="mi">5</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Go</span> <span class="nx">upstairs</span><span class="p">:</span> <span class="mi">3</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Do</span> <span class="nx">work</span><span class="p">:</span> <span class="mi">1</span><span class="p">:</span> <span class="nx">Me</span><span class="p">,</span> <span class="nx">Cat</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Go</span> <span class="nx">home</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Go</span> <span class="nx">downstairs</span><span class="p">:</span> <span class="mi">5</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Sit</span> <span class="nx">down</span><span class="p">:</span> <span class="mi">3</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
journey
|
||
title My working day
|
||
section Go to work
|
||
Make tea: 5: Me
|
||
Go upstairs: 3: Me
|
||
Do work: 1: Me, Cat
|
||
section Go home
|
||
Go downstairs: 5: Me
|
||
Sit down: 3: Me
|
||
</pre>
|
||
<h3 id="gantt-chart">GANTT Chart</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">gantt</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">dateFormat</span> <span class="nx">YYYY</span><span class="o">-</span><span class="nx">MM</span><span class="o">-</span><span class="nx">DD</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">Adding</span> <span class="nx">GANTT</span> <span class="nx">diagram</span> <span class="nx">functionality</span> <span class="nx">to</span> <span class="nx">Mermaid</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">A</span> <span class="nx">section</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Completed</span> <span class="nx">task</span> <span class="p">:</span><span class="nx">done</span><span class="p">,</span> <span class="nx">des1</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mo">06</span><span class="p">,</span><span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mi">08</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Active</span> <span class="nx">task</span> <span class="p">:</span><span class="nx">active</span><span class="p">,</span> <span class="nx">des2</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mi">09</span><span class="p">,</span> <span class="mi">3</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task</span> <span class="p">:</span> <span class="nx">des3</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des2</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task2</span> <span class="p">:</span> <span class="nx">des4</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des3</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Critical</span> <span class="nx">tasks</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Completed</span> <span class="nx">task</span> <span class="nx">in</span> <span class="nx">the</span> <span class="nx">critical</span> <span class="nx">line</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">done</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mo">06</span><span class="p">,</span><span class="mi">24</span><span class="nx">h</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Implement</span> <span class="nx">parser</span> <span class="nx">and</span> <span class="nx">jison</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">done</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des1</span><span class="p">,</span> <span class="mi">2</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Create</span> <span class="nx">tests</span> <span class="k">for</span> <span class="nx">parser</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">active</span><span class="p">,</span> <span class="mi">3</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task</span> <span class="nx">in</span> <span class="nx">critical</span> <span class="nx">line</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Create</span> <span class="nx">tests</span> <span class="k">for</span> <span class="nx">renderer</span> <span class="p">:</span><span class="mi">2</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Add</span> <span class="nx">to</span> <span class="nx">Mermaid</span> <span class="p">:</span><span class="mi">1</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
gantt
|
||
dateFormat YYYY-MM-DD
|
||
title Adding GANTT diagram functionality to Mermaid
|
||
section A section
|
||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||
Active task :active, des2, 2014-01-09, 3d
|
||
Future task : des3, after des2, 5d
|
||
Future task2 : des4, after des3, 5d
|
||
section Critical tasks
|
||
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||
Implement parser and jison :crit, done, after des1, 2d
|
||
Create tests for parser :crit, active, 3d
|
||
Future task in critical line :crit, 5d
|
||
Create tests for renderer :2d
|
||
Add to Mermaid :1d
|
||
</pre>
|
||
<h3 id="pie-chart-without-zoom">Pie Chart without Zoom</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="nx">zoom</span><span class="p">=</span><span class="s">"false"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pie</span> <span class="nx">title</span> <span class="nx">Pets</span> <span class="nx">adopted</span> <span class="nx">by</span> <span class="nx">volunteers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Dogs"</span> <span class="p">:</span> <span class="mi">386</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Cats"</span> <span class="p">:</span> <span class="mi">85</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Rats"</span> <span class="p">:</span> <span class="mi">15</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center ">
|
||
pie title Pets adopted by volunteers
|
||
"Dogs" : 386
|
||
"Cats" : 85
|
||
"Rats" : 15
|
||
</pre>
|
||
<h3 id="quadrant-chart">Quadrant Chart</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pie</span> <span class="nx">title</span> <span class="nx">Pets</span> <span class="nx">adopted</span> <span class="nx">by</span> <span class="nx">volunteers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">Reach</span> <span class="nx">and</span> <span class="nx">engagement</span> <span class="nx">of</span> <span class="nx">campaigns</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">x</span><span class="o">-</span><span class="nx">axis</span> <span class="nx">Low</span> <span class="nx">Reach</span> <span class="o">--</span><span class="p">></span> <span class="nx">High</span> <span class="nx">Reach</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">y</span><span class="o">-</span><span class="nx">axis</span> <span class="nx">Low</span> <span class="nx">Engagement</span> <span class="o">--</span><span class="p">></span> <span class="nx">High</span> <span class="nx">Engagement</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">1</span> <span class="nx">We</span> <span class="nx">should</span> <span class="nx">expand</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">2</span> <span class="nx">Need</span> <span class="nx">to</span> <span class="nx">promote</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">3</span> <span class="nx">Re</span><span class="o">-</span><span class="nx">evaluate</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">4</span> <span class="nx">May</span> <span class="nx">be</span> <span class="nx">improved</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">A</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">B</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.45</span><span class="p">,</span> <span class="mf">0.23</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">C</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.57</span><span class="p">,</span> <span class="mf">0.69</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">D</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.78</span><span class="p">,</span> <span class="mf">0.34</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">E</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.40</span><span class="p">,</span> <span class="mf">0.34</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">F</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.35</span><span class="p">,</span> <span class="mf">0.78</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
quadrantChart
|
||
title Reach and engagement of campaigns
|
||
x-axis Low Reach --> High Reach
|
||
y-axis Low Engagement --> High Engagement
|
||
quadrant-1 We should expand
|
||
quadrant-2 Need to promote
|
||
quadrant-3 Re-evaluate
|
||
quadrant-4 May be improved
|
||
Campaign A: [0.3, 0.6]
|
||
Campaign B: [0.45, 0.23]
|
||
Campaign C: [0.57, 0.69]
|
||
Campaign D: [0.78, 0.34]
|
||
Campaign E: [0.40, 0.34]
|
||
Campaign F: [0.35, 0.78]
|
||
</pre>
|
||
<h3 id="requirement-diagram">Requirement Diagram</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">requirementDiagram</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">requirement</span> <span class="nx">test_req</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">id</span><span class="p">:</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">text</span><span class="p">:</span> <span class="nx">the</span> <span class="nx">test</span> <span class="nx">text</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">risk</span><span class="p">:</span> <span class="nx">high</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">verifymethod</span><span class="p">:</span> <span class="nx">test</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">element</span> <span class="nx">test_entity</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="kd">type</span><span class="p">:</span> <span class="nx">simulation</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">test_entity</span> <span class="o">-</span> <span class="nx">satisfies</span> <span class="o">-</span><span class="p">></span> <span class="nx">test_req</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
requirementDiagram
|
||
|
||
requirement test_req {
|
||
id: 1
|
||
text: the test text.
|
||
risk: high
|
||
verifymethod: test
|
||
}
|
||
|
||
element test_entity {
|
||
type: simulation
|
||
}
|
||
|
||
test_entity - satisfies -> test_req
|
||
</pre>
|
||
<h3 id="git-graph">Git Graph</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">gitGraph</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">branch</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">checkout</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">checkout</span> <span class="nx">main</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">merge</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
gitGraph
|
||
commit
|
||
commit
|
||
branch develop
|
||
checkout develop
|
||
commit
|
||
commit
|
||
checkout main
|
||
merge develop
|
||
commit
|
||
commit
|
||
</pre>
|
||
<h3 id="c4-diagrams">C4 Diagrams</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">C4Context</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">System</span> <span class="nx">Context</span> <span class="nx">diagram</span> <span class="k">for</span> <span class="nx">Internet</span> <span class="nx">Banking</span> <span class="nx">System</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Enterprise_Boundary</span><span class="p">(</span><span class="nx">b0</span><span class="p">,</span> <span class="s">"BankBoundary0"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="s">"Banking Customer A"</span><span class="p">,</span> <span class="s">"A customer of the bank, with personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerB</span><span class="p">,</span> <span class="s">"Banking Customer B"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person_Ext</span><span class="p">(</span><span class="nx">customerC</span><span class="p">,</span> <span class="s">"Banking Customer C"</span><span class="p">,</span> <span class="s">"desc"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerD</span><span class="p">,</span> <span class="s">"Banking Customer D"</span><span class="p">,</span> <span class="s">"A customer of the bank, <br/> with personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="s">"Internet Banking System"</span><span class="p">,</span> <span class="s">"Allows customers to view information about their bank accounts, and make payments."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Enterprise_Boundary</span><span class="p">(</span><span class="nx">b1</span><span class="p">,</span> <span class="s">"BankBoundary"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemDb_Ext</span><span class="p">(</span><span class="nx">SystemE</span><span class="p">,</span> <span class="s">"Mainframe Banking System"</span><span class="p">,</span> <span class="s">"Stores all of the core banking information about customers, accounts, transactions, etc."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System_Boundary</span><span class="p">(</span><span class="nx">b2</span><span class="p">,</span> <span class="s">"BankBoundary2"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemA</span><span class="p">,</span> <span class="s">"Banking System A"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemB</span><span class="p">,</span> <span class="s">"Banking System B"</span><span class="p">,</span> <span class="s">"A system of the bank, with personal bank accounts. next line."</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></span><span class="line"><span class="cl"> <span class="nf">System_Ext</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="s">"E-mail system"</span><span class="p">,</span> <span class="s">"The internal Microsoft Exchange e-mail system."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemDb</span><span class="p">(</span><span class="nx">SystemD</span><span class="p">,</span> <span class="s">"Banking System D Database"</span><span class="p">,</span> <span class="s">"A system of the bank, with personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Boundary</span><span class="p">(</span><span class="nx">b3</span><span class="p">,</span> <span class="s">"BankBoundary3"</span><span class="p">,</span> <span class="s">"boundary"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemQueue</span><span class="p">(</span><span class="nx">SystemF</span><span class="p">,</span> <span class="s">"Banking System F Queue"</span><span class="p">,</span> <span class="s">"A system of the bank."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemQueue_Ext</span><span class="p">(</span><span class="nx">SystemG</span><span class="p">,</span> <span class="s">"Banking System G Queue"</span><span class="p">,</span> <span class="s">"A system of the bank, with personal bank accounts."</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="p">}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">BiRel</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="nx">SystemAA</span><span class="p">,</span> <span class="s">"Uses"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">BiRel</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemE</span><span class="p">,</span> <span class="s">"Uses"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Rel</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemC</span><span class="p">,</span> <span class="s">"Sends e-mails"</span><span class="p">,</span> <span class="s">"SMTP"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Rel</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="nx">customerA</span><span class="p">,</span> <span class="s">"Sends e-mails to"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateElementStyle</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="err">$</span><span class="nx">fontColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">bgColor</span><span class="p">=</span><span class="s">"grey"</span><span class="p">,</span> <span class="err">$</span><span class="nx">borderColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="nx">SystemAA</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"5"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemE</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"-10"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemC</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"-40"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"-50"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="nx">customerA</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"-50"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"20"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateLayoutConfig</span><span class="p">(</span><span class="err">$</span><span class="nx">c4ShapeInRow</span><span class="p">=</span><span class="s">"3"</span><span class="p">,</span> <span class="err">$</span><span class="nx">c4BoundaryInRow</span><span class="p">=</span><span class="s">"1"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
C4Context
|
||
title System Context diagram for Internet Banking System
|
||
Enterprise_Boundary(b0, "BankBoundary0") {
|
||
Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
|
||
Person(customerB, "Banking Customer B")
|
||
Person_Ext(customerC, "Banking Customer C", "desc")
|
||
|
||
Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
|
||
|
||
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
|
||
|
||
Enterprise_Boundary(b1, "BankBoundary") {
|
||
|
||
SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
|
||
|
||
System_Boundary(b2, "BankBoundary2") {
|
||
System(SystemA, "Banking System A")
|
||
System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
|
||
}
|
||
|
||
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
|
||
SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
|
||
|
||
Boundary(b3, "BankBoundary3", "boundary") {
|
||
SystemQueue(SystemF, "Banking System F Queue", "A system of the bank.")
|
||
SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
|
||
}
|
||
}
|
||
}
|
||
|
||
BiRel(customerA, SystemAA, "Uses")
|
||
BiRel(SystemAA, SystemE, "Uses")
|
||
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
|
||
Rel(SystemC, customerA, "Sends e-mails to")
|
||
|
||
UpdateElementStyle(customerA, $fontColor="red", $bgColor="grey", $borderColor="red")
|
||
UpdateRelStyle(customerA, SystemAA, $textColor="blue", $lineColor="blue", $offsetX="5")
|
||
UpdateRelStyle(SystemAA, SystemE, $textColor="blue", $lineColor="blue", $offsetY="-10")
|
||
UpdateRelStyle(SystemAA, SystemC, $textColor="blue", $lineColor="blue", $offsetY="-40", $offsetX="-50")
|
||
UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
|
||
|
||
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
|
||
</pre>
|
||
<h3 id="mindmaps">Mindmaps</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mindmap</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">root</span><span class="p">((</span><span class="nx">mindmap</span><span class="p">))</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Origins</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Long</span> <span class="nx">history</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">::</span><span class="nf">icon</span><span class="p">(</span><span class="nx">fa</span> <span class="nx">fa</span><span class="o">-</span><span class="nx">book</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Popularisation</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">British</span> <span class="nx">popular</span> <span class="nx">psychology</span> <span class="nx">author</span> <span class="nx">Tony</span> <span class="nx">Buzan</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Research</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">On</span> <span class="nx">effectiveness</span><span class="p"><</span><span class="nx">br</span><span class="o">/</span><span class="p">></span><span class="nx">and</span> <span class="nx">features</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">On</span> <span class="nx">Automatic</span> <span class="nx">creation</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Uses</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Creative</span> <span class="nx">techniques</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Strategic</span> <span class="nx">planning</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Argument</span> <span class="nx">mapping</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Tools</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Pen</span> <span class="nx">and</span> <span class="nx">paper</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Mermaid</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
mindmap
|
||
root((mindmap))
|
||
Origins
|
||
Long history
|
||
::icon(fa fa-book)
|
||
Popularisation
|
||
British popular psychology author Tony Buzan
|
||
Research
|
||
On effectiveness<br/>and features
|
||
On Automatic creation
|
||
Uses
|
||
Creative techniques
|
||
Strategic planning
|
||
Argument mapping
|
||
Tools
|
||
Pen and paper
|
||
Mermaid
|
||
</pre>
|
||
<h3 id="timeline">Timeline</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">timeline</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">History</span> <span class="nx">of</span> <span class="nx">Social</span> <span class="nx">Media</span> <span class="nx">Platform</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2002</span> <span class="p">:</span> <span class="nx">LinkedIn</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2004</span> <span class="p">:</span> <span class="nx">Facebook</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">:</span> <span class="nx">Google</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2005</span> <span class="p">:</span> <span class="nx">Youtube</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2006</span> <span class="p">:</span> <span class="nx">Twitter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
timeline
|
||
title History of Social Media Platform
|
||
2002 : LinkedIn
|
||
2004 : Facebook
|
||
: Google
|
||
2005 : Youtube
|
||
2006 : Twitter
|
||
</pre>
|
||
<h3 id="sankey">Sankey</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">sankey</span><span class="o">-</span><span class="nx">beta</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="o">%%</span> <span class="nx">source</span><span class="p">,</span><span class="nx">target</span><span class="p">,</span><span class="nx">value</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">Over</span> <span class="nx">generation</span> <span class="o">/</span> <span class="nx">exports</span><span class="p">,</span><span class="mf">104.453</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">Heating</span> <span class="nx">and</span> <span class="nx">cooling</span> <span class="o">-</span> <span class="nx">homes</span><span class="p">,</span><span class="mf">113.726</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">H2</span> <span class="nx">conversion</span><span class="p">,</span><span class="mf">27.14</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
sankey-beta
|
||
|
||
%% source,target,value
|
||
Electricity grid,Over generation / exports,104.453
|
||
Electricity grid,Heating and cooling - homes,113.726
|
||
Electricity grid,H2 conversion,27.14
|
||
</pre>
|
||
<h3 id="xychart">XYChart</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">xychart</span><span class="o">-</span><span class="nx">beta</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="s">"Sales Revenue"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">x</span><span class="o">-</span><span class="nx">axis</span> <span class="p">[</span><span class="nx">jan</span><span class="p">,</span> <span class="nx">feb</span><span class="p">,</span> <span class="nx">mar</span><span class="p">,</span> <span class="nx">apr</span><span class="p">,</span> <span class="nx">may</span><span class="p">,</span> <span class="nx">jun</span><span class="p">,</span> <span class="nx">jul</span><span class="p">,</span> <span class="nx">aug</span><span class="p">,</span> <span class="nx">sep</span><span class="p">,</span> <span class="nx">oct</span><span class="p">,</span> <span class="nx">nov</span><span class="p">,</span> <span class="nx">dec</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">y</span><span class="o">-</span><span class="nx">axis</span> <span class="s">"Revenue (in $)"</span> <span class="mi">4000</span> <span class="o">--</span><span class="p">></span> <span class="mi">11000</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">bar</span> <span class="p">[</span><span class="mi">5000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">,</span> <span class="mi">7500</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="mi">9500</span><span class="p">,</span> <span class="mi">10500</span><span class="p">,</span> <span class="mi">11000</span><span class="p">,</span> <span class="mi">10200</span><span class="p">,</span> <span class="mi">9200</span><span class="p">,</span> <span class="mi">8500</span><span class="p">,</span> <span class="mi">7000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">line</span> <span class="p">[</span><span class="mi">5000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">,</span> <span class="mi">7500</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="mi">9500</span><span class="p">,</span> <span class="mi">10500</span><span class="p">,</span> <span class="mi">11000</span><span class="p">,</span> <span class="mi">10200</span><span class="p">,</span> <span class="mi">9200</span><span class="p">,</span> <span class="mi">8500</span><span class="p">,</span> <span class="mi">7000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
xychart-beta
|
||
title "Sales Revenue"
|
||
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
|
||
y-axis "Revenue (in $)" 4000 --> 11000
|
||
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
||
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
||
</pre>
|
||
<h3 id="block-diagram">Block Diagram</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">block</span><span class="o">-</span><span class="nx">beta</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">columns</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">db</span><span class="p">((</span><span class="s">"DB"</span><span class="p">))</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">blockArrowId6</span><span class="p"><[</span><span class="s">"&nbsp;&nbsp;&nbsp;"</span><span class="p">]>(</span><span class="nx">down</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">block</span><span class="p">:</span><span class="nx">ID</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">A</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">B</span><span class="p">[</span><span class="s">"A wide one in the middle"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">C</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">end</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">space</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">D</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ID</span> <span class="o">--</span><span class="p">></span> <span class="nx">D</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">C</span> <span class="o">--</span><span class="p">></span> <span class="nx">D</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">style</span> <span class="nx">B</span> <span class="nx">fill</span><span class="p">:</span><span class="err">#</span><span class="mi">969</span><span class="p">,</span><span class="nx">stroke</span><span class="p">:</span><span class="err">#</span><span class="mi">333</span><span class="p">,</span><span class="nx">stroke</span><span class="o">-</span><span class="nx">width</span><span class="p">:</span><span class="mi">4</span><span class="nx">px</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">
|
||
block-beta
|
||
columns 1
|
||
db(("DB"))
|
||
blockArrowId6<["&nbsp;&nbsp;&nbsp;"]>(down)
|
||
block:ID
|
||
A
|
||
B["A wide one in the middle"]
|
||
C
|
||
end
|
||
space
|
||
D
|
||
ID --> D
|
||
C --> D
|
||
style B fill:#969,stroke:#333,stroke-width:4px
|
||
</pre>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="notice">Notice</h1>
|
||
|
||
<p>The <code>notice</code> shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.</p>
|
||
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> There may be pirates</div>
|
||
<div class="box-content">
|
||
|
||
<p>It is all about the boxes.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"There may be pirates"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">It</span> <span class="nx">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</span> <span class="nx">boxes</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">primary</span> <span class="s">"There may be pirates"</span> <span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">It</span> <span class="nx">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</span> <span class="nx">boxes</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/notice.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"primary"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"There may be pirates"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"skull-crossbones"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"It is all about the boxes."</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td>1</td>
|
||
<td><code>default</code></td>
|
||
<td>The style scheme used for the box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>2</td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>3</td>
|
||
<td>see notes</td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text to be displayed in box.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="by-severity">By Severity</h3>
|
||
<h4 id="info-with-markup">Info with markup</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">An</span> <span class="o">**</span><span class="nx">information</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</span><span class="p">:</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">and</span> <span class="nx">even</span> <span class="o">***</span><span class="nx">bold</span> <span class="nx">emphasized</span><span class="o">***</span> <span class="nx">text</span>
|
||
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
|
||
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<div class="box-content">
|
||
|
||
<p>An <strong>information</strong> disclaimer</p>
|
||
<p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" rel="external" target="_blank">links</a></li>
|
||
<li>etc.</li>
|
||
</ul>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code</span></span></code></pre></div><blockquote>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
<h4 id="note">Note</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"note"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">notice</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<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>A <strong>notice</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="tip">Tip</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">tip</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>tip</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning">Warning</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-with-non-default-title-and-icon">Warning with Non-Default Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Here are dragons"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"dragon"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-dragon"></i> Here are dragons</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-without-a-title-and-icon">Warning without a Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="nx">icon</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-brand-colors">By Brand Colors</h3>
|
||
<h4 id="primary-with-title-only">Primary with Title only</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Primary"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">primary</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label">Primary</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>primary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="secondary-with-icon-only">Secondary with Icon only</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"secondary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"stopwatch"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">secondary</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-stopwatch"></i></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>secondary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="accent">Accent</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"accent"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">An</span> <span class="o">**</span><span class="nx">accent</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle accent">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>An <strong>accent</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-color">By Color</h3>
|
||
<h4 id="blue-without-a-title-and-icon">Blue without a Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">blue</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle blue">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>blue</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="green-with-title-only">Green with Title only</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"green"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Green"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">green</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle green">
|
||
<div class="box-label">Green</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>green</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="grey-with-icon-only">Grey with Icon only</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"grey"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bug"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">grey</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle grey">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>grey</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="orange-with-title-and-icon">Orange with Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Orange"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"bug"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">orange</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle orange">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i> Orange</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>orange</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="red-without-a-title-and-icon">Red without a Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">red</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle red">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>red</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-special-color">By Special Color</h3>
|
||
<h4 id="default-with-positional-parameter">Default with Positional Parameter</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="k">default</span> <span class="s">"Pay Attention to this Note!"</span> <span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Some</span> <span class="nx">serious</span> <span class="nx">information</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle default">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
|
||
<div class="box-content">
|
||
|
||
<p>Some serious information.</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="transparent-with-title-and-icon">Transparent with Title and Icon</h4>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"transparent"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Pay Attention to this Note!"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Some</span> <span class="nx">serious</span> <span class="nx">information</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
|
||
<div class="box-content">
|
||
|
||
<p>Some serious information.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">With User-Defined Color, Font Awesome Brand Icon and Markdown Title</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"**Hugo**"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Victor</span><span class="err">?</span> <span class="nx">Is</span> <span class="nx">it</span> <span class="nx">you</span><span class="err">?</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<div class="box-label"><i class="fa-fw fab fa-hackerrank"></i> <strong>Hugo</strong></div>
|
||
<div class="box-content">
|
||
|
||
<p>Victor? Is it you?</p>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="openapi">OpenAPI</h1>
|
||
|
||
<p>The <code>openapi</code> shortcode uses the <a href="https://github.com/swagger-api/swagger-ui" rel="external" target="_blank">Swagger UI</a> library to display your OpenAPI / Swagger specifications.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/openapi.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"src"</span> <span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>src</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>The URL to the OpenAPI specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<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>If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.</p>
|
||
<p>Instead, open the <a href="/hugo-theme-relearn/basics/customization/index.html#activate-print-support">print preview</a> in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="example">Example</h2>
|
||
<h3 id="using-local-file">Using Local File</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"petstore.json"</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<div class="sc-openapi-wrapper is-loading helper-loading-container">
|
||
<div
|
||
class="sc-openapi-container"
|
||
id="R-openapi-0edff392a828e0c40f0286187dd8f71c"
|
||
data-openapi-url="petstore.json"
|
||
data-openapi-spec="{
|
||
"openapi": "3.0.2",
|
||
"info": {
|
||
"title": "Swagger Petstore - OpenAPI 3.0",
|
||
"description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",
|
||
"termsOfService": "http://swagger.io/terms/",
|
||
"contact": {
|
||
"email": "apiteam@swagger.io"
|
||
},
|
||
"license": {
|
||
"name": "Apache 2.0",
|
||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
||
},
|
||
"version": "1.0.18"
|
||
},
|
||
"externalDocs": {
|
||
"description": "Find out more about Swagger",
|
||
"url": "http://swagger.io"
|
||
},
|
||
"servers": [
|
||
{
|
||
"url": "/api/v3"
|
||
}
|
||
],
|
||
"tags": [
|
||
{
|
||
"name": "pet",
|
||
"description": "Everything about your Pets",
|
||
"externalDocs": {
|
||
"description": "Find out more",
|
||
"url": "http://swagger.io"
|
||
}
|
||
},
|
||
{
|
||
"name": "store",
|
||
"description": "Access to Petstore orders",
|
||
"externalDocs": {
|
||
"description": "Find out more about our store",
|
||
"url": "http://swagger.io"
|
||
}
|
||
},
|
||
{
|
||
"name": "user",
|
||
"description": "Operations about user"
|
||
}
|
||
],
|
||
"paths": {
|
||
"/pet": {
|
||
"put": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Update an existing pet",
|
||
"description": "Update an existing pet by Id",
|
||
"operationId": "updatePet",
|
||
"requestBody": {
|
||
"description": "Update an existent pet in the store",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/x-www-form-urlencoded": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
},
|
||
"required": true
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid ID supplied"
|
||
},
|
||
"404": {
|
||
"description": "Pet not found"
|
||
},
|
||
"405": {
|
||
"description": "Validation exception"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Add a new pet to the store",
|
||
"description": "Add a new pet to the store",
|
||
"operationId": "addPet",
|
||
"requestBody": {
|
||
"description": "Create a new pet in the store",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/x-www-form-urlencoded": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
},
|
||
"required": true
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"405": {
|
||
"description": "Invalid input"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/pet/findByStatus": {
|
||
"get": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Finds Pets by status",
|
||
"description": "Multiple status values can be provided with comma separated strings",
|
||
"operationId": "findPetsByStatus",
|
||
"parameters": [
|
||
{
|
||
"name": "status",
|
||
"in": "query",
|
||
"description": "Status values that need to be considered for filter",
|
||
"required": false,
|
||
"explode": true,
|
||
"schema": {
|
||
"type": "string",
|
||
"default": "available",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid status value"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/pet/findByTags": {
|
||
"get": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Finds Pets by tags",
|
||
"description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
|
||
"operationId": "findPetsByTags",
|
||
"parameters": [
|
||
{
|
||
"name": "tags",
|
||
"in": "query",
|
||
"description": "Tags to filter by",
|
||
"required": false,
|
||
"explode": true,
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid tag value"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/pet/{petId}": {
|
||
"get": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Find pet by ID",
|
||
"description": "Returns a single pet",
|
||
"operationId": "getPetById",
|
||
"parameters": [
|
||
{
|
||
"name": "petId",
|
||
"in": "path",
|
||
"description": "ID of pet to return",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid ID supplied"
|
||
},
|
||
"404": {
|
||
"description": "Pet not found"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"api_key": []
|
||
},
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Updates a pet in the store with form data",
|
||
"description": "",
|
||
"operationId": "updatePetWithForm",
|
||
"parameters": [
|
||
{
|
||
"name": "petId",
|
||
"in": "path",
|
||
"description": "ID of pet that needs to be updated",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
},
|
||
{
|
||
"name": "name",
|
||
"in": "query",
|
||
"description": "Name of pet that needs to be updated",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "status",
|
||
"in": "query",
|
||
"description": "Status of pet that needs to be updated",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"405": {
|
||
"description": "Invalid input"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "Deletes a pet",
|
||
"description": "",
|
||
"operationId": "deletePet",
|
||
"parameters": [
|
||
{
|
||
"name": "api_key",
|
||
"in": "header",
|
||
"description": "",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "petId",
|
||
"in": "path",
|
||
"description": "Pet id to delete",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"400": {
|
||
"description": "Invalid pet value"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/pet/{petId}/uploadImage": {
|
||
"post": {
|
||
"tags": [
|
||
"pet"
|
||
],
|
||
"summary": "uploads an image",
|
||
"description": "",
|
||
"operationId": "uploadFile",
|
||
"parameters": [
|
||
{
|
||
"name": "petId",
|
||
"in": "path",
|
||
"description": "ID of pet to update",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
},
|
||
{
|
||
"name": "additionalMetadata",
|
||
"in": "query",
|
||
"description": "Additional Metadata",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/octet-stream": {
|
||
"schema": {
|
||
"type": "string",
|
||
"format": "binary"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/ApiResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"petstore_auth": [
|
||
"write:pets",
|
||
"read:pets"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/store/inventory": {
|
||
"get": {
|
||
"tags": [
|
||
"store"
|
||
],
|
||
"summary": "Returns pet inventories by status",
|
||
"description": "Returns a map of status codes to quantities",
|
||
"operationId": "getInventory",
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"api_key": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/store/order": {
|
||
"post": {
|
||
"tags": [
|
||
"store"
|
||
],
|
||
"summary": "Place an order for a pet",
|
||
"description": "Place a new order in the store",
|
||
"operationId": "placeOrder",
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
},
|
||
"application/x-www-form-urlencoded": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"405": {
|
||
"description": "Invalid input"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/store/order/{orderId}": {
|
||
"get": {
|
||
"tags": [
|
||
"store"
|
||
],
|
||
"summary": "Find purchase order by ID",
|
||
"description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.",
|
||
"operationId": "getOrderById",
|
||
"parameters": [
|
||
{
|
||
"name": "orderId",
|
||
"in": "path",
|
||
"description": "ID of order that needs to be fetched",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Order"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid ID supplied"
|
||
},
|
||
"404": {
|
||
"description": "Order not found"
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"store"
|
||
],
|
||
"summary": "Delete purchase order by ID",
|
||
"description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
|
||
"operationId": "deleteOrder",
|
||
"parameters": [
|
||
{
|
||
"name": "orderId",
|
||
"in": "path",
|
||
"description": "ID of the order that needs to be deleted",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"400": {
|
||
"description": "Invalid ID supplied"
|
||
},
|
||
"404": {
|
||
"description": "Order not found"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/user": {
|
||
"post": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Create user",
|
||
"description": "This can only be done by the logged in user.",
|
||
"operationId": "createUser",
|
||
"requestBody": {
|
||
"description": "Created user object",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/x-www-form-urlencoded": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"default": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/user/createWithList": {
|
||
"post": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Creates list of users with given input array",
|
||
"description": "Creates list of users with given input array",
|
||
"operationId": "createUsersWithListInput",
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "Successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"default": {
|
||
"description": "successful operation"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/user/login": {
|
||
"get": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Logs user into the system",
|
||
"description": "",
|
||
"operationId": "loginUser",
|
||
"parameters": [
|
||
{
|
||
"name": "username",
|
||
"in": "query",
|
||
"description": "The user name for login",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "password",
|
||
"in": "query",
|
||
"description": "The password for login in clear text",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"headers": {
|
||
"X-Rate-Limit": {
|
||
"description": "calls per hour allowed by the user",
|
||
"schema": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
}
|
||
},
|
||
"X-Expires-After": {
|
||
"description": "date in UTC when token expires",
|
||
"schema": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
}
|
||
}
|
||
},
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid username/password supplied"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/user/logout": {
|
||
"get": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Logs out current logged in user session",
|
||
"description": "",
|
||
"operationId": "logoutUser",
|
||
"parameters": [],
|
||
"responses": {
|
||
"default": {
|
||
"description": "successful operation"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/user/{username}": {
|
||
"get": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Get user by user name",
|
||
"description": "",
|
||
"operationId": "getUserByName",
|
||
"parameters": [
|
||
{
|
||
"name": "username",
|
||
"in": "path",
|
||
"description": "The name that needs to be fetched. Use user1 for testing. ",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "successful operation",
|
||
"content": {
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid username supplied"
|
||
},
|
||
"404": {
|
||
"description": "User not found"
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Update user",
|
||
"description": "This can only be done by the logged in user.",
|
||
"operationId": "updateUser",
|
||
"parameters": [
|
||
{
|
||
"name": "username",
|
||
"in": "path",
|
||
"description": "name that needs to be updated",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"description": "Update an existent user in the store",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
},
|
||
"application/x-www-form-urlencoded": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"default": {
|
||
"description": "successful operation"
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"user"
|
||
],
|
||
"summary": "Delete user",
|
||
"description": "This can only be done by the logged in user.",
|
||
"operationId": "deleteUser",
|
||
"parameters": [
|
||
{
|
||
"name": "username",
|
||
"in": "path",
|
||
"description": "The name that needs to be deleted",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"400": {
|
||
"description": "Invalid username supplied"
|
||
},
|
||
"404": {
|
||
"description": "User not found"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"components": {
|
||
"schemas": {
|
||
"Order": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"petId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"quantity": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"shipDate": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"complete": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"petId": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 198772
|
||
},
|
||
"quantity": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"example": 7
|
||
},
|
||
"shipDate": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "Order Status",
|
||
"example": "approved",
|
||
"enum": [
|
||
"placed",
|
||
"approved",
|
||
"delivered"
|
||
]
|
||
},
|
||
"complete": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "order"
|
||
}
|
||
},
|
||
"Customer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 100000
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "fehguy"
|
||
},
|
||
"address": {
|
||
"type": "array",
|
||
"xml": {
|
||
"name": "addresses",
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Address"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "customer"
|
||
}
|
||
},
|
||
"username": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 100000
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "fehguy"
|
||
},
|
||
"address": {
|
||
"type": "array",
|
||
"xml": {
|
||
"name": "addresses",
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Address"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "customer"
|
||
}
|
||
},
|
||
"address": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 100000
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "fehguy"
|
||
},
|
||
"address": {
|
||
"type": "array",
|
||
"xml": {
|
||
"name": "addresses",
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Address"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "customer"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "customer"
|
||
}
|
||
},
|
||
"Address": {
|
||
"type": "object",
|
||
"properties": {
|
||
"street": {
|
||
"type": "object",
|
||
"properties": {
|
||
"street": {
|
||
"type": "string",
|
||
"example": "437 Lytton"
|
||
},
|
||
"city": {
|
||
"type": "string",
|
||
"example": "Palo Alto"
|
||
},
|
||
"state": {
|
||
"type": "string",
|
||
"example": "CA"
|
||
},
|
||
"zip": {
|
||
"type": "string",
|
||
"example": "94301"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "address"
|
||
}
|
||
},
|
||
"city": {
|
||
"type": "object",
|
||
"properties": {
|
||
"street": {
|
||
"type": "string",
|
||
"example": "437 Lytton"
|
||
},
|
||
"city": {
|
||
"type": "string",
|
||
"example": "Palo Alto"
|
||
},
|
||
"state": {
|
||
"type": "string",
|
||
"example": "CA"
|
||
},
|
||
"zip": {
|
||
"type": "string",
|
||
"example": "94301"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "address"
|
||
}
|
||
},
|
||
"state": {
|
||
"type": "object",
|
||
"properties": {
|
||
"street": {
|
||
"type": "string",
|
||
"example": "437 Lytton"
|
||
},
|
||
"city": {
|
||
"type": "string",
|
||
"example": "Palo Alto"
|
||
},
|
||
"state": {
|
||
"type": "string",
|
||
"example": "CA"
|
||
},
|
||
"zip": {
|
||
"type": "string",
|
||
"example": "94301"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "address"
|
||
}
|
||
},
|
||
"zip": {
|
||
"type": "object",
|
||
"properties": {
|
||
"street": {
|
||
"type": "string",
|
||
"example": "437 Lytton"
|
||
},
|
||
"city": {
|
||
"type": "string",
|
||
"example": "Palo Alto"
|
||
},
|
||
"state": {
|
||
"type": "string",
|
||
"example": "CA"
|
||
},
|
||
"zip": {
|
||
"type": "string",
|
||
"example": "94301"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "address"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "address"
|
||
}
|
||
},
|
||
"Category": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "Dogs"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "category"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "Dogs"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "category"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "category"
|
||
}
|
||
},
|
||
"User": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"username": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"firstName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"lastName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"email": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"password": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"phone": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"userStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "theUser"
|
||
},
|
||
"firstName": {
|
||
"type": "string",
|
||
"example": "John"
|
||
},
|
||
"lastName": {
|
||
"type": "string",
|
||
"example": "James"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"example": "john@email.com"
|
||
},
|
||
"password": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "12345"
|
||
},
|
||
"userStatus": {
|
||
"type": "integer",
|
||
"description": "User Status",
|
||
"format": "int32",
|
||
"example": 1
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "user"
|
||
}
|
||
},
|
||
"Tag": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "tag"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "tag"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "tag"
|
||
}
|
||
},
|
||
"Pet": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"name": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"category": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"photoUrls": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"tags": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"status": {
|
||
"required": [
|
||
"name",
|
||
"photoUrls"
|
||
],
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"format": "int64",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "doggie"
|
||
},
|
||
"category": {
|
||
"$ref": "#/components/schemas/Category"
|
||
},
|
||
"photoUrls": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"type": "string",
|
||
"xml": {
|
||
"name": "photoUrl"
|
||
}
|
||
}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"xml": {
|
||
"wrapped": true
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/Tag"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "pet status in the store",
|
||
"enum": [
|
||
"available",
|
||
"pending",
|
||
"sold"
|
||
]
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "pet"
|
||
}
|
||
},
|
||
"ApiResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "##default"
|
||
}
|
||
},
|
||
"type": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "##default"
|
||
}
|
||
},
|
||
"message": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "##default"
|
||
}
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "##default"
|
||
}
|
||
}
|
||
},
|
||
"requestBodies": {
|
||
"Pet": {
|
||
"description": "Pet object that needs to be added to the store",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
},
|
||
"application/xml": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Pet"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"UserArray": {
|
||
"description": "List of user object",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/User"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"securitySchemes": {
|
||
"petstore_auth": {
|
||
"type": "oauth2",
|
||
"flows": {
|
||
"implicit": {
|
||
"authorizationUrl": "https://petstore3.swagger.io/oauth/authorize",
|
||
"scopes": {
|
||
"write:pets": "modify pets in your account",
|
||
"read:pets": "read your pets"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"api_key": {
|
||
"type": "apiKey",
|
||
"name": "api_key",
|
||
"in": "header"
|
||
}
|
||
}
|
||
}
|
||
}"
|
||
></div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="resources">Resources</h1>
|
||
|
||
<p>The <code>resources</code> shortcode displays the <a href="https://gohugo.io/methods/resource/title/" rel="external" target="_blank">titles</a> of resources contained in a <a href="https://gohugo.io/content-management/page-bundles/" rel="external" target="_blank">page bundle</a>.</p>
|
||
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li>
|
||
</ul>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"asc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/resources.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"sort"</span> <span class="s">"asc"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Multilanguage features are not supported directly by the shortcode but rely on Hugo’s handling for resource translations applied when the theme iterates over all available resources.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>transparent</code></td>
|
||
<td>The style scheme used for the box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <code>Resources</code><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <code>paperclip</code><br><br>If you want no icon, you have to set this parameter to <code>" "</code> (a non empty d with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>sort</strong></td>
|
||
<td><code>asc</code></td>
|
||
<td>Sorting the output in <code>asc</code>ending or <code>desc</code>ending order.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>pattern</strong></td>
|
||
<td><code>.*</code></td>
|
||
<td>A <a href="https://en.wikipedia.org/wiki/Regular_expression" rel="external" target="_blank">regular expressions</a>, used to filter the resources <a href="https://gohugo.io/methods/resource/name/" rel="external" target="_blank">by name</a>. For example:<br><br>- to match a file suffix of ‘jpg’, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- to match file names ending in <code>jpg</code> or <code>png</code>, use <code>.*\.(jpg|png)</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="custom-title-list-of-resources-ending-in-png-jpg-or-gif">Custom Title, List of Resources Ending in png, jpg or gif</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Related **files**"</span> <span class="nx">pattern</span><span class="p">=</span><span class="s">".*\.(png|jpg|gif)"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related <strong>files</strong></div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="info-styled-box-descending-sort-order">Info Styled Box, Descending Sort Order</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"desc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box attachments cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="with-user-defined-color-and-font-awesome-brand-icon">With User-Defined Color and Font Awesome Brand Icon</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">resources</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fa-fw fab fa-hackerrank"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box attachments cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<div class="box-label"><i class="fa-fw fab fa-hackerrank"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/MaybeTreasure.en.txt">MaybeTreasure.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/NoTreasure.en.txt">NoTreasure.en.txt</a> (23 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/resources/Treasure.pir.txt">Treasure.pir.txt</a> (31 B)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="style-color-title-and-icons">Style, Color, Title and Icons</h3>
|
||
<p>For further examples for <strong>style</strong>, <strong>color</strong>, <strong>title</strong> and <strong>icon</strong>, see the <a href="/hugo-theme-relearn/shortcodes/notice/index.html"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="siteparam">SiteParam</h1>
|
||
|
||
<p>The <code>siteparam</code> shortcode prints values of site params.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/siteparam.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"name"</span> <span class="s">"editURL"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Position</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>name</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>The name of the site param to be displayed.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="editurl-from-hugotoml"><code>editURL</code> from <code>hugo.toml</code></h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">`editURL`</span> <span class="nx">value</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><code>editURL</code> value: <a href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/$%7BFilePath%7D" rel="external" target="_blank">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}</a></p>
|
||
<h3 id="nested-parameter-with-markdown-and-html-formatting">Nested parameter with Markdown and HTML formatting</h3>
|
||
<p>To use formatted parameter, add this in your <code>hugo.toml</code>:</p>
|
||
|
||
<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">markup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">goldmark</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">markup</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">goldmark</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">renderer</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">unsafe</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div></div>
|
||
</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">"markup"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"goldmark"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"renderer"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"unsafe"</span><span class="p">:</span> <span class="kc">true</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Now values containing Markdown will be formatted correctly.</p>
|
||
|
||
<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">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">siteparam</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">siteparam</span><span class="p">.</span><span class="nx">test</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">text</span> <span class="p">=</span> <span class="s1">'A **nested** parameter <b>with</b> formatting'</span></span></span></code></pre></div></div>
|
||
</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">params</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">siteparam</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">test</span><span class="p">:</span><span class="w">
|
||
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">text</span><span class="p">:</span><span class="w"> </span><span class="l">A **nested** parameter <b>with</b> formatting</span></span></span></code></pre></div></div>
|
||
</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">"params"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"siteparam"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"test"</span><span class="p">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"text"</span><span class="p">:</span> <span class="s2">"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting"</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>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Formatted</span> <span class="nx">parameter</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"siteparam.test.text"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p>Formatted parameter: A <strong>nested</strong> option <b>with</b> formatting</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="tab">Tab</h1>
|
||
|
||
<p>You can use a <code>tab</code> shortcode to display a single tab.</p>
|
||
<p>This is especially useful if you want to flag your code example with an explicit language.</p>
|
||
<p>If you want multiple tabs grouped together you can wrap your tabs into the <a href="/hugo-theme-relearn/shortcodes/tabs/index.html"><code>tabs</code> shortcode</a>.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="28530e0c4a501a869f10dc6f00a7fb54">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="c"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('28530e0c4a501a869f10dc6f00a7fb54','c')"
|
||
>
|
||
<span class="tab-nav-text">c</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="c"
|
||
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-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"c"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```c
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf("Hello World!");
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/tab.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"c"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```c\nprintf(\"Hello World!\")\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderString</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td>see notes</td>
|
||
<td>The style scheme used for the tab. If you don’t set a style and you display a single code block inside of the tab, its default styling will adapt to that of a <code>code</code> block. Otherwise <code>default</code> is used.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" rel="external" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary title for the tab. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text to be displayed in the tab.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="single-code-block-with-collapsed-margins">Single Code Block with Collapsed Margins</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Code"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```python
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf("Hello World!");
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="55fecf5a8f3c0d7c7d339740a97c7fbe">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="code"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('55fecf5a8f3c0d7c7d339740a97c7fbe','code')"
|
||
>
|
||
<span class="tab-nav-text">Code</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="code"
|
||
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-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="mixed-markdown-content">Mixed Markdown Content</h3>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"_**Mixed**_"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="nx">tab</span> <span class="nx">can</span> <span class="nx">not</span> <span class="nx">only</span> <span class="nx">contain</span> <span class="nx">code</span> <span class="nx">but</span> <span class="nx">arbitrary</span> <span class="nx">text</span><span class="p">.</span> <span class="nx">In</span> <span class="nx">this</span> <span class="k">case</span> <span class="nx">text</span> <span class="o">**</span><span class="nx">and</span><span class="o">**</span> <span class="nx">code</span> <span class="nx">will</span> <span class="nx">get</span> <span class="nx">a</span> <span class="nx">margin</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```python
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf("Hello World!");
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="cd197d183aa63d0546702321a436da34">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="mixed"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('cd197d183aa63d0546702321a436da34','mixed')"
|
||
>
|
||
<span class="tab-nav-text"><em><strong>Mixed</strong></em></span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="mixed"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>A tab can not only contain code but arbitrary text. In this case text <strong>and</strong> code will get a margin.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="understanding-style-and-color-behavior">Understanding <code>style</code> and <code>color</code> Behavior</h3>
|
||
<p>The <code>style</code> parameter affects how the <code>color</code> parameter is applied.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"just colored style"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">The</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">is</span> <span class="nx">set</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">color</span> <span class="nx">style</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">the</span> <span class="nx">background</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">of</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">style</span> <span class="nx">color</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="nx">in</span> <span class="nx">your</span> <span class="nx">theme</span> <span class="nx">variant</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"just color"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Only</span> <span class="nx">the</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">is</span> <span class="nx">set</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">the</span> <span class="nx">background</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">of</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">CSS</span> <span class="nx">color</span> <span class="nx">value</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"default style and color"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">The</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">affects</span> <span class="nx">how</span> <span class="nx">the</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">is</span> <span class="nx">applied</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">The</span> <span class="s">`default`</span> <span class="nx">style</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">the</span> <span class="nx">background</span> <span class="nx">to</span> <span class="nx">your</span> <span class="s">`--MAIN-BG-color`</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="k">for</span> <span class="nx">your</span> <span class="nx">theme</span> <span class="nx">variant</span> <span class="nx">resembling</span> <span class="nx">the</span> <span class="k">default</span> <span class="nx">style</span> <span class="nx">but</span> <span class="nx">with</span> <span class="nx">different</span> <span class="nx">color</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"just severity style"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">The</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">is</span> <span class="nx">set</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">severity</span> <span class="nx">style</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">the</span> <span class="nx">background</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">of</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">style</span> <span class="nx">color</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="nx">in</span> <span class="nx">your</span> <span class="nx">theme</span> <span class="nx">variant</span> <span class="nx">and</span> <span class="nx">also</span> <span class="nx">affects</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">icon</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"severity style and color"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">The</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">affects</span> <span class="nx">how</span> <span class="nx">the</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">is</span> <span class="nx">applied</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">the</span> <span class="nx">background</span> <span class="nx">to</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">of</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">CSS</span> <span class="nx">color</span> <span class="nx">value</span> <span class="nx">and</span> <span class="nx">also</span> <span class="nx">affects</span> <span class="nx">the</span> <span class="nx">chosen</span> <span class="nx">icon</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="2d450c0e04d78e561937b72debbebe18">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="just-colored-style"
|
||
class="tab-nav-button tab-panel-style cstyle blue active" tabindex="-1"
|
||
onclick="switchTab('2d450c0e04d78e561937b72debbebe18','just-colored-style')"
|
||
>
|
||
<span class="tab-nav-text">just colored style</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="just-color"
|
||
class="tab-nav-button tab-panel-style cstyle filled" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('2d450c0e04d78e561937b72debbebe18','just-color')"
|
||
>
|
||
<span class="tab-nav-text">just color</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="default-style-and-color"
|
||
class="tab-nav-button tab-panel-style cstyle default" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('2d450c0e04d78e561937b72debbebe18','default-style-and-color')"
|
||
>
|
||
<span class="tab-nav-text">default style and color</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="just-severity-stylefa-fw-fas-fa-info-circle"
|
||
class="tab-nav-button tab-panel-style cstyle info"
|
||
onclick="switchTab('2d450c0e04d78e561937b72debbebe18','just-severity-stylefa-fw-fas-fa-info-circle')"
|
||
>
|
||
<span class="tab-nav-text"><i class="fa-fw fas fa-info-circle"></i> just severity style</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="severity-style-and-colorfa-fw-fas-fa-info-circle"
|
||
class="tab-nav-button tab-panel-style cstyle info" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('2d450c0e04d78e561937b72debbebe18','severity-style-and-colorfa-fw-fas-fa-info-circle')"
|
||
>
|
||
<span class="tab-nav-text"><i class="fa-fw fas fa-info-circle"></i> severity style and color</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="just-colored-style"
|
||
class="tab-content tab-panel-style cstyle blue active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>The <code>style</code> parameter is set to a color style.</p>
|
||
<p>This will set the background to a lighter version of the chosen style color as configured in your theme variant.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="just-color"
|
||
class="tab-content tab-panel-style cstyle filled" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Only the <code>color</code> parameter is set.</p>
|
||
<p>This will set the background to a lighter version of the chosen CSS color value.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="default-style-and-color"
|
||
class="tab-content tab-panel-style cstyle default" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>The <code>style</code> parameter affects how the <code>color</code> parameter is applied.</p>
|
||
<p>The <code>default</code> style will set the background to your <code>--MAIN-BG-color</code> as configured for your theme variant resembling the default style but with different color.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="just-severity-stylefa-fw-fas-fa-info-circle"
|
||
class="tab-content tab-panel-style cstyle info">
|
||
<div class="tab-content-text">
|
||
|
||
<p>The <code>style</code> parameter is set to a severity style.</p>
|
||
<p>This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="severity-style-and-colorfa-fw-fas-fa-info-circle"
|
||
class="tab-content tab-panel-style cstyle info" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>The <code>style</code> parameter affects how the <code>color</code> parameter is applied.</p>
|
||
<p>This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
|
||
<h1 id="tabs">Tabs</h1>
|
||
|
||
<p>The <code>tabs</code> shortcode displays arbitrary content in an unlimited number of tabs.</p>
|
||
<p>This comes in handy eg. for providing code snippets for multiple languages.</p>
|
||
<p>If you just want a single tab you can instead call the <a href="/hugo-theme-relearn/shortcodes/tab/index.html"><code>tab</code> shortcode</a> standalone.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="3a8848924a74521f922b3c279d089634">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">hello.</div>
|
||
<button
|
||
data-tab-item="py"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('3a8848924a74521f922b3c279d089634','py')"
|
||
>
|
||
<span class="tab-nav-text">py</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="sh"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('3a8848924a74521f922b3c279d089634','sh')"
|
||
>
|
||
<span class="tab-nav-text">sh</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="c"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('3a8848924a74521f922b3c279d089634','c')"
|
||
>
|
||
<span class="tab-nav-text">c</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="py"
|
||
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-python" data-lang="python"><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="sh"
|
||
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-bash" data-lang="bash"><span class="line"><span class="cl"><span class="nb">echo</span> <span class="s2">"Hello World!"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="c"
|
||
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-c" data-lang="c"><span class="line"><span class="cl"><span class="nf">printf</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
<p>See the <a href="/hugo-theme-relearn/shortcodes/tab/index.html"><code>tab</code> shortcode</a> for a description of the parameter for nested tabs.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">title</span><span class="p">=</span><span class="s">"hello."</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"py"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```python
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">print("Hello World!")
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"sh"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```bash
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">echo "Hello World!"
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"c"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```c
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf"Hello World!");
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/tabs.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"hello."</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="nf">slice</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```python\nprint(\"Hello World!\")\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderString</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="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"sh"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```bash\necho \"Hello World!\"\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderString</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="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"c"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```c\nprintf(\"Hello World!\");\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderString</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="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>groupid</strong></td>
|
||
<td><em><random></em></td>
|
||
<td>Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same <strong>groupid</strong> sychronize their selected tab. The tab selection is restored automatically based on the <code>groupid</code> for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.<br><br>This sychronization applies to the whole site!</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Sets a default value for every contained tab. Can be overridden by each tab. See the <a href="/hugo-theme-relearn/shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> for possible values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Sets a default value for every contained tab. Can be overridden by each tab. See the <a href="/hugo-theme-relearn/shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> for possible values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary title written in front of the tab view.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>icon</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#finding-an-icon">Font Awesome icon name</a> set to the left of the title.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary number of tabs defined with the <code>tab</code> sub-shortcode.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="behavior-of-the-groupid">Behavior of the <code>groupid</code></h3>
|
||
<p>See what happens to the tab views while you select different tabs.</p>
|
||
<p>While pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="e3e596592e5c3406fab5433de29ed609">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="group-a-tab-view-1"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('e3e596592e5c3406fab5433de29ed609','group-a-tab-view-1')"
|
||
>
|
||
<span class="tab-nav-text">Group A, Tab View 1</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="group-a-tab-view-2"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('e3e596592e5c3406fab5433de29ed609','group-a-tab-view-2')"
|
||
>
|
||
<span class="tab-nav-text">Group A, Tab View 2</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="group-b"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('e3e596592e5c3406fab5433de29ed609','group-b')"
|
||
>
|
||
<span class="tab-nav-text">Group B</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="group-a-tab-view-1"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"a"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"json"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"_**XML**_ stuff"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```xml
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"><Hello>World</Hello>
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"text"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Hello</span> <span class="nx">World</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="group-a-tab-view-2"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"a"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"json"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"XML stuff"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```xml
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"><Hello>World</Hello>
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="group-b"
|
||
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-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"b"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"json"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"XML stuff"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```xml
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"><Hello>World</Hello>
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-a-tab-view-1">Group A, Tab View 1</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-a">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-a','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text"><em><strong>XML</strong></em> stuff</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="text"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','text')"
|
||
>
|
||
<span class="tab-nav-text">text</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="highlight wrap-code" linenos="true"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
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-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><Hello></span>World<span class="nt"></Hello></span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="text"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<pre><code>Hello World
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-a-tab-view-2">Group A, Tab View 2</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-a">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-a','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text">XML stuff</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="highlight wrap-code" linenos="true"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
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-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><Hello></span>World<span class="nt"></Hello></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-b">Group B</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-b">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-b','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-b','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text">XML stuff</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="highlight wrap-code" linenos="true"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
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-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><Hello></span>World<span class="nt"></Hello></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="nested-tab-views-and-color">Nested Tab Views and Color</h3>
|
||
<p>In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with <code>{{< tab >}}</code> instead of <code>{{% tab %}}</code>. Note, that in this case it is not possible to put markdown in the parent tab.</p>
|
||
<p>You can also set style and color parameter for all tabs and overwrite them on tab level. See the <a href="/hugo-theme-relearn/shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> for possible values.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"main"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rationale"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"thumbtack"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Text"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Simple</span> <span class="nx">text</span> <span class="nx">is</span> <span class="nx">possible</span> <span class="nx">here</span><span class="o">...</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"tabs-example-language"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"python"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Python</span> <span class="nx">is</span> <span class="o">**</span><span class="nx">super</span><span class="o">**</span> <span class="nx">easy</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="o">-</span> <span class="nx">most</span> <span class="nx">of</span> <span class="nx">the</span> <span class="nx">time</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="o">-</span> <span class="k">if</span> <span class="nx">you</span> <span class="nx">don</span><span class="err">'</span><span class="nx">t</span> <span class="nx">want</span> <span class="nx">to</span> <span class="nx">output</span> <span class="nx">unicode</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"bash"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Bash</span> <span class="nx">is</span> <span class="k">for</span> <span class="o">**</span><span class="nx">hackers</span><span class="o">**</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tab</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Code"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"darkorchid"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="o">...</span><span class="nx">but</span> <span class="nx">no</span> <span class="nx">markdown</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{<</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">"tabs-example-language"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"python"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">```python
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> print("Hello World!")
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> ```</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"bash"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">```bash
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> echo "Hello World!"
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> ```</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tab</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span></span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="main">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title"><i class="fa-fw fas fa-thumbtack"></i> Rationale</div>
|
||
<button
|
||
data-tab-item="text"
|
||
class="tab-nav-button tab-panel-style cstyle primary active" tabindex="-1"
|
||
onclick="switchTab('main','text')"
|
||
>
|
||
<span class="tab-nav-text">Text</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="code"
|
||
class="tab-nav-button tab-panel-style cstyle default" style="--VARIABLE-BOX-color: darkorchid;"
|
||
onclick="switchTab('main','code')"
|
||
>
|
||
<span class="tab-nav-text">Code</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="text"
|
||
class="tab-content tab-panel-style cstyle primary active">
|
||
<div class="tab-content-text">
|
||
<p>
|
||
|
||
Simple text is possible here...
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span class="tab-nav-text">bash</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Python is <strong>super</strong> easy.</p>
|
||
<ul>
|
||
<li>most of the time.</li>
|
||
<li>if you don’t want to output unicode</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Bash is for <strong>hackers</strong>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="code"
|
||
class="tab-content tab-panel-style cstyle default" style="--VARIABLE-BOX-color: darkorchid;">
|
||
<div class="tab-content-text">
|
||
<p>
|
||
|
||
...but no markdown
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span class="tab-nav-text">bash</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
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-python" data-lang="python"><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="bash"
|
||
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-bash" data-lang="bash"><span class="line"><span class="cl"><span class="nb">echo</span> <span class="s2">"Hello World!"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<script src="/hugo-theme-relearn/js/clipboard.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1713557921" defer></script>
|
||
<script>
|
||
function useMathJax( config ){
|
||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||
loader: {
|
||
load: ['[tex]/mhchem']
|
||
},
|
||
startup: {
|
||
elements: [
|
||
'.math'
|
||
]
|
||
},
|
||
tex: {
|
||
inlineMath: [
|
||
['$', '$'],
|
||
['\\(', '\\)']
|
||
]
|
||
},
|
||
options: {
|
||
enableMenu: false
|
||
}
|
||
}, config );
|
||
}
|
||
useMathJax( JSON.parse("{}") );
|
||
</script>
|
||
<script id="MathJax-script" async src="/hugo-theme-relearn/js/mathjax/tex-mml-chtml.js?1713557921"></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-color.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-dispatch.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-drag.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-ease.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-interpolate.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-selection.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-timer.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-transition.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/d3/d3-zoom.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/js-yaml.min.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/mermaid.min.js?1713557921" defer></script>
|
||
<script>
|
||
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
|
||
</script>
|
||
<script src="/hugo-theme-relearn/js/js-yaml.min.js?1713557921" defer></script>
|
||
<script>window.noZensmooth = true;</script>
|
||
<script src="/hugo-theme-relearn/js/swagger-ui/swagger-ui-bundle.js?1713557921" defer></script>
|
||
<script src="/hugo-theme-relearn/js/swagger-ui/swagger-ui-standalone-preset.js?1713557921" defer></script>
|
||
<script>
|
||
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1713557921", cssInProject: true, assetsBuster: 1713557921 };
|
||
</script>
|
||
<script src="/hugo-theme-relearn/js/theme.js?1713557921" defer></script>
|
||
</body>
|
||
</html>
|