2021-10-16 23:18:04 +00:00
<!doctype html> < html lang = en class = "js csstransforms3d" >
< head >
< meta charset = utf-8 >
< meta name = viewport content = "width=device-width,initial-scale=1" >
2021-11-09 20:15:08 +00:00
< meta name = generator content = "Hugo 0.89.2" >
2021-10-17 21:04:12 +00:00
< link rel = alternate type = application/rss+xml href = ../../basics/configuration/index.xml title = "Documentation for Hugo Relearn Theme" >
2021-10-16 23:18:04 +00:00
< meta name = description content = "Documentation for Hugo Relearn Theme" >
< meta name = author content = "Sören Weber" >
2021-11-09 20:39:10 +00:00
< link rel = icon href = ../../images/logo.svg?1636490346 type = image/svg+xml >
2021-10-16 23:18:04 +00:00
< title > Configuration :: Documentation for Hugo Relearn Theme< / title >
2021-11-09 20:39:10 +00:00
< link href = ../../css/nucleus.css?1636490346 rel = stylesheet >
< link href = ../../css/fontawesome-all.min.css?1636490346 rel = stylesheet >
< link href = ../../css/featherlight.min.css?1636490346 rel = stylesheet >
< link href = ../../css/perfect-scrollbar.min.css?1636490346 rel = stylesheet >
< link href = ../../css/auto-complete.css?1636490346 rel = stylesheet >
< link href = ../../css/theme.css?1636490346 rel = stylesheet >
< link href = ../../css/theme-relearn.css?1636490346 rel = stylesheet >
< link href = ../../css/variant.css?1636490346 rel = stylesheet >
< link href = ../../css/print.css?1636490346 rel = stylesheet media = print >
< script src = ../../js/jquery.min.js?1636490346 > < / script >
2021-10-16 23:18:04 +00:00
< style > : root # header + # content > # left > # rlblock_left { display : none !important } < / style >
< / head >
2021-10-17 21:04:12 +00:00
< body data-url = ../../basics/configuration/ >
2021-11-04 18:27:05 +00:00
< script > var index _url = "../../index.json" , root _url = "../../" , baseUri = root _url . replace ( /\/$/ , '' ) < / script >
2021-10-16 23:18:04 +00:00
< nav id = sidebar class = showVisitedLinks >
< div id = header-wrapper >
< div id = header >
2021-11-03 20:43:23 +00:00
< a id = logo href = ../../ style = "color:#3d414d;font-family:work sans,helvetica,tahoma,geneva,arial,sans-serif;font-size:30px;font-weight:300;margin-top:-2px;text-transform:uppercase" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 64.044 64.044" style = "height:65px;margin-bottom:-20px;margin-top:-20px;width:65px" > < path d = "M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212.0 01-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255s1.706.724 2.068 1.843c.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12.0 01-.499 1.309 1.757 1.757.0 01-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273.0 01-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711.0 00-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style = "fill:#3d414d;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform = "translate(-40.698 -95.175)" / > < path d = "M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002.0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447.0 00.303-.437.175.175.0 00.013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547.0 00.353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style = "fil
2021-10-16 23:18:04 +00:00
Relearn
< / a >
< / div >
< div class = searchbox >
< label for = search-by > < i class = "fas fa-search" > < / i > < / label >
< input data-search-input id = search-by type = search placeholder = Search... >
< span data-search-clear > < i class = "fas fa-times" > < / i > < / span >
< / div >
2021-11-09 20:39:10 +00:00
< script src = ../../js/lunr.min.js?1636490346 > < / script >
< script src = ../../js/auto-complete.js?1636490346 > < / script >
< script src = ../../js/search.js?1636490346 > < / script >
2021-10-16 23:18:04 +00:00
< / div >
< div class = highlightable >
< ul class = topics >
2021-10-17 21:04:12 +00:00
< li data-nav-id = /basics/ title = Basics class = "dd-item parent" > < a href = ../../basics/ > < b > 1.< / b > Basics< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /basics/migration/ title = "What's new" class = "dd-item alwaysopen" > < a href = ../../basics/migration/ > What's new< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/requirements/ title = Requirements class = "dd-item alwaysopen" > < a href = ../../basics/requirements/ > Requirements< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/installation/ title = Installation class = "dd-item alwaysopen" > < a href = ../../basics/installation/ > Installation< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/configuration/ title = Configuration class = "dd-item active parent alwaysopen" > < a href = ../../basics/configuration/ > Configuration< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/customization/ title = Customization class = "dd-item alwaysopen" > < a href = ../../basics/customization/ > Customization< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/history/ title = History class = "dd-item alwaysopen" > < a href = ../../basics/history/ > History< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /cont/ title = Content class = dd-item > < a href = ../../cont/ > < b > 2.< / b > Content< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /cont/pages/ title = "Pages organization" class = "dd-item alwaysopen" > < a href = ../../cont/pages/ > Pages organization< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /cont/archetypes/ title = Archetypes class = dd-item > < a href = ../../cont/archetypes/ > Archetypes< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/markdown/ title = "Markdown syntax" class = dd-item > < a href = ../../cont/markdown/ > Markdown syntax< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/syntaxhighlight/ title = "Code highlighting" class = dd-item > < a href = ../../cont/syntaxhighlight/ > Code highlighting< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/menushortcuts/ title = "Menu extra shortcuts" class = dd-item > < a href = ../../cont/menushortcuts/ > Menu extra shortcuts< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/icons/ title = "Icons and logos" class = dd-item > < a href = ../../cont/icons/ > Icons and logos< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/i18n/ title = "Multilingual and i18n" class = "dd-item alwaysopen" > < a href = ../../cont/i18n/ > Multilingual and i18n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /cont/tags/ title = Tags class = dd-item > < a href = ../../cont/tags/ > Tags< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/ title = Shortcodes class = dd-item > < a href = ../../shortcodes/ > < b > 3.< / b > Shortcodes< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/attachments/ title = Attachments class = dd-item > < a href = ../../shortcodes/attachments/ > Attachments< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/button/ title = Button class = dd-item > < a href = ../../shortcodes/button/ > Button< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/children/ title = Children class = dd-item > < a href = ../../shortcodes/children/ > Children< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/test/ title = "page X" class = dd-item > < a href = ../../shortcodes/children/test/ > page X< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/children/children-1/ title = "page 1" class = dd-item > < a href = ../../shortcodes/children/children-1/ > page 1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/ title = "page 1-1" class = dd-item > < a href = ../../shortcodes/children/children-1/children-1-1/ > page 1-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/ title = "page 1-1-2" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/ > page 1-1-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ title = "page 1-1-2-1" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ > page 1-1-2-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ title = "page 1-1-2-2" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ > page 1-1-2-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-3/ title = "page 1-1-3" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-3/ > page 1-1-3< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-2/ title = "page 2" class = dd-item > < a href = ../../shortcodes/children/children-2/ > page 2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-3/ title = "page 3" class = dd-item > < a href = ../../shortcodes/children/children-3/ > page 3< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-3/test3/ title = "page 3-1" class = dd-item > < a href = ../../shortcodes/children/children-3/test3/ > page 3-1< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/expand/ title = Expand class = dd-item > < a href = ../../shortcodes/expand/ > Expand< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/include/ title = Include class = dd-item > < a href = ../../shortcodes/include/ > Include< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/mermaid/ title = Mermaid class = dd-item > < a href = ../../shortcodes/mermaid/ > Mermaid< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/notice/ title = Notice class = dd-item > < a href = ../../shortcodes/notice/ > Notice< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/siteparam/ title = "Site param" class = dd-item > < a href = ../../shortcodes/siteparam/ > Site param< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/tabs/ title = "Tabbed views" class = dd-item > < a href = ../../shortcodes/tabs/ > Tabbed views< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li >
2021-10-16 23:18:04 +00:00
< / ul >
< div id = shortcuts >
< div class = nav-title > More< / div >
< ul >
< li > < a class = padding href = https://github.com/McShelby/hugo-theme-relearn > < i class = "fab fa-fw fa-github" > < / i > GitHub repo< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../showcase/ > < i class = "fas fa-fw fa-camera" > < / i > Showcases< / a > < / li >
2021-10-16 23:18:04 +00:00
< li > < a class = padding href = https://gohugo.io/ > < i class = "fas fa-fw fa-bookmark" > < / i > Hugo Documentation< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../credits/ > < i class = "fas fa-fw fa-bullhorn" > < / i > Credits< / a > < / li >
2021-10-24 11:04:13 +00:00
< li > < a class = padding href = ../../tags/ > < i class = "fas fa-fw fa-tags" > < / i > Tags< / a > < / li >
2021-10-16 23:18:04 +00:00
< / ul >
< / div >
< div id = prefooter >
< hr >
< ul >
< li >
< a class = padding >
< i class = "fas fa-language fa-fw" > < / i >
< div class = select-style >
2021-10-17 21:04:12 +00:00
< select id = select-language onchange = "location=baseUri+this.value" > < option id = en value = /basics/configuration/ selected > English< / option > < option id = pir value = /pir/basics/configuration/ > Arrr! Pirrrates< / option > < / select > < svg id = "Capa_1" xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" width = "255" height = "255" viewBox = "0 0 255 255" style = "enable-background:new 0 0 255 255" > < g > < g id = "arrow-drop-down" > < polygon points = "0,63.75 127.5,191.25 255,63.75" / > < / g > < / g > < / svg >
2021-10-16 23:18:04 +00:00
< / div >
< / a >
< / li >
< li > < a class = padding href = # data-clear-history-toggle > < i class = "fas fa-history fa-fw" > < / i > Clear History< / a > < / li >
< / ul >
< / div >
< div id = footer >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn/archive/main.zip data-icon = octicon-cloud-download aria-label = "Download McShelby/hugo-theme-relearn on GitHub" > Download< / a >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn data-icon = octicon-star data-show-count = true aria-label = "Star McShelby/hugo-theme-relearn on GitHub" > Star< / a >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn/fork data-icon = octicon-repo-forked data-show-count = true aria-label = "Fork McShelby/hugo-theme-relearn on GitHub" > Fork< / a >
< p > Built with < a href = https://github.com/McShelby/hugo-theme-relearn > < i class = "fas fa-heart" > < / i > < / a > by < a href = https://gohugo.io/ > Hugo< / a > < / p >
< script async defer src = https://buttons.github.io/buttons.js > < / script >
< / div >
< / div >
< / nav >
< div id = body >
< div id = overlay > < / div >
< div class = "padding highlightable" >
< div id = top-bar >
< div id = top-github-link >
< a class = github-link title = "Edit this page" href = https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/basics/configuration/_index.en.md target = blank >
< i class = "fas fa-code-branch" > < / i >
< span id = top-github-link-text > Edit this page< / span >
< / a >
< / div >
< div id = breadcrumbs >
< span id = sidebar-toggle-span >
< a href = # id = sidebar-toggle data-sidebar-toggle >
< i class = "fas fa-bars" > < / i >
< / a >
< / span >
< span id = toc-menu > < i class = "fas fa-list-alt" > < / i > < / span >
< ol class = links itemscope itemtype = http://schema.org/BreadcrumbList >
< meta itemprop = itemListOrder content = "Descending" >
2021-10-17 21:04:12 +00:00
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "3" > < a itemprop = item href = ../../ > < span itemprop = name > Relearn Theme for Hugo< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "2" > < a itemprop = item href = ../../basics/ > < span itemprop = name > Basics< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "1" > < a itemprop = item href = ../../basics/configuration/ aria-disabled = true > < span itemprop = name > Configuration< / span > < / a > < / li >
2021-10-16 23:18:04 +00:00
< / ol >
< / div >
< div class = progress >
< div class = wrapper >
< nav id = TableOfContents >
< ul >
< li > < a href = #global-site-parameters > Global site parameters< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a href = #a-word-on-running-your-site-in-a-subfolder > A word on running your site in a subfolder< / a > < / li >
2021-10-16 23:18:04 +00:00
< li > < a href = #activate-search > Activate search< / a > < / li >
< li > < a href = #mermaid > Mermaid< / a > < / li >
< li > < a href = #home-button-configuration > Home Button Configuration< / a > < / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div id = head-tags >
< / div >
< main id = body-inner >
< h1 > Configuration< / h1 >
< h2 id = global-site-parameters > Global site parameters< / h2 >
< p > On top of < a href = https://gohugo.io/overview/configuration/ > Hugo global configuration< / a > , the Relearn theme lets you define the following parameters in your < code > config.toml< / code > (here, values are default).< / p >
< p > Note that some of these parameters are explained in details in other sections of this documentation.< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > [params]
< span style = color:#78787e > # This controls whether submenus will be expanded (true), or collapsed (false) in the< / span >
< span style = color:#78787e > # menu; if no setting is given, the first menu level is set to false, all others to true;< / span >
< span style = color:#78787e > # this can be overridden in the pages frontmatter< / span >
alwaysopen = < span style = color:#ff6ac1 > true< / span >
< span style = color:#78787e > # Prefix URL to edit current page. Will display an " Edit this page" button on top right hand corner of every page.< / span >
< span style = color:#78787e > # Useful to give opportunity to people to create merge request for your doc.< / span >
< span style = color:#78787e > # See the config.toml file from this documentation site to have an example.< / span >
editURL = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Author of the site, will be used in meta information< / span >
author = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Description of the site, will be used in meta information< / span >
description = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Shows a checkmark for visited pages on the menu< / span >
showVisitedLinks = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Disable search function. It will hide search bar< / span >
disableSearch = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Disable search in hidden pages, otherwise they will be shown in search box< / span >
disableSearchHiddenPages = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines< / span >
disableSeoHiddenPages = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden< / span >
disableTagHiddenPages = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Javascript and CSS cache are automatically busted when new version of site is generated.< / span >
< span style = color:#78787e > # Set this to true to disable this behavior (some proxies don' t handle well this optimization)< / span >
disableAssetsBusting = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Set this to true to disable copy-to-clipboard button for inline code.< / span >
disableInlineCopyToClipBoard = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # A title for shortcuts in menu is set by default. Set this to true to disable it.< / span >
disableShortcutsTitle = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # If set to false, a Home button will appear below the search bar on the menu.< / span >
< span style = color:#78787e > # It is redirecting to the landing page of the current language if specified. (Default is " /" )< / span >
disableLandingPageButton = < span style = color:#ff6ac1 > true< / span >
< span style = color:#78787e > # When using mulitlingual website, disable the switch language button.< / span >
disableLanguageSwitchingButton = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Hide breadcrumbs in the header and only show the current page title< / span >
disableBreadcrumb = < span style = color:#ff6ac1 > true< / span >
2021-11-03 20:43:23 +00:00
< span style = color:#78787e > # If set to true, hide table of contents menu in the header of all pages< / span >
disableToc = < span style = color:#ff6ac1 > false< / span >
2021-10-16 23:18:04 +00:00
< span style = color:#78787e > # If set to true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic)< / span >
disableMermaid = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Specifies the remote location of the Mermaid js< / span >
customMermaidURL = < span style = color:#5af78e > " https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js" < / span >
< span style = color:#78787e > # Initialization parameter for Mermaid, see Mermaid documentation< / span >
mermaidInitialize = < span style = color:#5af78e > " { \" theme\" : \" default\" }" < / span >
< span style = color:#78787e > # Hide Next and Previous page buttons normally displayed full height beside content< / span >
disableNextPrev = < span style = color:#ff6ac1 > true< / span >
< span style = color:#78787e > # Order sections in menu by " weight" or " title" . Default to " weight" ;< / span >
< span style = color:#78787e > # this can be overridden in the pages frontmatter< / span >
ordersectionsby = < span style = color:#5af78e > " weight" < / span >
< span style = color:#78787e > # Change default color scheme with a variant one. Can be " red" , " blue" , " green" .< / span >
themeVariant = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Provide a list of custom css files to load relative from the `static/` folder in the site root.< / span >
custom_css = [< span style = color:#5af78e > " css/foo.css" < / span > , < span style = color:#5af78e > " css/bar.css" < / span > ]
< span style = color:#78787e > # Change the title separator. Default to " ::" .< / span >
titleSeparator = < span style = color:#5af78e > " -" < / span >
2021-10-17 21:04:12 +00:00
< / code > < / pre > < / div > < h2 id = a-word-on-running-your-site-in-a-subfolder > A word on running your site in a subfolder< / h2 >
< p > The theme runs best if your site is installed in the root of your webserver. 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 >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > baseURL = < span style = color:#5af78e > " https://example.com/mysite/" < / span >
canonifyURLs = < span style = color:#ff6ac1 > true< / 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 > https://github.com/gohugoio/hugo/issues/5226< / a > .< / p >
< h2 id = activate-search > Activate search< / h2 >
2021-10-16 23:18:04 +00:00
< p > If not already present, add the follow lines in the same < code > config.toml< / code > file.< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > [outputs]
home = [ < span style = color:#5af78e > " HTML" < / span > , < span style = color:#5af78e > " RSS" < / span > , < span style = color:#5af78e > " JSON" < / span > ]
< / code > < / pre > < / div > < p > Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.< / p >
< blockquote >
< p > Hugo generate lunrjs index.json at the root of public folder.
When you build the site with < code > hugo server< / code > , hugo generates it internally and of course it doesn’ < / p >
< / blockquote >
< h2 id = mermaid > Mermaid< / h2 >
2021-10-17 21:04:12 +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/ > Mermaid< / a > for additional documentation.< / p >
2021-10-16 23:18:04 +00:00
< blockquote >
< p > Example:< / p >
< p > Mermaid is globally disabled. By default it won’ t be loaded by any page.
On page “ Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).< / p >
< / blockquote >
< 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 >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > [Lanugages]
[Lanugages.en]
...
2021-10-17 21:04:12 +00:00
landingPageURL = < span style = color:#5af78e > " /" < / span >
2021-10-16 23:18:04 +00:00
landingPageName = < span style = color:#5af78e > " < i class=' fas fa-home' > < /i> Home" < / span >
...
[Lanugages.pir]
...
2021-10-17 21:04:12 +00:00
landingPageURL = < span style = color:#5af78e > " /pir/" < / span >
2021-10-16 23:18:04 +00:00
landingPageName = < span style = color:#5af78e > " < i class=' fas fa-home' > < /i> Arrr! Homme" < / span >
...
< / code > < / pre > < / div > < p > If those params are not configured for a specific language, they will get their
default values:< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > landingPageURL = < span style = color:#5af78e > " /" < / span >
landingPageName = < span style = color:#5af78e > " < i class=' fas fa-home' > < /i> Home" < / span >
< / code > < / pre > < / div > < p > The home button is going to look like this:< / p >
< p > < img src = "../../basics/configuration/images/home_button_defaults.png?width=100%25" alt = "Default Home Button" > < / p >
< footer class = footline >
< / footer >
< / main >
< / div >
< div id = navigation >
2021-10-17 21:04:12 +00:00
< a class = "nav nav-prev" href = ../../basics/installation/ title = Installation > < i class = "fa fa-chevron-left" > < / i > < / a >
< a class = "nav nav-next" href = ../../basics/customization/ title = Customization > < i class = "fa fa-chevron-right" > < / i > < / a >
2021-10-16 23:18:04 +00:00
< / div >
< / div >
< div style = left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px >
< div style = border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px > < / div >
< / div >
2021-11-09 20:39:10 +00:00
< script src = ../../js/clipboard.min.js?1636490346 > < / script >
< script src = ../../js/perfect-scrollbar.min.js?1636490346 > < / script >
< script src = ../../js/perfect-scrollbar.jquery.min.js?1636490346 > < / script >
< script src = ../../js/jquery.svg.pan.zoom.js?1636490346 > < / script >
< script src = ../../js/featherlight.min.js?1636490346 > < / script >
< script src = ../../js/modernizr.custom-3.6.0.js?1636490346 > < / script >
< script src = ../../js/mermaid.min.js?1636490346 > < / script >
2021-11-08 15:53:51 +00:00
< script > typeof mermaid != 'undefined' && typeof mermaid . mermaidAPI != 'undefined' && mermaid . mermaidAPI . initialize ( Object . assign ( { securityLevel : "antiscript" } , JSON . parse ( '{ "startOnLoad": true }' ) , { startOnLoad : ! 1 } ) ) < / script >
2021-11-09 20:39:10 +00:00
< script src = ../../js/relearn.js?1636490346 > < / script >
2021-10-16 23:18:04 +00:00
< / body >
< / html >
