2021-10-16 23:18:04 +00:00
<!doctype html> < html lang = pir class = "js csstransforms3d" >
< head >
< meta charset = utf-8 >
< meta name = viewport content = "width=device-width,initial-scale=1" >
< meta name = generator content = "Hugo 0.88.1" >
2021-10-17 21:04:12 +00:00
< link rel = alternate type = application/rss+xml href = ../../../pir/cont/pages/index.xml title = "Documentat'n fer Cap'n Hugo Relearrrn 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-10-21 23:20:39 +00:00
< link rel = "shortcut icon" href = ../../../images/logo.svg?1634858437 >
2021-10-16 23:18:04 +00:00
< title > Planks orrrganizat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme< / title >
2021-10-21 23:20:39 +00:00
< link href = ../../../css/nucleus.css?1634858437 rel = stylesheet >
< link href = ../../../css/fontawesome-all.min.css?1634858437 rel = stylesheet >
< link href = ../../../css/featherlight.min.css?1634858437 rel = stylesheet >
< link href = ../../../css/perfect-scrollbar.min.css?1634858437 rel = stylesheet >
< link href = ../../../css/auto-complete.css?1634858437 rel = stylesheet >
< link href = ../../../css/theme.css?1634858437 rel = stylesheet >
< link href = ../../../css/theme-relearn.css?1634858437 rel = stylesheet >
< link href = ../../../css/variant.css?1634858437 rel = stylesheet >
< link href = ../../../css/print.css?1634858437 rel = stylesheet media = print >
< script src = ../../../js/jquery.min.js?1634858437 > < / 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 = ../../../pir/cont/pages/ >
2021-10-16 23:18:04 +00:00
< nav id = sidebar class = showVisitedLinks >
< div id = header-wrapper >
< div id = header >
2021-10-17 21:04:12 +00:00
< a id = logo href = ../../../pir/ style = "color:#3d414d;font-family:novacento sans wide,helvetica,tahoma,geneva,arial,sans-serif;font-size:30px;font-weight:700;margin-top:-2px" > < 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 = "fill:#3d414
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-10-21 23:20:39 +00:00
< script src = ../../../js/lunr.min.js?1634858437 > < / script >
< script src = ../../../js/auto-complete.js?1634858437 > < / script >
2021-10-17 21:04:12 +00:00
< script > var index _url = "../../../pir/index.json" , root _url = "../../../" , baseUri = root _url . replace ( /\/$/ , '' ) < / script >
2021-10-21 23:20:39 +00:00
< script src = ../../../js/search.js?1634858437 > < / 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 = /pir/basics/ title = Basics class = dd-item > < a href = ../../../pir/basics/ > < b > 1.< / b > Basics< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/basics/requirements/ title = Requirrrements class = "dd-item alwaysopen" > < a href = ../../../pir/basics/requirements/ > Requirrrements< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/basics/installation/ title = "Installat'n" class = "dd-item alwaysopen" > < a href = ../../../pir/basics/installation/ > Installat'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/basics/migration/ title = "Migrrrat'n" class = "dd-item alwaysopen" > < a href = ../../../pir/basics/migration/ > Migrrrat'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/basics/configuration/ title = "Configurrrat'n" class = "dd-item alwaysopen" > < a href = ../../../pir/basics/configuration/ > Configurrrat'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/basics/customization/ title = "Customizat'n" class = "dd-item alwaysopen" > < a href = ../../../pir/basics/customization/ > Customizat'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/basics/history/ title = Historrry class = "dd-item alwaysopen" > < a href = ../../../pir/basics/history/ > Historrry< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /pir/cont/ title = "Rambl'n" class = "dd-item parent" > < a href = ../../../pir/cont/ > < b > 2.< / b > Rambl'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/cont/pages/ title = "Planks orrrganizat'n" class = "dd-item active parent alwaysopen" > < a href = ../../../pir/cont/pages/ > Planks orrrganizat'n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/cont/archetypes/ title = Arrrchetypes class = dd-item > < a href = ../../../pir/cont/archetypes/ > Arrrchetypes< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/cont/markdown/ title = "Marrrkdown rules" class = dd-item > < a href = ../../../pir/cont/markdown/ > Marrrkdown rules< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/cont/syntaxhighlight/ title = "Code highlight'n" class = dd-item > < a href = ../../../pir/cont/syntaxhighlight/ > Code highlight'n< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/cont/menushortcuts/ title = "Menu extrrra shorrrtcuts" class = dd-item > < a href = ../../../pir/cont/menushortcuts/ > Menu extrrra shorrrtcuts< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/cont/icons/ title = "Ay'cons an' logos" class = dd-item > < a href = ../../../pir/cont/icons/ > Ay'cons an' logos< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/cont/i18n/ title = "Multilingual an' i18n" class = "dd-item alwaysopen" > < a href = ../../../pir/cont/i18n/ > Multilingual an' i18n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/cont/tags/ title = Tags class = dd-item > < a href = ../../../pir/cont/tags/ > Tags< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/ title = Shorrrtcodes class = dd-item > < a href = ../../../pir/shortcodes/ > < b > 3.< / b > Shorrrtcodes< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/attachments/ title = Attachments class = dd-item > < a href = ../../../pir/shortcodes/attachments/ > Attachments< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/button/ title = Button class = dd-item > < a href = ../../../pir/shortcodes/button/ > Button< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/children/ title = Children class = dd-item > < a href = ../../../pir/shortcodes/children/ > Children< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/children/test/ title = "Plank X" class = dd-item > < a href = ../../../pir/shortcodes/children/test/ > Plank X< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/children/children-1/ title = "Plank 1" class = dd-item > < a href = ../../../pir/shortcodes/children/children-1/ > Plank 1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/children/children-1/children-1-1/ title = "Plank 1-1" class = dd-item > < a href = ../../../pir/shortcodes/children/children-1/children-1-1/ > Plank 1-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/children/children-1/children-1-1/children-1-1-2/ title = "Plank 1-1-2" class = "dd-item alwaysopen" > < a href = ../../../pir/shortcodes/children/children-1/children-1-1/children-1-1-2/ > Plank 1-1-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ title = "Plank 1-1-2-1" class = "dd-item alwaysopen" > < a href = ../../../pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ > Plank 1-1-2-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ title = "Plank 1-1-2-2" class = "dd-item alwaysopen" > < a href = ../../../pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ > Plank 1-1-2-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/children/children-1/children-1-1/children-1-1-3/ title = "Plank 1-1-3" class = "dd-item alwaysopen" > < a href = ../../../pir/shortcodes/children/children-1/children-1-1/children-1-1-3/ > Plank 1-1-3< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/children/children-2/ title = "Plank 2" class = dd-item > < a href = ../../../pir/shortcodes/children/children-2/ > Plank 2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/children/children-3/ title = "Plank 3" class = dd-item > < a href = ../../../pir/shortcodes/children/children-3/ > Plank 3< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /pir/shortcodes/children/children-3/test3/ title = "Plank 3-1" class = dd-item > < a href = ../../../pir/shortcodes/children/children-3/test3/ > Plank 3-1< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /pir/shortcodes/expand/ title = Expand class = dd-item > < a href = ../../../pir/shortcodes/expand/ > Expand< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/include/ title = Include class = dd-item > < a href = ../../../pir/shortcodes/include/ > Include< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/mermaid/ title = Merrrmaid class = dd-item > < a href = ../../../pir/shortcodes/mermaid/ > Merrrmaid< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/notice/ title = Notice class = dd-item > < a href = ../../../pir/shortcodes/notice/ > Notice< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/siteparam/ title = "Ship param" class = dd-item > < a href = ../../../pir/shortcodes/siteparam/ > Ship param< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /pir/shortcodes/tabs/ title = "Tabbed views" class = dd-item > < a href = ../../../pir/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 >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../../pir/tags/ > < i class = "fas fa-fw fa-tags" > < / i > Arrr! Tags< / a > < / li >
2021-10-16 23:18:04 +00:00
< 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 = ../../../pir/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 > Cap'n Hugo Documentat'n< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../../pir/credits/ > < i class = "fas fa-fw fa-bullhorn" > < / i > Crrredits< / 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 = /cont/pages/ > English< / option > < option id = pir value = /pir/cont/pages/ selected > 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/cont/pages/_index.pir.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 = ../../../pir/ > < span itemprop = name > Relearrrn Theme fer Cap'n Hugo< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "2" > < a itemprop = item href = ../../../pir/cont/ > < span itemprop = name > Rambl'n< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "1" > < a itemprop = item href = ../../../pir/cont/pages/ aria-disabled = true > < span itemprop = name > Planks orrrganizat'n< / span > < / a > < / li >
2021-10-16 23:18:04 +00:00
< / ol >
< / div >
< div class = progress >
< div class = wrapper >
< nav id = TableOfContents > < / nav >
< / div >
< / div >
< / div >
< div id = head-tags >
< / div >
< main id = body-inner >
< h1 > Planks orrrganizat'n< / h1 >
< p > In < strong > Cap'n Hugo< / strong > , planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.< / p >
< h2 id = folders > Folders< / h2 >
< p > Org'nize yer ship like < a href = https://gohugo.io/content/organization/ > any other Cap'n Hugo project< / a > . Typically, ye will have a < em > rambl'n< / em > folder wit' all yer planks.< / 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-plaintext data-lang = plaintext > rambl'n
├── level-one
│ ├── level-two
│ │ ├── level-three
│ │ │ ├── level-four
│ │ │ │ ├── _index.md < -- /level-one/level-two/level-three/level-four
│ │ │ │ ├── page-4-a.md < -- /level-one/level-two/level-three/level-four/page-4-a
│ │ │ │ ├── page-4-b.md < -- /level-one/level-two/level-three/level-four/page-4-b
│ │ │ │ └── page-4-c.md < -- /level-one/level-two/level-three/level-four/page-4-c
│ │ │ ├── _index.md < -- /level-one/level-two/level-three
│ │ │ ├── page-3-a.md < -- /level-one/level-two/level-three/page-3-a
│ │ │ ├── page-3-b.md < -- /level-one/level-two/level-three/page-3-b
│ │ │ └── page-3-c.md < -- /level-one/level-two/level-three/page-3-c
│ │ ├── _index.md < -- /level-one/level-two
│ │ ├── page-2-a.md < -- /level-one/level-two/page-2-a
│ │ ├── page-2-b.md < -- /level-one/level-two/page-2-b
│ │ └── page-2-c.md < -- /level-one/level-two/page-2-c
│ ├── _index.md < -- /level-one
│ ├── page-1-a.md < -- /level-one/page-1-a
│ ├── page-1-b.md < -- /level-one/page-1-b
│ └── page-1-c.md < -- /level-one/page-1-c
├── _index.md < -- /
└── page-top.md < -- /page-top
< / code > < / pre > < / div >
< div class = "notices note" >
< div class = label > Avast< / div > < p > < code > _index.md< / code > be required 'n each folder, it’ < / p >
< / div >
< h2 id = types > Types< / h2 >
< p > Th' Relearrrn theme defines two types o' planks. < em > Default< / em > an' < em > Chapter< / em > . Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.< / p >
< p > A < strong > Chapter< / strong > displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rambl'n that can be found under it.
Ye can define any HTML as prefix fer th' menu. In th' example below, it’ s just a number but that could be an < a href = https://fortawesome.github.io/Font-Awesome/ > ay'con< / a > .< / p >
< p > < img src = "../../../cont/pages/images/pages-chapter.png?width=50pc" alt = "Chapter page" > < / 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-markdown data-lang = markdown > +++
chapter = true
pre = " < < span style = color:#ff6ac1 > b< / span > > 1. < /< span style = color:#ff6ac1 > b< / span > > "
title = " Basics"
weight = 5
+++
< span style = font-weight:700 > ### Chapter 1
< / span > < span style = font-weight:700 > < / span >
< span style = font-weight:700 > # Basics
< / span > < span style = font-weight:700 > < / span >
Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
< / code > < / pre > < / div > < p > T' tell th' Relearrrn theme t' consider a plank as a chapter, set < code > chapter=true< / code > 'n th' Front Matter o' th' plank.< / p >
< p > A < strong > Default< / strong > plank be any other rambl'n plank.< / p >
< p > < img src = "../../../cont/pages/images/pages-default.png?width=50pc" alt = "Default page" > < / 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 > < span style = color:#ff5c57 > +++< / span >
title = < span style = color:#5af78e > " Installation" < / span >
weight = < span style = color:#ff9f43 > 15< / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div > < p > Th' follow'n steps be here t' help ye initialize yer new website. If ye don’ t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n this < a href = https://gohugo.io/overview/quickstart/ > great documentat'n fer beginners< / a > .< / p >
< h2 id = create-your-project > Create yer project< / h2 >
< p > Cap'n Hugo provides a < code > new< / code > command t' create a new website.< / 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-shell data-lang = shell > hugo new ship < new_project>
2021-10-17 21:04:12 +00:00
< / code > < / pre > < / div > < p > Th' Relearrrn theme provides < a href = ../../../pir/cont/archetypes/ > archetypes< / a > t' help ye create this kind o' planks.< / p >
2021-10-16 23:18:04 +00:00
< h2 id = front-matter-configuration > Front Matter configurat'n< / h2 >
< p > Each Cap'n Hugo plank has t' define a < a href = https://gohugo.io/content/front-matter/ > Front Matter< / a > 'n < em > toml< / em > , < em > yaml< / em > or < em > json< / em > . This ship will use < em > toml< / em > 'n all cases.< / p >
< p > Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :< / 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 > < span style = color:#ff5c57 > +++< / span >
< span style = color:#78787e > # T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.< / span >
< span style = color:#78787e > # Avast: Toc be always disabled fer chapter planks< / span >
disableToc = < span style = color:#5af78e > " false" < / span >
< span style = color:#78787e > # If set, this will be used fer th' page' s menu entry (instead o' th' `title` attribute)< / span >
menuTitle = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # If set, this will explicitly override common rules fer th' expand state o' a page' s menu entry< / span >
alwaysopen = < span style = color:#ff6ac1 > true< / span >
< span style = color:#78787e > # If set, this will explicitly override common rules fer th' sort'n order o' a page' s submenu entries< / span >
ordersectionsby = < span style = color:#5af78e > " title" < / span >
< span style = color:#78787e > # Th' title o' th' plank 'n menu will be prefixed by this HTML rambl'n< / span >
pre = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Th' title o' th' plank 'n menu will be postfixed by this HTML rambl'n< / span >
post = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Set th' plank as a chapter, chang'n th' way it' s displayed< / span >
chapter = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Hide a menu entry by sett'n this t' true< / span >
hidden = < span style = color:#ff6ac1 > false< / span >
< span style = color:#78787e > # Display name o' this plank modifier. If set, it will be displayed 'n th' footer.< / span >
LastModifierDisplayName = < span style = color:#5af78e > " " < / span >
< span style = color:#78787e > # Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer< / span >
LastModifierEmail = < span style = color:#5af78e > " " < / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div > < h3 id = add-icon-to-a-menu-entry > Add ay'con t' a menu entry< / h3 >
< p > In th' plank frontmatter, add a < code > pre< / code > param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.< / 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 > < span style = color:#ff5c57 > +++< / span >
title = < span style = color:#5af78e > " GitHub repo" < / span >
pre = < span style = color:#5af78e > " < i class=' fab fa-github' > < /i> " < / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div > < p > < img src = ../../../cont/pages/images/frontmatter-icon.png alt = "Title wit' icon" > < / p >
< h3 id = ordering-sibling-menupage-entries > Order'n sibl'n menu/page entries< / h3 >
< p > Cap'n Hugo provides a < a href = https://gohugo.io/content/ordering/ > flex'ble way< / a > t' handle order fer yer planks.< / p >
< p > Th' simplest way be t' set < code > weight< / code > parameter t' a number.< / 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 > < span style = color:#ff5c57 > +++< / span >
title = < span style = color:#5af78e > " My page" < / span >
weight = < span style = color:#ff9f43 > 5< / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div > < h3 id = using-a-custom-title-for-menu-entries > Us'n a custom title fer menu entries< / h3 >
< p > By default, th' Relearrrn theme will use a page’ s < code > title< / code > attribute fer th' menu item (or < code > linkTitle< / code > if defined).< / p >
< p > But a page’ s title has t' be descriptive on its own while th' menu be a hierarchy.
We’ ve added th' < code > menuTitle< / code > parameter fer that purpose:< / p >
< p > For example (for a plank named < code > content/install/linux.md< / 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 > < span style = color:#ff5c57 > +++< / span >
title = < span style = color:#5af78e > " Install on Linux" < / span >
menuTitle = < span style = color:#5af78e > " Linux" < / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div > < h3 id = override-expand-state-rules-for-menu-entries > Override expand state rules fer menu entries< / h3 >
< p > Ye can change how th' theme expands menu entries on th' side o' th' rambl'n wit' th' < code > alwaysopen< / code > sett'n on a per plank basis. If < code > alwaysopen=false< / code > fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.< / p >
< p > Th' theme generates th' menu based on th' follow'n rules:< / p >
< ul >
< li > all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns< / li >
< li > immediate children entries o' th' active plank be shown regardless o' any sett'ns< / li >
< li > if not overridden, all other first level entries behave like they would have been given < code > alwaysopen=false< / code > < / li >
< li > if not overridden, all other entries o' levels besides th' first behave like they would have been given < code > alwaysopen=true< / code > < / li >
< li > all vis'ble entries show their immediate children entries if < code > alwaysopen=true< / code > ; this proceeds recursivley< / li >
< li > all remain'n entries be not shown< / li >
< / ul >
2021-10-17 21:04:12 +00:00
< p > Ye can see this feature 'n act'n on th' example plank fer < a href = ../../../pir/shortcodes/children/ > children shorrrtcode< / a > an' its children planks.< / p >
2021-10-16 23:18:04 +00:00
< h2 id = your-page > Yer Plank< / h2 >
< p > T' configure yer plank, ye basically have three choices:< / p >
< ol >
< li > Create an < code > _index.md< / code > document 'n < code > rambl'n< / code > folder an' fill th' file wit' < em > Marrrkdown rambl'n< / em > < / li >
< li > Create an < code > index.html< / code > file 'n th' < code > static< / code > folder an' fill th' file wit' < em > HTML rambl'n< / em > < / li >
< li > Configure yer server t' automatically redirect home plank t' one yer documentat'n plank< / li >
< / ol >
< footer class = footline >
< / footer >
< / main >
< / div >
< div id = navigation >
2021-10-17 21:04:12 +00:00
< a class = "nav nav-prev" href = ../../../pir/cont/ title = "Rambl'n" > < i class = "fa fa-chevron-left" > < / i > < / a >
< a class = "nav nav-next" href = ../../../pir/cont/archetypes/ title = Arrrchetypes > < 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-10-21 23:20:39 +00:00
< script src = ../../../js/clipboard.min.js?1634858437 > < / script >
< script src = ../../../js/perfect-scrollbar.min.js?1634858437 > < / script >
< script src = ../../../js/perfect-scrollbar.jquery.min.js?1634858437 > < / script >
< script src = ../../../js/jquery.svg.pan.zoom.js?1634858437 > < / script >
< script src = ../../../js/featherlight.min.js?1634858437 > < / script >
< script src = ../../../js/modernizr.custom-3.6.0.js?1634858437 > < / script >
< script src = ../../../js/mermaid.min.js?1634858437 > < / script >
2021-10-16 23:18:04 +00:00
< script > typeof mermaid != 'undefined' && mermaid . mermaidAPI . initialize ( Object . assign ( { securityLevel : "antiscript" } , JSON . parse ( '{ "startOnLoad": true }' ) , { startOnLoad : ! 1 } ) ) < / script >
2021-10-21 23:20:39 +00:00
< script src = ../../../js/relearn.js?1634858437 > < / script >
2021-10-16 23:18:04 +00:00
< / body >
< / html >
