<!DOCTYPE html> <html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article" data-r-output-format="print"> <head> <meta charset="utf-8"> <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0"> <meta name="generator" content="Hugo 0.145.0"> <meta name="generator" content="Relearn 7.4.1+ec1b461d3886edd1383ec154518b970e72ca3f08"> <meta name="description" content="How to display custom taxonomies on your pages"> <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="Taxonomies :: Hugo Relearn Theme"> <meta name="twitter:description" content="How to display custom taxonomies on your pages"> <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy/index.html"> <meta property="og:site_name" content="Hugo Relearn Theme"> <meta property="og:title" content="Taxonomies :: Hugo Relearn Theme"> <meta property="og:description" content="How to display custom taxonomies on your pages"> <meta property="og:locale" content="en"> <meta property="og:type" content="article"> <meta property="article:section" content="Configuration"> <meta property="article:tag" content="Taxonomy"> <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="name" content="Taxonomies :: Hugo Relearn Theme"> <meta itemprop="description" content="How to display custom taxonomies on your pages"> <meta itemprop="wordCount" content="354"> <meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="keywords" content="Taxonomy"> <title>Taxonomies :: Hugo Relearn Theme</title> <link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy/index.html" rel="alternate" hreflang="x-default"> <link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy/index.html" rel="alternate" hreflang="en"> <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/configuration/customization/taxonomy/index.html" rel="alternate" hreflang="art-x-pir"> <link href="https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy/index.html" rel="canonical" type="text/html" title="Taxonomies :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/configuration/customization/taxonomy/index.xml" rel="alternate" type="application/rss+xml" title="Taxonomies :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/images/logo.svg?1740684659" rel="icon" type="image/svg+xml"> <link href="/hugo-theme-relearn/fonts/fontawesome/css/fontawesome-all.min.css?1740684659" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/fonts/fontawesome/css/fontawesome-all.min.css?1740684659" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/perfect-scrollbar/perfect-scrollbar.min.css?1740684659" rel="stylesheet"> <link href="/hugo-theme-relearn/css/theme.min.css?1740684659" rel="stylesheet"> <link href="/hugo-theme-relearn/css/format-print.min.css?1740684659" rel="stylesheet" id="R-format-style"> <link href="/hugo-theme-relearn/css/auto-complete/auto-complete.min.css?1740684659" rel="stylesheet"> <script src="/hugo-theme-relearn/js/auto-complete/auto-complete.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/lunr/lunr.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/lunr/lunr.stemmer.support.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/lunr/lunr.multi.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/lunr/lunr.en.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/search.min.js?1740684659" defer></script> <script> window.relearn = window.relearn || {}; // configuration window.relearn.min = `.min`; window.relearn.relBasePath='..\/..\/..'; window.relearn.relBaseUri='..\/..\/..\/..'; window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn'; window.relearn.contentLangs=['en']; window.relearn.index_js_url="/hugo-theme-relearn/searchindex.en.js?1740684659"; window.relearn.disableAnchorCopy=false; window.relearn.disableAnchorScrolling=false; window.relearn.disableInlineCopyToClipboard=true; window.relearn.enableBlockCodeWrap=true; // variant stuff window.relearn.themevariants = [ 'relearn-auto', 'relearn-dark', 'relearn-light', 'relearn-bright', 'zen-auto', 'zen-dark', 'zen-light', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ]; window.relearn.customvariantname = "my-custom-variant"; window.relearn.changeVariant = function(variant) { var oldVariant = document.documentElement.dataset.rThemeVariant; window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant); document.documentElement.dataset.rThemeVariant = variant; if (oldVariant != variant) { document.dispatchEvent( new CustomEvent('themeVariantLoaded', { detail: { variant, oldVariant } }) ); } } window.relearn.markVariant = function() { var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant"); var select = document.querySelector("#R-select-variant"); if (select) { select.value = variant; } } window.relearn.initVariant = function() { var variant = window.localStorage.getItem(window.relearn.absBaseUri + "/variant") ?? ""; if( variant == window.relearn.customvariantname ){ }else if( !variant || !window.relearn.themevariants.includes(variant) ){ variant = window.relearn.themevariants[0]; window.localStorage.setItem(window.relearn.absBaseUri + "/variant", variant); } document.documentElement.dataset.rThemeVariant = variant; } window.relearn.initVariant(); window.relearn.markVariant(); // translations window.T_Copy_to_clipboard = `Copy to clipboard`; window.T_Copied_to_clipboard = `Copied to clipboard!`; window.T_Copy_link_to_clipboard = `Copy link to clipboard`; window.T_Link_copied_to_clipboard = `Copied link to clipboard!`; window.T_Reset_view = `Reset view`; window.T_View_reset = `View reset!`; window.T_No_results_found = `No results found for "{0}"`; window.T_N_results_found = `{1} results found for "{0}"`; </script> <script src="/hugo-theme-relearn/js/variant.min.js?1740684659"></script> <style> #R-body img.bg-white { background-color: white; } #R-logo { font-size: 1.875rem; margin-bottom: -.666rem; margin-top: -.666rem; max-width: 100%; width: 14.125rem; } @media only all and (max-width: 59.999rem) { #R-logo { font-size: 1.5625rem; margin-bottom: -.1875rem; margin-top: -.1875rem; } } #R-logo svg { display: inline-block; opacity: .945; vertical-align: middle; width: 29% !important; } @media only all and (max-width: 59.999rem) { #R-logo svg { width: 24.5% !important; } } #R-logo svg * { opacity: .945; } #R-logo .logo-title{ display: inline-block; text-align: left; text-wrap: wrap; overflow-wrap: break-word; vertical-align: middle; width: 4.5em; } </style> </head> <body class="mobile-support print" data-url="/hugo-theme-relearn/configuration/customization/taxonomy/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 class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table of Contents (CTRL+ALT+t)"><i class="fa-fw fas fa-list-alt"></i></button> <div class="topbar-content"> <div class="topbar-content-wrapper"> <nav class="TableOfContents"> <ul> <li><a href="#default-behavior">Default Behavior</a></li> <li><a href="#setting-up-custom-taxonomies">Setting Up Custom Taxonomies</a></li> <li><a href="#showing-custom-taxonomies">Showing Custom Taxonomies</a> <ul> <li><a href="#parameter">Parameter</a></li> </ul> </li> </ul> </nav> </div> </div> </div> </div> <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class="a11y-only"><a itemprop="item" href="/hugo-theme-relearn/index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class=""><a itemprop="item" href="/hugo-theme-relearn/configuration/index.html"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="2"> > </li> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class=""><a itemprop="item" href="/hugo-theme-relearn/configuration/customization/index.html"><span itemprop="name">Customization</span></a><meta itemprop="position" content="3"> > </li> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement" class=""><span itemprop="name">Taxonomies</span><meta itemprop="position" content="4"></li> </ol> <div class="topbar-area topbar-area-end" data-area="end"> <div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/configuration/customization/taxonomy.en.md" rel="external" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a> </div> <div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/customization/taxonomy/index.print.html" title="Print whole chapter (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a> </div> <div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/customization/outputformats/index.html" title="Output Formats (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a> </div> <div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/configuration/reference/index.html" title="Options Reference (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a> </div> <div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="More"><i class="fa-fw fas fa-ellipsis-v"></i></button> <div class="topbar-content"> <div class="topbar-content-wrapper"> <div class="topbar-area topbar-area-more" data-area="more"> </div> </div> </div> </div> </div> </div> </nav> <div id="R-main-overlay"></div> <main id="R-body-inner" class="highlightable configuration" tabindex="-1"> <div class="flex-block-wrapper"> <article class="default"> <header class="headline"> <div class="R-taxonomy taxonomy-tags 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/taxonomy/index.html">Taxonomy</a></li> </ul> </div> </header> <h1 id="taxonomies">Taxonomies</h1> <p>This page explains how to show custom taxonomies on your pages.</p> <p>For more details, check the official docs on <a href="https://gohugo.io/content-management/taxonomies/#configure-taxonomies" rel="external" target="_self">setting up custom taxonomies</a> and <a href="https://gohugo.io/content-management/taxonomies/#assign-terms-to-content" rel="external" target="_self">using them in your content</a>.</p> <h2 id="default-behavior">Default Behavior</h2> <p>The Relearn theme automatically shows Hugo’s <a href="https://gohugo.io/content-management/taxonomies/#default-taxonomies" rel="external" target="_self">default taxonomies</a> <em>tags</em> and <em>categories</em> out of the box.</p> <ul> <li>Tags appear at the top of the page in alphabetical order in form of baggage tags.</li> <li>Categories appear at the bottom of the page in alphabetical order as a list prefixed with an icon.</li> </ul> <p>Each item links to a page showing all articles with that term.</p> <h2 id="setting-up-custom-taxonomies">Setting Up Custom Taxonomies</h2> <p>To add custom taxonomies, update your <code>hugo.toml</code> file. You also have to add the default taxonomies if you want to use them.</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" dir="auto"><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">taxonomies</span><span class="p">]</span> </span></span><span class="line"><span class="cl"> <span class="nx">category</span> <span class="p">=</span> <span class="s1">'categories'</span> </span></span><span class="line"><span class="cl"> <span class="nx">mycustomtag</span> <span class="p">=</span> <span class="s1">'mycustomtags'</span> </span></span><span class="line"><span class="cl"> <span class="nx">tag</span> <span class="p">=</span> <span class="s1">'tags'</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" dir="auto"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">taxonomies</span><span class="p">:</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">category</span><span class="p">:</span><span class="w"> </span><span class="l">categories</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">mycustomtag</span><span class="p">:</span><span class="w"> </span><span class="l">mycustomtags</span><span class="w"> </span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l">tags</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" dir="auto"><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">"taxonomies"</span><span class="p">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="nt">"category"</span><span class="p">:</span> <span class="s2">"categories"</span><span class="p">,</span> </span></span><span class="line"><span class="cl"> <span class="nt">"mycustomtag"</span><span class="p">:</span> <span class="s2">"mycustomtags"</span><span class="p">,</span> </span></span><span class="line"><span class="cl"> <span class="nt">"tag"</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></code></pre></div> </div> </div> </div> </div> <h2 id="showing-custom-taxonomies">Showing Custom Taxonomies</h2> <p>To display your custom taxonomy terms, add this to your page (usually in <code>layouts/partials/content-footer.html</code>):</p> <div class="highlight wrap-code" dir="auto"><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">"mycustomtags"</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 front matter.</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>caution</code>, <code>important</code>, <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>cyan</code>, <code>green</code>, <code>grey</code>, <code>magenta</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="_self">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="R-taxonomy taxonomy-categories cstyle" title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);"> <i class="fa-fw fas fa-layer-group"></i> <ul> <li><a class="term-link" href="/hugo-theme-relearn/categories/explanation/index.html">Explanation</a></li> <li><a class="term-link" href="/hugo-theme-relearn/categories/howto/index.html">Howto</a></li> <li><a class="term-link" href="/hugo-theme-relearn/categories/reference/index.html">Reference</a></li> </ul> </div> </footer> </article> </div> </main> </div> <script src="/hugo-theme-relearn/js/clipboard/clipboard.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/perfect-scrollbar/perfect-scrollbar.min.js?1740684659" defer></script> <script src="/hugo-theme-relearn/js/theme.min.js?1740684659" defer></script> </body> </html>