"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nChapter 1 Basics Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nChapter 2 Rrrambl'n Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nChapter 3 Shorrrtcodes Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shorrrtcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nAttachments List o' files attached t' a plank\nButton Click'ble buttons\nChildren List th' child planks o' a plank\nExpand Expandable/collaps'ble sections o' text\nInclude Displays rrrambl'n from other files\nMerrrmaid Generate diagrams an' flowcharts from text\nNotice Disclaimers t' help ye structure yer plank\nShip param Get value o' ship params\nSwagger UI fer yer Swagger / OpenAPI Specificat'ns\nTabbed views Show rrrambl'n 'n tabbed views\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nChapter 4 This could be yours Start yer success story. Now!\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nIn Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\nTypes Th' Relearrrn theme defines two types o' planks. Default an' Chapter. Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.\nChapter A Chapter 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 rrrambl'n that can be found under it.\nYe can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an ay'con.\n+++ chapter = true pre = \"\u003cb\u003e1. \u003c/b\u003e\" title = \"Basics\" weight = 5 +++ ### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it. T' tell th' Relearrrn theme t' consider a plank as a chapter, set chapter=true 'n th' Front Matter o' th' plank.\nDefault A Default plank be any other rrrambl'n plank.\n+++ title = \"Installation\" weight = 15 +++ 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 great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\nFront Matter configurat'n Each Cap'n Hugo plank has t' define a Front Matter 'n toml, yaml or json. This ship will use toml 'n all cases.\nTh' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :\n+++ # T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it. # Avast: Toc be always disabled fer chapter planks disableToc = false # If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules fer th' expand state o' a page's menu entry alwaysopen = true # If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries ordersectionsby = \"title\" # Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n pre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n post = \"\"#Setth'plan
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nChapter 5 Tests Some planks fer internal test'n o' differnt styles\nCode Some test'n fer different styles used 'n rules highlightn'n an' preformatted blocks\nImages Some test'n fer different styles o' image links\nLinks Some test'n fer different styles o' links\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nUs'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes.\nIt be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.\nChapter T' create a Chapter plank, run th' follow'n commands\nhugo new --kind chapter \u003cname\u003e/_index.md It will create a plank wit' predefined Front-Matter:\n+++ chapter = true pre = \"\u003cb\u003eX. \u003c/b\u003e\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ ### Chapter X # Some Chapter title Lorem Ipsum. Default T' create a default plank, run either one o' th' follow'n commands either\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md It will create a plank wit' predefined Front-Matter:\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ Lorem Ipsum. ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 1-1 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download latest version o' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac) : it’s that simple.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' 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 learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Install th' theme Install th' Relearrrn theme by follow'n this documentat'n\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (config.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Create yer first chapter plank Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.\n### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it. renders as\nTh' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command\nhugo new --kind chapter basics/_index.md By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serve Go t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugo A public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' Relearrrn theme uses Hugo’s built-in rules highlight'n fer code.\nMarrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders t':\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Cap'n Hugo comes wit' a remark'ble list o' supported languages.\nRecommended configurat'n Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml\n[marrrkup] [marrrkup.highlight] # if set t' `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this be a mandatory # sett'n fer yer ship guessSyntax = false # choose a color theme or create yer own style = \"base16-snazzy\" ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nGlobal ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default).\nAvast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) 'n th' # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true; # this can be overridden 'n th' planks frontmatter alwaysopen = true # Prefix URL t' edit current plank. Will display an \"Edit\" button on top right hand corner o' every plank. # Useful t' give opportunity t' people t' create merge request fer yer doc. # See th' config.toml file from this documentat'n ship t' have an example. editURL = \"\" # Author o' th' ship, will be used 'n meta informat'n author = \"\" # Descript'n o' th' ship, will be used 'n meta informat'n descript'n = \"\" # Shows a checkmark fer visited planks on th' menu showVisitedLinks = false # Dis'ble search funct'n. It will hide search bar disableSearch = false # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box disableSearchHiddenPages = false # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden disableTagHiddenPages = false # Javascript an' CSS cache be automatically busted when new version o' ship be generated. # Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization) disableAssetsBust'n = false # Set this t' true t' dis'ble copy-to-clipboard button fer inline code. disableInlineCopyToClipBoard = false # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it. disableShortcutsTitle = false # If set t' false, a Home button will appear below th' search bar on th' menu. # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be \"/\") disableLandingPageButton = true # When us'n mulitlingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs 'n th' header an' only show th' current plank title disableBreadcrumb = true # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks disableToc = false # If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shorrrtcode or Merrrmaid codefence be present disableMermaid = false # Specifies th' remote locat'n o' th' Merrrmaid js customMermaidURL = \"https://unpkg.com/mermaid/dist/mermaid.min.js\" # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # If set t' false, board th' Swagger module on every plank regardless if a Swagger shorrrtcode be present disableSwagger = false # Specifies th' remote locat'n o' th' RapiDoc js customSwaggerURL = \"\"https://unpkg.com/rapidoc/dist/rapidoc-min.js\" # Initializat'n parameter fer Swagger, see RapiDoc documentat'n swaggerInitialize = \"{ \\\"theme\\\": \\\"light\\\" }\" # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n disableNextPrev = true # Order sections 'n menu by \"weight\" or \"title\". Default t' \"weight\"; # this can be overridden 'n th' planks frontmatter ordersectionsby = \"weight\" # Change default color scheme wit' a variant one. Eg. can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"relearn-light\" # Change th' title separator. Default t' \"::\". titleSeparator = \"-\"#Ifsett'true,th'menu'nth'sidebarwillbedisplayed'nacollaps'bletreeview.collapsibleMenu=falseAwordonrunn'nyership'nasubfolderTh'themerunsbestifyershipbe
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. Not meant t' be overwritten footer.html: th' footer o' th' plank.Not meant t' be overwritten menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Don’t forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s pre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' page’s post sett'n into account. menu-footer.html: footer o' th' the left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n. content-footer: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it. Change th' logo Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically\nChange th' favicon If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file 'n layouts/partials/ named favicon.html. Then write someth'n like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change th' colors Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!\nYe can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.\nSingle variant Set th' themeVariant value wit' th' name o' yer theme file. That’s it!\n[params] themeVariant = \"relearn-light\" In th' above exaple yer theme file has t' be named theme-relearn-light.css\nMultiple variants Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a variant switch will be shown 'n th' menu footer.\n[params] # Change default color scheme wit' a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\"]SmarrrtArrrseIfyewantt'switchth'ruleshighlightn'nthemetogetherwit'yercolorvariant,generatearuleshighlight'nstylesheetan'configureyerinstallat'naccord'nt'Hugo’sdocumentat'n,an'@importthisstylesheet'nyercolorvariantstylesheet.Foranexample,takealookintotheme-relearn-light.cssan'config.tomlo'th'exampleSite.\nRollyerownIfyebenothappywit'th'shippedvariantsyecaneithercopyoneo'th'shippedfiles,editthem'natexteditoran'configureth'themeVariantparameter'nyerco
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nYe can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overriden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n[Shortcuts-Title] other = \"\u003cYour value\u003e\" Read more about hugo menu an' hugo i18n translat'n str'ns\nConfigurat'n fer Multilingual mode When us'n a multilingual website, ye can set different menus fer each language. In th' config.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" url = \"more/credits/\" weight = 30 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" url = \"tags/\" weight = 40 Read more about hugo menu an' hugo multilingual menus\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis interactive tool may help ye t' generate yer own color variant stylesheet.\nT' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' differnet head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant switch will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' install it 'n yer ship.\nAvast This only works 'n modern browsers.\nVariant generator Download variant Reset variant\nGraph Download variant Reset variant\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' Relearrrn theme fer Cap'n Hugo loads th' Font Awesome library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.\nFind'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.\nTh' HTML t' include th' heart ay'con be:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Includ'n 'n markdown Paste th' \u003ci\u003e HTML into marrrkup an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n Hugo Which appears as\nBuilt wit' by Relearrrn an' Cap'n Hugo\nCustomis'n ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nIt provides:\nTranslat'n str'ns fer default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free t' contribute! Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.\nFor example wit' current English an' Piratized English website.\n# English be th' default language defaultContentLanguage = \"en\" [Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug Front Matter parameter t' translate urls too.\nOverwrite translat'n str'ns Translat'ns str'ns be used fer common default values used 'n th' theme (Edit button, Search placeholder an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.\nT' override these values, create a new file 'n yer local i18n folder i18n/\u003cidlanguage\u003e.toml an' inspire yourself from th' theme themes/hugo-theme-relearn/i18n/en.toml\nDis'ble language switch'n Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.\nJust set disableLanguageSwitchingButton=true 'n yer config.toml\n[params] # When us'n mulitlingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = true ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 3-1 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye aren’t view'n this plank or its children directly.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.\nConfigurat'n Just add tags t' any plank:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.\nEach tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.\nList all th' tags In th' config.toml file ye can add a shortcut t' display all th' tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ",
"content":" Attachments NoTreasure.txt (26 B) Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' attachments shorrrtcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage {{% attachments /%}} Th' shortcurt lists files found 'n a specific folder.\nCurrently, it supports two implementat'ns fer planks\nIf yer plank be a Marrrkdown file, attachements must be placed 'n a folder named like yer plank an' end'n wit' .files.\nrrrambl'n _index.md plank.files attachment.pdf plank.md If yer plank be a folder, attachements must be placed 'n a nested files folder.\nrrrambl'n _index.md plank index.md files attachment.pdf Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages.\nParameter Name Default Notes style transparent Th' color scheme used t' highlight th' box rrrambl'n.- by severity: info, note, tip, warning\u003cnd color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default,t` title see notes Arbitray text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwault.- fer severity styles: th' match'n title fer th' severity- fer all other colors: AttachmentsIf ye wa ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n le** there may be a default ay'con. Any given value will overwrite th' default.- fer severity styles: a nice match'n iseverity- fer all other colors: paperclipIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:- t' match a file suffix o' ‘jpg’, use .*jpg (not *.jpg)- t' match file names end'n 'n jpg or png, use .*(jpg|png) Examples Custom Title, List o' Attachments End'n 'n pdf or mp4 {{% attachments title=\"Related files\" pattern=\".*(pdf|mp4)\" /%}} Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Ahoi Styled Box, Descend'n Sort Order {{% attachments style=\"info\" sort=\"desc\" /%}} Ahoi movieselectricsheep-flock-244-32500-2.mp4 (340 KB) hugo.txt (20 B) hugo.png (17 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) BachGavotteShort.mp3 (357 KB) adivorciarsetoca00cape.pdf (361 KB) Style an' Ay'cons For further examples fer style, title an' ay'con, see th' notice shorrrtcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' button shorrrtcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo Usage {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Th' destinat'n URL fer th' button. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble. style transparent Th' color scheme used t' paint th' button.- by severity: info, note, tip, warning- by brand color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default, transparent ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.- fer severity styles: a nice match'n ay'con fer th' severity- fer all other colors: \u003cempty\u003eIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. \u003ccontent\u003e see notes Arbitray text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.- fer severity styles: th' match'n title fer th' severity- fer all other colors: \u003cempty\u003eIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo By Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Ay'con T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" ay'con-posit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Other Severity Style wit' all Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nCap'n Hugo Relearrrn Theme Th' Relearrrn theme be a theme fer Cap'n Hugo, a static website generator written 'n Go. Whar' Cap'n Hugo be often used fer blogs, this theme be designed wit' documentat'n 'n mind.\nAhoi Th' theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.\nMain features Smarrrt Arrrse See what’s new within th' latest update.\nUs'ble offline, no external dependencies Support fer Internet Explorer 11 Responsive design Configur'ble hidden planks Automatic next/prev buttons t' navigate through menu entries Automatic Search Print whole chapters or even th' complete ship Multilingual mode fer English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese Unrestricted menu configurat'n relat'n t' amount o' items an' level o' nest'n Font Awesome ay'cons Tagg'n support Image resiz'n, shadow… Rules highlight'n Attachments files List child planks Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Swagger UI fer OpenAPI Specificat'ns Customiz'ble look an' feel Predefined (light, dark) an' customiz'ble color variants Buttons Tip/Note/Info/Warn'n boxes Expand Tabs File inclusion Gett'n support T' get support, feel free t' open a new discussion topic or issue 'n th' official repository on GitHub.\nBecome a contributor Feel free t' update this documentat'n by just click'n th' Edit link displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed.\nYe be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' official repository via GitHub. Please visit th' contribut'n guidelines first.\nLicense This theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others. See th' credits fer a detailed list.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' children shorrrtcode lists th' child planks o' a plank an' its descendants .\nUsage {{% children %}} Parameter Name Default Notes plank \u003ccurrent\u003e Specify th' plank name (section name) t' display children fer. containerstyle ul Choose th' style used t' group all children. It could be any HTML tag name. style li Choose th' style used t' display each descendant. It could be any HTML tag name. showhidden false When true, child planks hidden from th' menu will be displayed aswell. descript'n false When true shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - read more info about summaries on gohugo.io. depth 1 Th' depth o' descendants t' display. For example, if th' value be 2, th' shorrrtcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort see notes Th' sort order o' th' displayed list.If not set it be sorted by th' ordersectionsby sett'n o' th' ship an' th' planks frontmatter- weight: t' sort on menu order- title: t' sort alphabetically on menu label. Examples All Default {{% children %}} plank X plank 1 plank 2 plank 3 Wit' Descript'n {{% children descript'n=\"true\" %}} plank X This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1 This be a demo child plank\nplank 2 This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3 This be a demo child plank\nInfinte Depth an' Hidden Planks {{% children depth=\"999\" showhidden=\"true\" %}} plank X plank 1 plank 1-1 plank 1-1-1 (hidden) plank 1-1-1-1 plank 1-1-1-1-1 (hidden) plank 1-1-1-1-1-1 plank 1-1-2 plank 1-1-2-1 plank 1-1-2-2 plank 1-1-3 plank 2 plank 3 plank 3-1 plank 4 (hidden) Head'n Styles fer Container an' Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" descript'n=\"true\" %}} plank X This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1 This be a demo child plank\nplank 1-1 This be a demo child plank\nplank 1-1-2 This be a demo child plank\nplank 1-1-3 This be a demo child plank\nplank 2 This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3 This be a demo child plank\nplank 3-1 This be a plain plank test nested 'n a parent\nDivs fer Group an' Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} plank X plank 1 plank 1-1 plank 1-1-2 plank 1-1-3 plank 2 plank 3 plank 3-1 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nSome test'n fer different styles used 'n rules highlightn'n an' preformatted blocks.\nInline Code This be some very long inline code. Whar' does it wrap?\nWhat about wrapp'n short inline code if multiple sections be written side by side?\nWhat about wrapp'n short inline code if multiple sections be written side/by/side?\nWhat about wrapp'n long inline code if multiple sections be written side567 by34567 side567?\nWhat about wrapp'n long inline code if multiple sections be written side567/by34567/side567?\nCan we just use a simple HTML element ?\nBlock Code Code fences without any selected language { \"well\": \"some JSON 'n codefences 'n here\" } { \"well\": \"some JSON 'n HTML elements here\" } Block Preformatted Some preformatted stuff wit' markdown indent'n Some preformatted stuff 'n HTML elements ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nContributors Special thanks t' everyone who has contributed t' this project.\nMany thanks t' Mathieu Cornic fer his work on port'n th' Learrrn theme t' Cap'n Hugo.\nMany thanks t' Andy Miller fer initially creat'n th' Learrrn theme fer Grav.\nPackages an' libraries autoComplete - A lightweight an' powerful vanilla JavaScript complet'n suggester clipboard.js - A modern approach t' copy text t' clipboard Featherlight - A lightweight jQuery lightbox plugin Font Awesome - Th' internet’s ay'con library an' toolkit jQuery - Th' “Write less, do more” JavaScript library jquery-svg-zoom-pan - A jQuery plugin t' en'ble pan an' zoom 'n SVG images Lunr - Enables a great search experience without th' need fer external, server-side, search services Merrrmaid - Generat'n o' diagram an' flowchart from text 'n a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin RapiDoc - Create beautiful, customiz'ble, interactive API documentat'n from OpenAPI Specificat'ns Tool'n GitHub - Continuous deployement, test'n an' host'n o' this project’s sources an' its documentat'n gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' expand shorrrtcode displays an expandable/collaps'ble section o' text.\nExpand me... Thank ye! Usage While th' examples be us'n named parameter ye be free t' use positional aswell.\nnamed positional {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} Parameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitray text t' appear next t' th' expand/collapse ay'con. open 2 false When true th' rrrambl'n text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitray text t' be displayed on expand. Examples All Defaults {{% expand %}}Yes, ye did it!{{% /expand %}} Expand me... Yes, ye did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need t' press ye!{{% /expand %}} Expand me... No need t' press ye! Arbitrary Text {{% expand title=\"Show me almost endless possibilities\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /expand %}} Show me almost endless possibilities Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nSome test'n fer different styles o' image links.\nMarrrkdown Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator HTML Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' include shorrrtcode includes other files from yer project inside o' th' current plank.\nUsage While th' examples be us'n named parameter ye be free t' use positional aswell.\nnamed positional {{% include file=\"shortcodes/INCLUDE_ME.md\" %}} {{% include \"shortcodes/INCLUDE_ME.md\" %}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' file t' be included. Path resolut'n adheres t' Hugo’s build-in readFile funct'n showfirsthead'n 2 true When false an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Examples Arbitray Rrrambl'n {{% include \"shortcodes/INCLUDE_ME.md\" %}} Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nSome test'n fer different styles o' links.\nMarrrkdown Relative t' plank: Relative t' plank up level: Static: ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nWit' th' Merrrmaid library an' shorrrtcode, ye can generate diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown.\ngraph LR; If --\u003e Then Then --\u003e Else Avast This only works 'n modern browsers.\nArrr Due t' limitat'ns wit' Merrrmaid, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed expand shorrrtcode. This be a know issue an' can’t be fixed by this theme.\nUsage Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nWhile th' examples be us'n shorrrtcode rules it be recommended t' use codefence rules instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shorrrtcode ```mermaid graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} Parameter Parameter be only supported when us'n shorrrtcode rules. Defaults be used when us'n codefence rules.\nName Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer mermaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml, frontmatter or diagram directives.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [marrrkup] [marrrkup.highlight] # if set t' `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this be a mandatory # sett'n fer yer ship guessSyntax = false Page’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ Examples Flowchart wit' Non-Default Merrrmaid Theme {{\u003c mermaid align=\"left\" \u003e}} %%{init:{\"theme\":\"forest\"}}%% graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%%graphLR;A[Hardedge]--\u003e|Linktext|B(Roundedge)B--\u003eC{Decision}C--\u003e|One|D[Resultone]C--\u003e|Two|E[Resulttwo]Sequence{{\u003cmermaid\u003e}}sequenceDiagramparticipantAliceparticipantBobAlice-\u003e\u003eJohn:HelloJohn,howbeye?loopHealthcheckJohn-\u003eJohn:FightagainsthypochondriaendAvastrighto'John:Rationalthoughts\u003cbr/\u003eprevail...John--\u003eAlice:Great!John-\u003eBob:Howaboutye?Bob--\u003eJohn:Jollybloody!{{\u003c/mermaid\u003e}}sequenceDiagramparticipantAliceparticipantBobAlice-\u003e\u003eJohn:HelloJohn,howbeye?loopHealthcheckJohn-\u003eJohn:FightagainsthypochondriaendNoterightofJohn:Rationalthoughtsprevail...John--\u003eAlice:Great!John-\u003eBob:Howaboutye?Bob--\u003eJohn:Jollybloody!GANTT{{\u003cmermaid\u003e}}ganttdateFormatYYYY-MM-DDtitleAdd'nGANTTdiagramfunctionalityt'MerrrmaidsectionAsectionCompletedtask:done,des1,2014-01-06,2014-01-08Activetask:active,des2,2014-01-09,3dFuturetask:des3,
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' notice shorrrtcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n named parameter ye be free t' use positional aswell.\nnamed positional {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} Parameter Name Posit'n Default Notes style 1 default Th' color scheme used t' highlight th' box rrrambl'n.- by severity: info, note, tip, warning- by brand color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default, transparent title 2 see notes Arbitray text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.- fer severity styles: th' match'n title fer th' severity- fer all other colors: \u003cempty\u003eIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.- fer severity styles: a nice match'n ay'con fer th' severity- fer all other colors: \u003cempty\u003eIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples By Severity Ahoi wit' marrrkup Ahoi An informat'n disclaimer\nYe can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)\nShow marrrkup {{% notice style=\"info\" %}} An **informat'n** disclaimer Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Avast Avast A notice disclaimer\nShow marrrkup {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Smarrrt Arrrse Smarrrt Arrrse A tip disclaimer\nShow marrrkup {{% notice style=\"tip\" %}} A **tip** disclaimer Arrr Arrr A warning disclaimer\nShow marrrkup {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr wit' Non-Default Title an' Ay'con Here be dragons A warning disclaimer\nShow marrrkup {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Arrr without a Title an' Ay'con A warning disclaimer\nShow marrrkup {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} By Brand Colors Primary wit' Title only Primary A primary disclaimer\nShow marrrkup {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Secondary wit' Ay'con only A secondary disclaimer\nShow marrrkup {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} By Color Blue without a Title an' Ay'con A blue disclaimer\nShow marrrkup {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} Green wit' Title only Green A green disclaimer\nShow marrrkup {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Grey wit' Ay'con only A grey disclaimer\nShow marrrkup {{% notice style=\"grey\" ay'con=\"bug\" %}} A **grey** disclaimer {{% /notice %}} Orange wit' Title an' Ay'con Orange A orange disclaimer\nShow marrrkup {{% notice style=\"orange\" title=\"Orange\" ay'con=\"bug\"%}}A**orange**disclaime
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1 (hidden) plank 1-1-2 plank 1-1-3 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1-1-1 (hidden) ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\nSubpages o' this plank plank 1-1-2-1 plank 1-1-2-2 ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis be a plain demo child plank.\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' siteparam shorrrtcode prints values o' ship params.\nUsage While th' examples be us'n named parameter ye be free t' use positional aswell.\nnamed positional {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=\"editURL\" %}} editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nGoboLinux Wiki by NEONsys.org BITS by Dr. Lutz Gollan Pamasol Electrics by Pamasol – Swiss Aerosol Solut'ns ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nThis shorrrtcode uses th' RapiDoc library t' display yer Swagger / OpenAPI Specificat'ns.\nAvast This only works 'n modern browsers.\nUsage {{\u003c swagger src=\"https://petstore3.swagger.io/api/v3/openapi.json\" \u003e}} Parameter Name Default Notes src \u003cempty\u003e Th' URL t' th' OpenAPI Specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle. Configurat'n Swagger be configured wit' default sett'ns. Ye can cust'mize Swagger’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Swagger’s initializat'n. At th' moment, only th' theme sett'n be supported.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml or frontmatter.\nGlobal Configurat'n File [params] swaggerInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" Example Us'n Local File {{\u003c swagger src=\"petstore.json\" \u003e}} ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nTh' tabs shorrrtcode displays arbitrary rrrambl'n 'n unlimited number o' tabs. This comes 'n handy eg. fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.\npython bash print(\"Hello World!\") echo \"Hello World!\" Usage {{\u003c tabs \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} Parameter Name Default Notes groupId default Arbitrary name o' th' group th' tab view belongs t'.Tab views wit' th' same groupId sychr'nize their selected tab. This sychronizat'n applies t' th' whole ship! \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Arrr When us'n tab views wit' different rrrambl'n sets, make sure t' use a common groupId fer equal sets o' tabs but distinct groupId fer different sets.\nTh' tab select'n be restored automatically based on th' groupId an' if it cannot find a tab item because it came from th' 'default' group on a different plank then all tabs will be empty at first!\nExamples Distinct groupId {{\u003c tabs groupId=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab name=\"properties\" %}} ```properties Hello = World ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML properties { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello = World Non-Distinct groupId See what happens t' this tab view if ye select properties tab from th' previous example.\n{{\u003c tabs groupId=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e ",
"content":" Arrr! Pirrrates Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.\nPlaceholder…\n",
