2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2023-11-12 12:44:57 +00:00
< meta name = "generator" content = "Hugo 0.120.4" >
2023-11-03 22:37:57 +00:00
< meta name = "generator" content = "Relearn 5.23.2+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< 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 = "Configuration :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "Documentation for Hugo Relearn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Configuration :: Hugo Relearn Theme" >
< meta property = "og:description" content = "Documentation for Hugo Relearn Theme" >
< meta property = "og:type" content = "website" >
2023-10-11 15:42:11 +00:00
< meta property = "og:url" content = "https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" >
2023-10-11 15:32:39 +00:00
< meta property = "og:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2022-04-02 13:30:16 +00:00
< title > Configuration :: Hugo Relearn Theme< / title >
2023-01-25 11:42:06 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html" rel = "alternate" hreflang = "pir" >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html" rel = "canonical" type = "text/html" title = "Configuration :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../../basics/configuration/index.xml" rel = "alternate" type = "application/rss+xml" title = "Configuration :: Hugo Relearn Theme" >
2023-11-16 23:59:42 +00:00
< link href = "../../images/logo.svg?1700179176" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-11-16 23:59:42 +00:00
< link href = "../../css/fontawesome-all.min.css?1700179177" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1700179177" rel = "stylesheet" > < / noscript >
< link href = "../../css/nucleus.css?1700179177" rel = "stylesheet" >
< link href = "../../css/auto-complete.css?1700179177" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1700179177" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1700179177" rel = "stylesheet" >
< link href = "../../css/fonts.css?1700179177" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1700179177" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1700179177" rel = "stylesheet" >
< link href = "../../css/theme-auto.css?1700179177" rel = "stylesheet" id = "R-variant-style" >
< link href = "../../css/variant.css?1700179177" rel = "stylesheet" >
< link href = "../../css/print.css?1700179177" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1700179177" rel = "stylesheet" >
< link href = "../../css/ie.css?1700179177" rel = "stylesheet" >
< script src = "../../js/url.js?1700179177" > < / script >
< script src = "../../js/variant.js?1700179177" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
// variant stuff
2023-08-12 14:11:21 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// 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}"`;
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../basics/configuration/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< 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)" >
2023-09-12 21:10:21 +00:00
< i class = "fa-fw fas fa-bars" > < / i >
< / button >
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2023-09-26 20:26:46 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "../../basics/index.html" > < span itemprop = "name" > Basics< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Configuration< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
< main id = "R-body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
2023-10-03 20:51:03 +00:00
< div class = " taxonomy-tags term-list cstyle tags" title = "Tags" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
2023-10-03 11:21:35 +00:00
< ul >
< li > < a class = "term-link" href = "../../tags/config/index.html" > config< / a > < / li >
< / ul >
2023-06-18 09:45:45 +00:00
< / div >
2023-05-19 18:46:07 +00:00
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "configuration" > Configuration< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< h2 id = "global-site-parameters" > Global site parameters< / h2 >
2023-10-28 20:28:18 +00:00
< p > On top of < a href = "https://gohugo.io/overview/configuration/" target = "_blank" > Hugo global configuration< / a > , the Relearn theme lets you define the following parameters in your < code > config.toml< / code > (here, values are default).< / p >
2022-04-02 13:30:16 +00:00
< p > Note that some of these parameters are explained in details in other sections of this documentation.< / p >
2023-11-15 23:21:36 +00:00
2023-11-16 23:59:42 +00:00
< div class = "tab-panel" data-tab-group = "104a42297baedf38226912bd191e2a2e" >
2023-11-15 23:21:36 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-11-16 21:52:09 +00:00
data-tab-item="configtoml"
2023-11-15 23:21:36 +00:00
class="tab-nav-button tab-panel-style cstyle initial active"
2023-11-16 23:59:42 +00:00
onclick="switchTab('104a42297baedf38226912bd191e2a2e','configtoml')"
2023-11-15 23:21:36 +00:00
>
2023-11-16 21:52:09 +00:00
< span class = "tab-nav-text" > config.toml< / span >
2023-11-15 23:21:36 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-11-16 21:52:09 +00:00
data-tab-item="configtoml"
2023-11-15 23:21:36 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2023-11-16 21:52:09 +00:00
< div class = "wrap-code highlight" > < 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 >
2023-11-15 23:21:36 +00:00
< / 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 given 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 aswell.< / 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 >
2023-11-16 23:40:18 +00:00
< / 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 >
2023-11-15 23:21:36 +00:00
< / 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" >
2023-11-16 23:40:18 +00:00
< / 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" >
2023-11-15 23:21:36 +00:00
< / 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" > # Variants< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These options set your color variant.< / 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 either set a single value eg. " zen-light" or an array like< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # [ " neon" , " learn" ]. 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: " auto" , " 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" . The auto variant is somewhat special. See the< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # option for themeVariantAuto below.< / 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 class = "s2" > " auto" < / span > < span class = "p" > ,< / span > < span class = "s2" > " relearn-bright" < / span > < span class = "p" > ,< / span > < span class = "s2" > " relearn-light" < / span > < span class = "p" > ,< / span > < span class = "s2" > " relearn-dark" < / 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 = "s2" > " neon" < / span > < span class = "p" > ,< / span > < span class = "s2" > " learn" < / span > < span class = "p" > ,< / span > < span class = "s2" > " blue" < / span > < span class = "p" > ,< / span > < span class = "s2" > " green" < / span > < span class = "p" > ,< / span > < span class = "s2" > " red" < / 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 color variants used for auto mode.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: [ " relearn-light" , " relearn-dark" ], overwritten by the first< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # two non-auto options from themeVariant if existant.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # The auto variant defines how your site adjusts to your selected OS settings< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # for light/dark mode. The first array element is the variant for light mode,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # the second for dark mode.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariantAuto< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " relearn-light" < / span > < span class = "p" > ,< / span > < span class = "s2" > " relearn-dark" < / span > < 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 tihs 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" >
2023-11-16 23:40:18 +00:00
< / 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" >
2023-11-15 23:21:36 +00:00
< / 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" > # 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" >
2023-11-16 23:40:18 +00:00
< / 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 config.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 te docs how tihs works.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # [relearn.dependencies]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-11-15 23:21:36 +00:00
< / 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 given URL is prepended to the< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # relative file path of a the displayed page. The URL must end with a `/`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This is useful if you wnat 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" > " https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" < / 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 apperance.< / 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 searc box is sisabled, 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 >
2023-11-16 23:40:18 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2023-11-15 23:21:36 +00:00
< / 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 = "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 opition 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 but behaves< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # like any other page for all other functionality in Hugo.< / 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" > # 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" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / 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" > # 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" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
2023-11-16 23:40:18 +00:00
< / 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 syntaxhighlighted 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" > # 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 >
2023-11-15 23:21:36 +00:00
< / 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 effects can be overridden in the page' s frontmatter or thru 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" > 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" > # 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" > # 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" > # 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 > < h2 id = "serving-your-page-from-a-subfolder" > Serving your page from a subfolder< / h2 >
2022-11-05 23:35:48 +00:00
< p > If your site is served from a subfolder, eg. < code > https://example.com/mysite/< / code > , you have to set the following lines to your < code > config.toml< / code > < / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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 = "s2" > " https://example.com/mysite/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > canonifyURLs< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2023-10-28 20:28:18 +00:00
< / 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 > < p > Without < code > canonifyURLs=true< / code > URLs in sublemental pages (like < code > sitemap.xml< / code > , < code > rss.xml< / code > ) will be generated falsly while your HTML files will still work. See < a href = "https://github.com/gohugoio/hugo/issues/5226" target = "_blank" > https://github.com/gohugoio/hugo/issues/5226< / a > .< / p >
2022-11-01 23:17:10 +00:00
< h2 id = "serving-your-page-from-the-filesystem" > Serving your page from the filesystem< / h2 >
< p > If you want your page served from the filesystem by using URLs starting with < code > file://< / code > you’ ll need the following configuration in your < code > config.toml< / code > :< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < 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 > < p > The theme will append an additional < code > index.html< / code > to all branch bundle links by default to make the page be servable from the file system. If you don’ t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your < code > config.toml< / code > < / p >
< div class = "wrap-code highlight" > < 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 >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-28 20:28:18 +00:00
< p > If you want to use the search feature from the file system using 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 = "#activate-search" > as seen below< / a > .< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-11-01 23:17:10 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "activate-search" > Activate search< / h2 >
2022-11-01 23:17:10 +00:00
< p > If not already present, add the following lines in the same < code > config.toml< / code > file.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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 = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ]< / span > < / span > < / span > < / code > < / pre > < / 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 >
2022-11-17 21:13:11 +00:00
< h3 id = "activate-dedicated-search-page" > Activate dedicated search page< / h3 >
2023-10-07 17:20:48 +00:00
< 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 > config.toml< / code > file. This will cause Hugo to generate a new file < code > http://example.com/mysite/search.html< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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 = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCHPAGE" < / span > < span class = "p" > ]< / span > < / span > < / span > < / code > < / pre > < / 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 >
2023-11-16 23:59:42 +00:00
< p > < a href = "#R-image-da279b8e3954456562f35af74d37f826" class = "lightbox-link" > < img src = "../../basics/configuration/search_page.png?&width=60pc" alt = "Screenshot of the dedicated search page" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 60pc;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-da279b8e3954456562f35af74d37f826" > < img src = "../../basics/configuration/search_page.png?&width=60pc" alt = "Screenshot of the dedicated search page" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-10-07 17:20:48 +00:00
< 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 > config.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 >
2022-04-02 13:30:16 +00:00
< 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 > config.toml< / code > as seen below:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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 >
2022-11-01 23:17:10 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > home< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ]< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > page< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ]< / span > < / span > < / span > < / code > < / pre > < / 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 >
2023-06-03 22:20:43 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-28 20:28:18 +00:00
< p > The resulting URL will not be < a href = "https://gohugo.io/templates/output-formats/#configure-output-formats" target = "_blank" > configured ugly< / a > in terms of < a href = "https://gohugo.io/content-management/urls/#ugly-urls" target = "_blank" > Hugo’ s URL handling< / a > even if you’ ve set < code > uglyURLs=true< / code > in your < code > config.toml< / code > . This is due to the fact that for one mime type only one suffix can be configured.< / p >
2022-08-23 19:10:03 +00:00
< p > Nevertheless, if you’ re unhappy with the resulting URLs you can manually redefine < code > outputFormats.PRINT< / code > in your own < code > config.toml< / code > to your liking.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< h2 id = "mathjax" > MathJax< / h2 >
2023-10-28 20:28:18 +00:00
< p > The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See < a href = "../../shortcodes/math/index.html" > Math< / a > for additional documentation.< / p >
2022-07-02 12:20:53 +00:00
< h3 id = "math-example" > Example< / h3 >
< p > MathJax is globally disabled. By default it won’ t be loaded by any page.< / p >
< p > On page “ Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.< / p >
< p > You also can disable MathJax for specific pages while globally enabled.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "mermaid" > Mermaid< / h2 >
2023-10-28 20:28:18 +00:00
< p > The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See < a href = "../../shortcodes/mermaid/index.html" > Mermaid< / a > for additional documentation.< / p >
2022-07-02 12:20:53 +00:00
< h3 id = "mermaid-example" > Example< / h3 >
< p > Mermaid is globally disabled. By default it won’ t be loaded by any page.< / p >
< p > On page “ Architecture” you coded some JavaScript to dynamically generate a class diagram. You can set the Mermaid parameters locally to load mermaid on this page.< / p >
2022-04-02 13:30:16 +00:00
< p > You also can disable Mermaid for specific pages while globally enabled.< / p >
< 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 two parameters for the defined languages:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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 >
2023-05-17 18:59:44 +00:00
< / 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 >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
2023-05-17 18:59:44 +00:00
< / 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 >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Home" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
2023-05-17 18:59:44 +00:00
< / 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 >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
2023-05-17 18:59:44 +00:00
< / 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 >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Arrr! Homme" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span > < / span > < / span > < / code > < / pre > < / div > < p > If those params are not configured for a specific language, they will get their
2022-04-02 13:30:16 +00:00
default values:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < 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=' fas fa-home' > < /i> Home" < / span > < / span > < / span > < / code > < / pre > < / div > < p > The home button is going to look like this:< / p >
2023-11-16 23:59:42 +00:00
< p > < a href = "#R-image-d48e7fadc36ae5e9de8c3d89475592d2" class = "lightbox-link" > < img src = "../../basics/configuration/home_button_defaults.png?width=18.75rem" alt = "Default Home Button" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 18.75rem;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-d48e7fadc36ae5e9de8c3d89475592d2" > < img src = "../../basics/configuration/home_button_defaults.png?width=18.75rem" alt = "Default Home Button" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-10-10 20:33:18 +00:00
< h2 id = "social-media-meta-tags" > Social Media Meta Tags< / h2 >
2023-10-28 20:28:18 +00:00
< p > You can add social media meta tags for the < a href = "https://gohugo.io/templates/internal/#open-graph" target = "_blank" > Open Graph< / a > protocol and < a href = "https://gohugo.io/templates/internal/#twitter-cards" target = "_blank" > Twitter Cards< / a > to your site. These are configured as mentioned in the Hugo docs.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
2022-04-02 13:30:16 +00:00
< / div >
< / main >
< / div >
2023-11-16 23:59:42 +00:00
< script src = "../../js/clipboard.min.js?1700179177" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1700179177" defer > < / script >
< script src = "../../js/theme.js?1700179177" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
