2024-10-13 14:26:50 +00:00
<!DOCTYPE html>
< html lang = "en" dir = "ltr" itemscope itemtype = "http://schema.org/Article" >
< 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.135.0" >
2024-10-14 18:19:22 +00:00
< meta name = "generator" content = "Relearn 7.0.0+79aeddcea3a22e8d8b2ce9cd162adaf36653fc5f" >
2024-10-13 14:26:50 +00:00
< meta name = "description" content = "Adding Custom Output Formats" >
< 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 = "Output Formats :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "Adding Custom Output Formats" >
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/outputformats/index.html" >
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
< meta property = "og:title" content = "Output Formats :: Hugo Relearn Theme" >
< meta property = "og:description" content = "Adding Custom Output Formats" >
< meta property = "og:locale" content = "en" >
< meta property = "og:type" content = "website" >
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta itemprop = "name" content = "Output Formats :: Hugo Relearn Theme" >
< meta itemprop = "description" content = "Adding Custom Output Formats" >
< meta itemprop = "wordCount" content = "127" >
< meta itemprop = "image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta itemprop = "keywords" content = "Explanation,Howto" >
< title > Output Formats :: Hugo Relearn Theme< / title >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/outputformats/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/outputformats/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/configuration/customization/outputformats/index.html" rel = "alternate" hreflang = "art-x-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/outputformats/index.html" rel = "canonical" type = "text/html" title = "Output Formats :: Hugo Relearn Theme" >
< link href = "/hugo-theme-relearn/configuration/customization/outputformats/index.xml" rel = "alternate" type = "application/rss+xml" title = "Output Formats :: Hugo Relearn Theme" >
2024-10-14 18:19:22 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1728929948" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728929948" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728929948" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1728929948" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1728929948" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1728929948" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1728929948" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1728929948" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1728929948" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1728929948" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1728929948" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1728929948" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1728929948" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1728929948" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1728929948" > < / script >
2024-10-13 14:26:50 +00:00
< script >
window.relearn = window.relearn || {};
window.relearn.relBasePath='..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
// 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/configuration/customization/outputformats/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 = "#starting-from-scratch" > Starting from Scratch< / a > < / li >
< li > < a href = "#using-the-themes-structure" > Using the Theme’ s Structure< / a > < / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< / div >
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "/hugo-theme-relearn/configuration/index.html" > < span itemprop = "name" > Configuration< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "/hugo-theme-relearn/configuration/customization/index.html" > < span itemprop = "name" > Customization< / span > < / a > < meta itemprop = "position" content = "2" > > < / li > < li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Output Formats< / span > < meta itemprop = "position" content = "3" > < / li >
< / ol >
< div class = "topbar-area topbar-area-end" data-area = "end" >
< div class = "topbar-button topbar-button-edit" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/configuration/customization/outputformats/_index.en.md" target = "_self" title = "Edit (CTRL+ALT+w)" > < i class = "fa-fw fas fa-pen" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-print" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/configuration/customization/outputformats/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/designs/index.html" title = "Page Designs (🡐)" > < 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/customization/taxonomy/index.html" title = "Taxonomies (🡒)" > < 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" >
< / header >
< h1 id = "output-formats" > Output Formats< / h1 >
< p > In addition to the < a href = "/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html" > output formats coming with the theme< / a > , you can create your own < a href = "https://gohugo.io/templates/output-formats/" rel = "external" target = "_self" > output formats< / a > .< / p >
< h2 id = "starting-from-scratch" > Starting from Scratch< / h2 >
< p > If you want to add a new output format called < code > myformat< / code > that outputs HTML and you want to build everything yourself without using the theme’ s components:< / p >
< ol >
< li > Create a file < code > layouts/_default/baseof.myformat.html< / code > < / li >
< li > Implement all the necessary code in this file< / li >
< / ol >
< h2 id = "using-the-themes-structure" > Using the Theme’ s Structure< / h2 >
< p > If you want to keep the general framework and only change specific parts, you can override these files:< / p >
< ul >
< li > < code > layouts/_default/views/article.html< / code > : Controls how a page’ s content and title are displayed< / li >
< li > < code > layouts/_default/views/body.html< / code > : Determines the page body structure< / li >
< li > < code > layouts/_default/views/menu.html< / code > : Defines the sidebar menu layout< / li >
< li > < code > layouts/_default/views/storeOutputFormat.html< / code > : Stores the output format name for use in the framework< / li >
< / ul >
< p > For a real-world example, check out the < code > print< / code > output format implementations< / p >
< ul >
< li > < a href = "https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/body.print.html" rel = "external" target = "_self" > < code > layouts/_default/views/body.print.html< / code > < / a > < / li >
< li > < a href = "https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/menu.print.html" rel = "external" target = "_self" > < code > layouts/_default/views/menu.print.html< / code > < / a > < / li >
< li > < a href = "https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/_default/views/storeOutputFormat.print.html" rel = "external" target = "_self" > < code > layouts/_default/views/storeOutputFormat.print.html< / code > < / a > < / li >
< / ul >
< 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 >
< / ul >
< / div >
< / footer >
< / article >
< / div >
< / main >
< / div >
2024-10-14 18:19:22 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1728929948" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1728929948" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1728929948" defer > < / script >
2024-10-13 14:26:50 +00:00
< / body >
< / html >
