"content":"In 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”\nCreate yer project 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 great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eTh' Relearrrn theme provides archetypes t' help ye create this kind o' planks.",
"content":" Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' history plank.\n0.121.0 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n6.2.0.beta (XXXX-XX-XX) New If ye be runn'n Hugo 0.132.0 or later, th' theme be now cap'ble t' print GitHub styled alerts.\nNew T' support new severity levels fer GitHub styled alerts, all shorrrtcodes that support severity levels wit' their style parameter were expanded wit' th' new severities caut'n an' important an' th' color parameter was expanded wit' cyan an' magenta. Please note, that color'n an' ay'cons o' severities may defer from th' display ye see on GitHub.\nNew T' support new severity levels fer GitHub styled alerts, th' new severities an' their accord'n colors be also avail'ble ass CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as appropriate default colors will be used.\n6.1.0 (2024-08-02) Change Th' include shortcode be now able t' resolve links t' planks as well as resources or files 'n th' file system (the old behavior).\nChange T' make th' asset buster mechanism more robust, some internally used stylesheets whar' restructured. This generally should not affect yer plank 'n any negative way.\nNew Th' openapi shortcode be now able t' resolve links t' resources as well as t' files 'n th' file system (the old behavior). Ye can configure t' generate warnings or errors dur'n build by sett'n openapi.errorlevel t' either warning or error 'n yer hugo.toml if a path can not be resolved.\nNew Shorrrtcodes support'n an errorlevel configurat'n can now have overridden values 'n th' frontmatter section o' each individual plank.\nNew Th' theme now comes wit' its own overridden version o' th' relref shortcode.\nWhile th' usage o' relref be obsolete an' discouraged by Cap'n Hugo fer a while, exist'n installat'ns may use it. In configurat'ns us'n a baseURL wit' a subdirectory, an' hav'n relativeURLs=false (the default) Hugo’s standard relref implementat'n was fail'n.\nTh' shortcode be deactivated by default an' can be activated by sett'n\nhugo. toml yaml json [params] disableDefaultRelref = true params: disableDefaultRelref: true { \"params\": { \"disableDefaultRelref\":true}}'n yer hugo.toml. Only do this if yer ship fulfills all o'th' above assumpt'ns.\n6.0.0(2024-04-27)Break'n This release requires ye t'moveyerself-definedvariant(theme-*.css)an' chroma stylesheets (chroma-*.css) from static/css t'assets/css.\nThiswasnecessaryt' avoid permission errors on build if runn'n'n certain Unix configurat'ns.\nInaddit'n it be not allowed anymore t'@importyerchromastylesheetfrominsideo' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t'addth' follow'ninsideyervariantstylesheet:\n--CODE-theme:monokai;Break'n Th'parameterdescript'n 'nyerhugo.tomlwillnowbeignored.\nWit' th'newlyintroducedunifiedhandl'n o'descript'ns throughout th'theme,th' only place th'oldparameterwouldhavebeenusedwasyerhomeplank.\nFormigrat'n, move th'descript'n parameter o'yerhugo.tomlintoth' frontmatter section o'yerhomeplank.\nBreak'n Search support fer th'jsonoutputformatdeprecated'n 5.4.0 was removed.\nChange it t'searchferth' homepage 'nyerhugo.toml.Seeth' docs fer detailed configurat'n.\nBreak'n Th'frontmatteropt'n menuTitle deprecated 'n5.24.0wasremoved'nfavorferHugo’sownlinkTitle
"content":"Us'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. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n _index.md +++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter 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 below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n _index.md +++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 1 +++ Lorem Ipsum. Th' weight number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n *.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Self defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n \u003ckind\u003e.md +++ archetype = \"\u003ckind\u003e\" +++ Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.",
"content":"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 shortcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nBadgeMarker badges t' display 'n yer text\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nHighlightRender code wit' a rules highlighter\nAy'conNice ay'cons fer yer plank\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nOpenAPIUI fer yer OpenAPI / Swagger specificat'ns\nResourcesList resources contained 'n a plank bundle\nSiteParamGet value o' ship params\nTabShow rrrambl'n 'n a single tab\nTabsShow rrrambl'n 'n tabbed views",
"content":"This chapter contains informat'n only needed fer development an' maintain'n th' theme.\nContribut'nWhat t' know if ye want t' contribute\nMaintain'nWhat t' know as a maintainer\nScreenshotsRecipe t' create various documentat'n screenshots",
"content":"Let’sfaceit:Writ'n rrrambl'nferth' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'nhorr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t'writeHTML,withoutallth' complexities an'uglinessthatusuallyaccompaniesit.\nSomeo' th'keybenefitsbe:\nMarrrkdownbesimplet' learn, wit'minimalextracharacterssoit’salsoquickert' write rrrambl'n.Lesschanceo' errors when writ'n'n Marrrkdown. Produces valid HTML output. Keeps th'rrrambl'n an'th' visual display separate, so ye cannot mess up th'looko' yer ship. Write 'nanytexteditororMarrrkdownapplicat'n ye like. Marrrkdown be a joy t'use!JohnGruber,th' author o'Marrrkdown,putsitlikethis:\nTh' overrid'ndesigngoalferMarkdown’sformatt'n rules be t'makeitasread'ble as poss'ble.Th' idea be that a Markdown-formatted document should be publish'bleas-is,asplaintext,withoutlook'n like it’s been marked up wit'tagsorformatt'n instruct'ns.WhileMarkdown’sruleshasbeeninfluencedbyseveralexist'n text-to-HTML filters, th'singlebiggestsourceo' inspirat'nferMarkdown’srulesbeth' format o'plaintextemail.JohnGruber\nSmarrrtArrrseBookmarkthisplankfereasyfuturereference!\nStandardan' Extensions If not otherwise noted, th'shownexamplesadheret' th'Commonmarkstandard.Inaddit'n th'themesupportsth' follow'nextensionsthatcanbeactivated'n yer hugo.toml or be built into th'theme:\nGFMExtensionontopo' standard Marrrkdown adher'nt' GitHub Flavored Marrrkdown.\nPHP Extension on top o'standardMarrrkdownadher'n t'PHPMarrrkdown.\nPantsExtensionbyJohnGruberadher'n t'SmartyPants.\nCap'n Hugo Cap'nHugoExtraExtensionsupportedbyCap'n Hugo.\nRelearrrn Extension specific t'thistheme.\nHTMLIfth' usage o'HTMLbeallowed,th' theme supports styl'nferfurtherHTMLelements.\nParagraphsInMarrrkdownyerrrrambl'n usually spans th'wholeavail'ble document width. This be called a block. Blocks be always separated by whitespace t'theiradjacentblocks'n th'result'n document.\nAny text not start'nwit' a special sign be written as normal, plain text paragraph block an'mustbeseparatedt' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'nsAbloodyideabet' structure yer rrrambl'nus'n head'nsan' subhead'ns.HTML-head'ns from h1 through h6 be constructed wit'a#fereachlevel.\nInHugoyeusuallydon’tuseh1asthisbegeneratedbyyerthemean' ye should only have one such element 'nadocument.\n#h1Head'n ## h2 Head'n###h3Head'n #### h4 Head'n#####h5Head'n ###### h6 Head'nResulth1Head'n h2 Head'nh3Head'n h4 Head'nh5Head'n h6 Head'nHorizontalRulesT' further structure yer rrrambl'nyecanaddhorizontalrules.Theycreatea“thematicbreak”betweenparagraphblocks.InMarrrkdown,yecancreateitwit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nBlockquotes For quot'nblockso' rrrambl'nfromanothersourcewithinyerdocumentadd\u003ebeforeanytex
"description":"Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.",
"content":"Th' theme supports non-standard image effects.\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer hugo.toml as well as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer hugo.toml this defaults t'\nhugo. toml yaml json [params] [params.imageEffects] border = false lazy = true lightbox = true shadow = false params: imageEffects: border: false lazy: true lightbox: true shadow: false { \"params\": { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } } This can be overridden 'n a planks frontmatter by eg.\n toml yaml json +++ [imageEffects] border = true +++ --- imageEffects: border: true --- { \"imageEffects\": { \"border\": true } } Or by explicitly override sett'ns by URL query parameter\n URL  Th' sett'ns applied t' th' above image would be\n toml yaml json bg-white = true border = true lazy = true lightbox = false shadow = false bg-white: true border: true lazy: true lightbox: false shadow: false { \"bg-white\": true, \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false } This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" load'n=\"lazy\" alt=\"Minion\" class=\"bg-white border lazy nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer hugo.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' hugo.toml or planks frontmatter.",
"description":"Th' theme supports non-standard image effects.\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank.",
"content":"Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nAvail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left 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 hugo.toml file.\nFor example wit' current English an' Piratized English website.\nAvast Make sure yer default language be defined as th' first one 'n th' [languages] array, as th' theme needs t' make assumpt'ns on it\nhugo. toml yaml json defaultContentLanguage = 'en' [languages] [languages.en] languageName = 'English' title = 'Hugo Relearrrn Theme' weight = 1 [languages.pir] languageName = 'Arrr! Pirrrates' title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 defaultContentLanguage: en languages: en: languageName: English title: Cap'n Hugo Relearrrn Theme weight: 1 pir: languageName: Arrr! Pirrrates title: Cap'n Hugo Relearrrn Theme weight: 2 { \"defaultContentLanguage\": \"en\", \"languages\": { \"en\": { \"languageName\": \"English\", \"title\": \"Hugo Relearrrn Theme\", \"weight\": 1 }, \"pir\": { \"languageName\": \"Arrr! Pirrrates\", \"title\": \"Cap'n Hugo Relearrrn Theme\", \"weight\": 2 } } } 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 frontmatter parameter t' translate urls too.\nSearch In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' site’s search via th' Lunr search library does not. You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nCzech Indonesian Polish Swahili Search wit' mixed language support In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer hugo.toml t' broaden search.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] params: additionalContentLanguage: - en { \"params\": { \"additionalContentLanguage\": [ \"en\" ] } } As this be an array, ye can add multiple additional languages.\nAvast Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n zh-CN, ye have t' add just zh t' this parameter.\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 hugo.toml\nhugo. toml yaml json [params] disableLanguageSwitchingButton = true params: disableLanguageSwitchingButton: true { \"params\": { \"disableLanguageSwitchingButton\": true } } ",
"content":"Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box.\nConfigurat'n Just add tags and/or categories t' any plank. They can be given as a single str'n or an array o' str'ns.\n toml yaml json +++ categories = ['taxonomy', 'content'] tags = 'tutorial' title = 'Taxonomy' +++ --- categories: - taxonomy - rrrambl'n tags: tutorial title: Taxonomy --- { \"categories\": [ \"taxonomy\", \"content\" ], \"tags\": \"tutorial\", \"title\": \"Taxonomy\" } Behavior Th' tags be displayed at th' top o' th' plank 'n alphabetical order.\nTh' categories be displayed at th' bottom o' th' plank 'n alphabetical order 'n th' default implementat'n o' th' theme but can be customized by provid'n yer own content-footer.html partial.\nEach item be a link t' a taxonomy plank display'n all th' articles wit' th' given term.\nList all th' tags In th' hugo.toml file ye can add a shortcut t' display all th' tags an' categories\nhugo. toml yaml json [menu] [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" url = '/tags' [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = '/categories' menu: shortcuts: - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags url: /tags - name: \u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories url: /categories { \"menu\": { \"shortcuts\": [ { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"url\": \"/tags\" }, { \"name\": \"\\u003ci class='fa-fw fas fa-layer-group'\\u003e\\u003c/i\\u003e Categories\", \"url\": \"/categories\" } ] } } Customizat'n If ye define custom taxonomies an' want t' display a list o' them somewhere on yer plank (often 'n th' layouts/partials/content-footer.html) ye can call a partial that does th' job fer ye:\n{{ partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. taxonomy \u003cempty\u003e Th' plural name o' th' taxonomy t' display as used 'n yer frontmatter. class \u003cempty\u003e Additional CSS classes set on th' outermost generated HTML element.\nIf set t' tags ye will get th' visuals fer display'n th' tags taxonomy, otherwise it will be a simple list o' links as fer th' categories taxonomy. style primary Th' style scheme used if class be tags.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used if class be tags. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con \u003cempty\u003e An optional Font Awesome ay'con name set t' th' left o' th' list. ",
"content":"Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download at least version 0.121.0 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).\nIt’s a kind o' magic",
"content":"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 learn more about it by follow'n this great documentat'n fer beginners.\nSmarrrt Arrrse Th' follow'n tutorial leads ye through th' steps o' creat'n a first, minimal new ship.\nYe don’t need t' edit any files besides yer hugo.toml an' only need t' execute th' commands 'n th' given order.\nCreate yer Project Cap'n Hugo provides th' new command t' create a new website:\nhugo new ship my-new-siteAft that change into th' directory:\ncd my-new-siteEvery upcom'n command will be executed from inside yer new site’s root.\nInstall th' Theme Download'n as Archive Ye can download th' theme as .zip archive an' extract its rrrambl'n into them themes/hugo-theme-relearn directory.\nAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Us'n Hugo’s Module System Ye can install th' Relearrrn theme by follow'n th' standard documentat'n us'n Hugo’s module system:\nhugo mod init example.comAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Us'n Git Submodules If ye plan t' store yer project 'n a git repository ye can create one wit':\ngit initNow add th' theme as a submodule by:\ngit submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearnAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\"}CreateyerHomePlankIfyedon’tcreateahomeplank,yet,th' theme will generate a placeholder text wit'instruct'ns on how t'proceed.\nStartyerjourneybycreat'n a home plank:\nhugo new --kind home _index.mdTh'newlycreatedhomeplankcontent/_index.mdbeemptyan' ye obviously should add some meaningful rrrambl'n.\nCreateyerFirstChapterPlankChaptersbemeantt' be top level planks that contain other child planks. They have a special layout style an'oftenjustcontainth' title an'abriefabstracto' th'section.\nNowcreateyerfirstchapterplankwit' th'follow'n command:\nhugo new --kind chapter basics/_index.mdWhen open'nth' newly created file content/basics/_index.md, ye should see th'weightfrontmatterwit' a number. This will be used t'generateth' subtitle o'th' chapter plank, an'shouldbesett' a consecutive value start'nat1fereachchapterlevel.\nCreateyerFirstRrrambl'n Planks Then create rrrambl'nplanksinsideth' previously created chapter. Here be three ways t'createrrrambl'n 'nth' chapter:\nhugo new basics/first-content/_index.md hugo new basics/second-content/index.md hugo new basics/third-content.mdFeel free t'editthosefilesbyadd'n some sample rrrambl'nan' replac'nth' title value 'nth' beginn'no' th'files.\nAvastPleasenotethatCap'n Hugo overrides th'defaultarchetypetemplatecom'n wit'thisthemewhenus'n hugo new ship my-new-site. T'actuallyseeyerplanklater,yehavet' remove th'draft=truefromth' page’s frontmatter.\nTest'nyerWebsiteLocallyLaunchyernewwebshipbyus'n th'follow'n command:\nhugo serveGo t'http://localhost:1313 'n yer browser.\nYe should notice a few th'ns:\nTh' home plank contains yer provided text. Ye have th' menu Basics 'n th' sidebar. Click'n on it reveals three submenus wit' names equal t' th' title properties 'n th' previously created rrrambl'n planks. While ye be runn'n hugo serve yer plank refreshes automatically when ye change a rrrambl'n plank. Neat! Build an' Deploy yer Website When yer ship be ready t' be deployed, run th' follow'n command:\nhugoA public directory will be generated, contain'n all rrrambl'n an' assets fer yer web ship.\nIt now can be deployed t' any web server by simply upload'n
"content":"Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed through so called color variants.\nA color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo.toml.\nTh' Relearrrn theme ships wit' a wide set o' different color variants. Ye can use them as-is, copy them over an' use them as a start'n point fer yer customizat'ns or just create completely new variants unique t' yer ship. Th' interactive variant generator may help ye wit' this task.\nOnce configured 'n yer hugo.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.\nChange th' Variant (Simple) Single Variant Set th' themeVariant value t' th' name o' yer theme file. That’s it! Yer ship will be displayed 'n this variant only.\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Avast Yer theme variant file must reside 'n yer site’s assets/css directory an' th' file name must start wit' theme- an' end 'n .css. In th' above example, th' path o' yer theme file must be assets/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s assets/css directory. Don’t edit th' file 'n th' theme’s directory!\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Smarrrt Arrrse Th' theme provides an advanced configurat'n mode, combin'n th' functionality fer multiple variants wit' th' below possibilities o' adjust'n t' yer OS sett'ns an' rules highlight'n an' even more!\nAlthough all opt'ns documented here be still work'n, th' advanced configurat'n opt'ns be th' recommended way t' configure yer color variants. See below.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto t' become an auto mode variant. That’s it.\nYe can use th' auto value wit' th' single or multiple variants opt'n. If ye be us'n multiple variants, ye can drop auto at any posit'n 'n th' option’s array, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant opt'n if present.\nIn th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.\nIf ye don’t like that behavior, ye can explicitly set themeVariantAuto. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode.\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\"]}}Changeth' Favicon If yer favicon be a SVG, PNG or ICO, just drop yer image 'nyersite’sstatic/images/directoryan' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf ye want t'adjustyerfaviconaccord'n t'yerOSsett'ns fer light/dark mode, add th'imagefilesstatic/images/favicon-light.svgan' static/images/favicon-dark.svg t'yersite’sdirectory,respectively,correspond'n t'yerfileformat.In
"content":"Usage scenarios Th' theme be us'ble 'n different scenarios, requir'n th' follow'n mandatory sett'ns 'n yer hugo.toml. All sett'ns not mentioned can be set t' yer lik'n.\nPublic Web Server from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { \"baseURL\": \"https://example.com/\" } Public Web Server from Subdirectory hugo. toml yaml json baseURL = 'https://example.com/mysite/' relativeURLs = false baseURL: https://example.com/mysite/ relativeURLs: false { \"baseURL\": \"https://example.com/mysite/\", \"relativeURLs\": false } Private Web Server (LAN) Th' same sett'ns as wit' any o' th' public web server usage scenarios or\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } File System hugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } Arrr Us'n a baseURL wit' a subdirectory an' relativeURLs=true be mutually exclusive due t' th' fact, that Cap'n Hugo does not apply th' baseURL correctly.\nIf ye need both, ye have t' generate yer ship twice but wit' different sett'ns into separate directories.\nAvast Sublemental planks (like sitemap.xml, rss.xml) an' generated social media links inside o' yer planks will always be generated wit' absolute URLs an' will not work if ye set relativeURLs=true.\nAhoi If ye be us'n uglyURLs=false (Hugo’s default), th' theme will append an additional index.html t' all plank links t' make yer ship be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a web server ye can generate th' links without this:\nhugo. toml yaml json [params] disableExplicitIndexURLs = true params: disableExplicitIndexURLs: true { \"params\": { \"disableExplicitIndexURLs\": true } } Activate search If not already present, add th' follow'n lines 'n yer hugo.toml file.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search'] outputs: home: - html - rss - search { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\" ] } } This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library.\nActivate dedicated search plank Ye can add a dedicated search plank fer yer plank by add'n th' searchpage outputformat t' yer home plank by add'n th' follow'n lines 'n yer hugo.toml file. This will cause Cap'n Hugo t' generate a new file http://example.com/mysite/search.html.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search', 'searchpage'] outputs: home: - html - rss - search - searchpage { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\", \"searchpage\" ] } } Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n ENTER inside o' th' menu’s search box .\nAvast T' have Cap'n Hugo create th' dedicated search plank successfully, ye must not generate th' URL http://example.com/mysite/search.html from yer own rrrambl'n. This can happen if ye set uglyURLs=true 'n yer hugo.toml an' defin'n a Marrrkdown file content/search.md.\nT' make sure, there be no duplicate rrrambl'n fer any given URL o' yer project, run hugo --printPathWarn'ns.\nActivate print support Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' print output format t' yer home, section an' plank 'n yer hugo.toml as seen below:\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print', 'search'] plank = ['html', 'rss', 'print'] section = ['html', 'rss', 'print'] outputs: home: - html - rss - print - search plank: - html - rss - print section: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\", \"search\" ], \"page\": [ \"html\", \"rss\", \"print\" ], \"section\": [ \"html\", \"rss\", \"print\"]}}Thiswilladdalittleprinteray'con 'nth' top bar. It will switch th'plankt' print preview when clicked. Ye can then send this plank t'th' printer by us'nyerbrowser’susualprintfu
"content":"This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar 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 reflect how colors be inherited through 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' different 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 selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s assets/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer hugo.toml t' yer chosen file name.\nEg. if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nSee th' docs fer further configurat'n opt'ns\nDownload variant Reset variant\nGraph Download variant Reset variant",
"content":"Th' theme comes wit' a reasonably configured topbar.\nNevertheless, yer requirements may differ from this configurat'n. Luckily th' theme got ye covered as th' themebar, its buttons an' th' functionality behind these buttons be fully configur'ble by ye.\nSmarrrt Arrrse All mentioned file names below can be clicked an' show ye th' implementat'n fer a better understand'n.\nAreas Th' default configurat'n comes wit' three predefined areas that may contain an arbitrary set o' buttons.\nstart: shown between menu an' breadcrumb end: shown on th' opposite breadcrumb side 'n comparison t' th' start area more: shown when press'n th' more button 'n th' topbar While ye can not add additional areas 'n th' topbar, ye be free t' configure additional buttons that behave like th' more button, provid'n further user defined areas.\nButtons Th' theme ships wit' th' follow'n predefined buttons (from left t' right 'n th' screenshot)\nsidebar: opens th' sidebar flyout if 'n mobile layout toc: opens th' t'ble o' contents 'n an overlay edit: browses t' th' edit'ble plank if th' editURL parameter be set print: browses t' th' chapters print'ble plank if print support was activated prev: browses t' th' previous plank if there be one next: browses t' th' next plank if there be one more: opens th' overlay fer th' more area Not all buttons be displayed at every given time. This be configur'ble (see below if interested).\nRedefin'n Areas Each predefined area an' button comes 'n their own file. By that it be easy fer ye t' overwrite an area file 'n yer installat'n reus'n only th' buttons ye like.\nEg. ye can redefine th' predefined end area by add'n th' file layouts/partials/topbar/area/end.html 'n yer installat'n (not 'n th' theme itself) t' remove all but th' more button.\nTh' below example sets an explicit value fer th' onempty parameter, overrid'n th' specific default value fer this button (these defaults vary depend'n on th' button). Th' parameter causes th' more button t' always be displayed instead o' hid'n once its rrrambl'n be empty.\n{{ partial \"topbar/button/more.html\" (dict \"page\" . \"onempty\" \"disable\")}}Defin'n own Buttons Button Types Th'themedistinguishesbetweentwotypeso' buttons:\nbutton: a click'blebuttonthateitherbrowsest' another ship, triggers a user defined script or opens an overlay contain'nuserdefinedrrrambl'n area-button: th'templateferth' more button, t'defineyerownareaoverlaybuttonsButtonParameterScreenWidthsan' Act'nsDepend'n on th'screenwidthyecanconfigurehowth' button should behave. Screen width be divided into three classes:\ns: (controlled by th'onwidthsparameter)mobilelayoutwhar' th'menusidebarbehiddenm:(controlledbyth' onwidthm parameter) desktop layout wit'vis'ble sidebar while th'rrrambl'n area width still resizes l: (controlled by th'onwidthlparameter)desktoplayoutwit' vis'blesidebaronceth' rrrambl'nareareacheditsmaximumwidthForeachwidthclass,yecanconfigureoneo' th'follow'n act'ns:\nshow:th' button be displayed 'nitsgivenareahide:th' button be removed area-XXX: th'buttonbemovedfromitsgivenareaintoth' area XXX; eg. this be used t'movebuttonst' th'moreareaoverlay'n th'mobilelayoutHid'n an'Disabl'n Stuff While hid'nabuttondepend'n on th'screensizecanbeconfiguredwit' th'abovedescribedhideact'n, ye may want t'hideth' button on certain other condit'nsaswell.\nForexample,th' print button 'nitsdefaultconfigurat'n should only be displayed if print support was configured. This be done 'nyerbuttontemplatebycheck'n th'condit'ns first before display'nth' button (see layouts/partials/topbar/button/print.html).\nAnother preferred condit'nferhid'n a button be, if th'displayedoverlaybeempty.Thisbeth' case fer th'toc(seelayouts/partials/topbar/button/toc.html)aswellasth' more button (see layouts/partials/topbar/button/more.html) an'controlledbyth' parameter onempty.\nThis parameter can have one o'th' follow'nvalues:\ndis'ble: th'buttondisplayed'ndisabledsta
"description":"Th' theme comes wit' a reasonably configured topbar.\nNevertheless, yer requirements may differ from this configurat'n.",
"content":"This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.",
"content":" Arrr This shortcode be deprecated 'n favor o' th' new resources shortcode. See migrat'n instruct'ns below.\nTh' examples on this plank were removed.\nTh' attachments shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nMigrat'n While this shortcode will still be avail'ble fer some time, it does not receive support anymore. Start t' migrate early, as it will be removed wit' th' next major update o' th' theme.\nTh' resources shortcode leverages Hugo’s resource feature fer plank bundles. It has all th' same parameter as th' attachments shortcode but applies th' pattern directly on a resources Name attribute.\nT' migrate yer planks apply th' follow'n steps:\nIf a plank be not already a plank bundle convert it Move yer files t' a valid destinat'n inside o' yer plank bundle (depend'n if ye have a branch or a leaf bundle) Change th' calls from th' attachments shortcode t' th' resources shortcode an' adjust th' pattern parameter t' th' new directory layout an' th' resources Name attribute. Multilanguage features be not supported directly by th' shortcode anymore but rely on Hugo’s handl'n fer resource translat'ns.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"page\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Attachments\nIf 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 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \"(anonemptydwit' spaces) sort asc Sort'nth' output 'nascend'n or descend'norder.pattern.*Aregularexpressions,usedt' filter th'attachmentsbyfilename.Forexample:\n-t' match a file suffix o'‘jpg’,use.*\\.jpg(not*.\\.jpg)\n-t' match file names end'n'n jpg or png, use .*\\.(jpg|png) Setup Single language Th'shortcodelistsfilesfound'n a specific folder. Th'nameo' th'folderdependsonyerplanktype(eitherbranchbundle,leafbundleorpage).\nIfyerplankbealeafbundle,attachmentsmustbeplaced'n a nested index.files folder, accordingly.\nrrrambl'n_index.mdplankindex.mdindex.filesattachment.pdfIfyerplankbeabranchbundle,attachmentsmustbeplaced'n a nested _index.files folder, accordingly.\nArrr This be only avail'bleferCap'n Hugo \u003c 0.112.0\nrrrambl'n_index.mdplank_index.md_index.filesattachment.pdfForsimpleplanks,attachmentsmustbeplaced'n a folder named like yer plank an'end'n wit'.files.\nArrrThisbeonlyavail'ble fer Cap'nHugo\u003c0.112.0\nrrrambl'n _index.md plank.files attachment.pdf plank.md Multilingual Be aware that if ye use a multilingual website, ye will need t'haveasmanyfoldersaslanguagesan' th'languagecodemustbeparto' th'foldername.\nEg.feraship'n English an'Piratish:\nrrrambl'nindex.en.mdindex.pir.mdplankindex.en.mdindex.pir.mdindex.en.filesattachment.pdf
"content":"Th' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.\nImportant Version6.6.6 Captain AhoiNew Awesome\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default Th' style scheme used fer th' badge.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' badge title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf 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 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text fer th' badge. Examples Style By Severity {{% badge style=\"caution\" %}}Magenta{{% /badge %}} {{% badge style=\"important\" %}}Cyan{{% /badge %}} {{% badge style=\"info\" %}}Blue{{% /badge %}} {{% badge style=\"note\" %}}Orange{{% /badge %}} {{% badge style=\"tip\" %}}Green{{% /badge %}} {{% badge style=\"warning\" %}}Red{{% /badge %}} Caut'nMagenta ImportantCyan AhoiBlue AvastOrange Smarrrt ArrrseGreen ArrrRed\nBy Brand Colors {{% badge style=\"primary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" ay'con=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"cyan\" ay'con=\"palette\" title=\"Color\" %}}Cyan{{% /badge %}} {{% badge style=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"magenta\" ay'con=\"palette\" title=\"Color\" %}}Magenta{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorCyan ColorGreen ColorGrey ColorMagenta ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\"title=\
"content":"Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% 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 %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf 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. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf 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=\"caution\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"important\" %}}Get Cap'n Hugo{{% /button %}} {{% 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 Get Cap'n Hugo Get Cap'n Hugo\nBy 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 %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\"%}}GetCap'nHugo{{
"content":" Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nCap'n Hugo Relearrrn Theme A theme fer Cap'n Hugo designed fer documentat'n.\n★ What’s new 'n th' latest release ★\nMotivat'n Th' Relearrrn theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adapt'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.\nFeatures Wide set o' usage scenarios Responsive design fer mobile usage Looks nice on paper (if it has to) Us'ble offline, no external dependencies Us'ble from yer local file system via file:// protocol Support fer th' VSCode Front Matter extension fer on-premise CMS capabilities Support fer Open Graph, Schema an' Twitter Cards Configur'ble them'n an' visuals Configur'ble brand images Automatic switch fer light/dark variant depend'n on yer OS sett'ns Predefined light, dark an' color variants User select'ble variants Stylesheet generator Configur'ble rules highlight'n Unique theme features Print whole chapters or even th' complete ship In plank search Ship search Dedicated search plank Taxonomy support Configur'ble topbar buttons Unlimited nested menu items Configur'ble shortcut links Hidden planks Multi language support Full support fer languages written right t' left Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support fer mixed language rrrambl'n Additional Marrrkdown features Support fer GFM (GitHub Flavored Markdown) Image effects like siz'n, shadow, border an' alignment Image lightbox Shorrrtcodes galore Display resources contained 'n a plank bundle Marker badges Configur'ble buttons List child planks Expand areas t' reveal rrrambl'n Font Awesome ay'cons Inclusion o' other files Math an' chemical formulae us'n MathJax Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Colorful boxes OpenAPI specificat'ns us'n Swagger UI Reveal ye site’s configurat'n parameter Single tabbed panels an' multiple tabbed panels Installat'n \u0026 Usage For a detailed descript'n o' th' theme’s capabilities visit th' official documentat'n.\nChangelog See th' What’s New plank fer release highlights or th' detailed change history fer a complete list o' changes.\nContribut'ns Ye be most welcome t' contribute bugfixes or new features. Check th' contribut'n guidelines first before start'n.\nLicense Th' Relearrrn theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others.",
"content":"Th' children shortcode lists th' child planks o' th' current plank an' its descendants.\nplank X plank 1 plank 2 plank 3 Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% children sort=\"weight\" %}} {{ partial \"shortcodes/children.html\" (dict \"page\" . \"sort\" \"weight\" )}} Parameter Name Default Notes 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 as well. 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' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort auto Th' sort criteria o' th' displayed list.\n- auto defaults t' ordersectionsby o' th' planks frontmatter\nor t' ordersectionsby o' th' ship configurat'n\nor t' weight\n- weight\n- title\n- linktitle\n- modifieddate\n- expirydate\n- publishdate\n- date\n- length\n- default adher'n t' Hugo’s default sort criteria Examples All Default {{% children %}} plank X plank 1 plank 2 plank 3 Wit' Descript'n {{% children descript'n=\"true\" %}} plank XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nInfinite 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 (headless) 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 XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 1-1This be a demo child plank\nplank 1-1-2 (headless)This be a demo child plank\nplank 1-1-3This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nplank 3-1This 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 (headless) plank 1-1-3 plank 2 plank 3 plank 3-1 ",
"content":"Code Quality A new release can happen at any time from th' main branch o' th' GitHub project without further acknowledgment. This makes it necessary that, every pushed set o' changesets into th' main branch must be self-contained an' correct, result'n 'n a releas'ble version.\nStay simple fer th' user by focus'n on th' mantra “convent'n over configuration”.\nAt installat'n th' ship should work reason'ble without (m)any configurat'n.\nStay close t' th' Cap'n Hugo way.\nDon’t use npm or any preprocess'n, our contributors may not be front-end developers.\nDocument new features 'n th' exampleSite. This also contains entries t' th' What’s new plank.\nDon’t break exist'n features if ye don’t have t'.\nRemove reported issue from th' browser’s console.\nCheck fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.\nConventional Commits Write commit messages 'n th' conventional commit format.\nFollow'n be an inpomplete list o' some o' th' used conventional commit types. Be creative.\nCommon Feature Structure Shorrrtcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shorrrtcodes i18n scrollbar expand theme mobile nav ay'con print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice openapi piratify siteparam tabs ",
"content":"Contributors 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.\nTheme Dependencies autoComplete - A lightweight an' powerful vanilla JavaScript complet'n suggester clipboard.js - A modern approach t' copy text t' clipboard d3-zoom - Pan an' zoom SVG, HTML or Canvas us'n mouse or touch input - plus dependencies d3-color - Color spaces! RGB, HSL, Cubehelix, CIELAB, an' more d3-dispatch - Register named callbacks an' call them wit' arguments d3-ease - Eas'n funct'ns fer smooth animat'n d3-interpolate - Interpolate numbers, colors, str'ns, arrays, objects, whatever d3-select'n - Transform th' DOM by select'n elements an' join'n t' data d3-timer - An efficient queue fer manag'n thousands o' concurrent animat'ns d3-transit'n - Animated transit'ns fer D3 select'ns d3-drag - Drag an' drop SVG, HTML or Canvas us'n mouse or touch input Font Awesome - Th' internet’s ay'con library an' toolkit JS-YAML - JavaScript YAML parser an' dumper Lunr - Enables a great search experience without th' need fer external, server-side, search services Lunr Languages - A collect'n o' languages stemmers an' stopwords fer Lunr Javascript library MathJax - Beautiful math an' chemical formulae 'n all browsers Merrrmaid - Generat'n o' diagram an' flowchart from text 'n a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin SwaggerUI - Generate beautiful documentat'n from a Swagger-compliant API WorkSans - Work Sans be a 9 weight typeface family based loosely on early Grotesques Docs Dependencies github-buttons - Unofficial github:buttons Tool'n Dependencies GitHub - Continuous deployment, test'n an' host'n o' this project’s sources an' its documentat'n Various GitHub Act'ns https://github.com/actions/checkout https://github.com/actions/setup-node https://github.com/Akkjon/close-milestone https://github.com/andstor/file-reader-act'n https://github.com/ashley-taylor/regex-property-act'n https://github.com/Kaven-Universe/github-action-current-date-time https://github.com/mingjun97/file-regex-replace https://github.com/octokit/graphql-act'n https://github.com/peaceiris/actions-gh-pages https://github.com/peaceiris/actions-hugo https://github.com/WyriHaximus/github-action-create-milestone https://github.com/WyriHaximus/github-action-next-semvers gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ",
"content":"Th' expand shortcode displays an expandable/collaps'ble section o' text.\nExpand me… Thank ye!\nThat’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank ye!\" )}} Parameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitrary 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 Arbitrary 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' possibilities 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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)",
"content":" Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' highlight shortcode renders yer code wit' a rules highlighter.\n python 1print(\"Hello World!\") Usage This shortcode be fully compat'ble wit' Hugo’s highlight shortcode but offers some extensions.\nIt be called interchangeably 'n th' same way as Hugo’s own shortcode provid'n positional parameter or by simply us'n Marrrkdown codefences.\nYe be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s highlight funct'n rules if ye call this shortcode as a partial us'n compatibility rules.\nWhile th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use Marrrkdown codefences instead. This be because more an' more other software supports Marrrkdown codefences (eg. GitHub) an' so yer Marrrkdown becomes more port'ble.\n markdown shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Posit'n Default Notes type 1 \u003cempty\u003e Th' language o' th' code t' highlight. Choose from one o' th' supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title fer code. This displays th' code like a single tab if hl_inline=false (which be Hugo’s default). wrap see notes Extension. When true th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.\nTh' default value can be set 'n yer hugo.toml an' overwritten via frontmatter. See below. opt'ns 2 \u003cempty\u003e An optional, comma-separated list o' zero or more Cap'n Hugo supported opt'ns as well as extension parameter from this t'ble. \u003coption\u003e \u003cempty\u003e Any o' Hugo’s supported opt'ns. \u003ccontent\u003e \u003cempty\u003e Yer code t' highlight. Configurat'n Default values fer Hugo’s supported opt'ns can be set via goldmark sett'ns 'n yer hugo.toml\nDefault values fer extension opt'ns can be set via params sett'ns 'n yer hugo.toml or be overwritten by frontmatter fer each individual plank.\nGlobal Configurat'n File Ye can configure th' color style used fer code blocks 'n yer color variants stylesheet file.\nRecommended Sett'ns hugo. toml yaml json [marrrkup] [marrrkup.highlight] lineNumbersInT'ble = false noClasses = false marrrkup: highlight: lineNumbersInT'ble: false noClasses: false { \"markup\": { \"highlight\": { \"lineNumbersInTable\": false, \"noClasses\": false } } } Optional Sett'ns hugo. toml yaml json [params] highlightWrap = true params: highlightWrap: true { \"params\": { \"highlightWrap\": true } } Page’s Frontmatter toml yaml json +++ highlightWrap = true +++ --- highlightWrap: true --- { \"highlightWrap\": true } Examples Line Numbers wit' Start'n Offset As mentioned above, line numbers 'n a t'ble layout will shift if code be wrapp'n, so better use inline. T' make th'ns easier fer ye, set lineNumbersInT'ble = false 'n yer hugo.toml an' add lineNos = true when call'n th' shortcode instead o' th' specific values t'ble or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\"){{\u003c/highlight\u003e}}666#th'
"content":"This lists all planks that be hidden from th' home plank. This includes planks that define hidden=true 'n their frontmatter as well as descendents o' hidden planks.\nWhen giv'n term planks, ye should give it a title. Otherwise it will print out a warning an' will use th' urlized title, which may looks weird.\nWhile internally this term be called hidden, it be referenced 'n th' result'n english planks as a secret an' as hush, matey 'n th' piratish translat'n.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.",
"content":"Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'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' ay'con name an' paste into th' Marrrkdown rrrambl'n.\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.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. 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 HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nT' use these native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true ",
"content":"Th' include shortcode includes other planks, resources or files from yer project.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/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' plank, resource or file t' be included. Plank an' resource paths adhere t' Hugo’s logical path. If not found by logical path it falls back t' Hugo’s build-in readFile funct'n hidefirsthead'n 2 false When true 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 Arbitrary Rrrambl'n {{% include \"shortcodes/include/INCLUDE_ME.md\" %}}Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc.1 ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth”↩︎",
"content":"SemverThisprojecttriest' follow th'semverpolicy-althoughnotfollowed100%'n th'past.\nUsuallyanentryo' Break'nonth' What’s new plank causes a new major release number.\nAll other entries on th'What’snewplankwillincreaseth' minor release number.\nReleases result'n'n a new major or minor number be called main release.\nReleases contain'nbugfixesonly,beonlyincreas'n th'patchreleasenumber.Thosereleasesdon’tresult'n announcements on th'What’snewplank.\nEntriesonth' What’s new plank be checked an'enforceddur'n th'version-releaseGitHubAct'n.\nManag'nIssuesIssuesbecategorizedan' managed by assign'nlabelst' it.\nOnce work'nonanissue,assignitt' a fitt'nmaintainer.\nWhendone,closeth' ticket. Once an issue be closed, it needs t'beassignedt' next release milestone.\nA once released ticket be not allowed t'bereopenedan' rereleased 'nadifferentmilestone.Thiswouldcauseth' changelog t'bechangedevenferth' milestone th'issuewaspreviouslyreleased'n. Instead write a new ticket.\nManag'nPullRequestsIfaPRbemergedan' closed it needs an accompanied issue assigned t'.IftherebenoissueferaPR,th' maintainer needs t'createone.\nYecanassignmultiplePRst' one issue as long as they belong together.\nUsually set th'samelabelsan' milestone fer th'PRasferth' accompanied issue.\nLabels Kind An issue that results 'nchangesetsmusthaveexactlyoneo' th'follow'n labels. This needs t'beassignedlatestbeforerelease.\nLabelDescript'n Changelog section documentat'nImprovementsoraddit'ns t'documentat'n - discussion This issue was converted t'adiscussion-taskMaintenanceworkMaintenancefeatureNewfeatureorrequestFeaturesbugSometh'n isn’t work'nFixesImpactIfth' issue would cause a new main release due t'semversemanticsitneedsoneo' th'accord'n labels an'th' match'nbadgeonth' What’s new plank.\nLabel Descript'nchangeIntroduceschangeswit' exist'ninstallat'ns break'nIntroducesbreak'n changes wit'exist'n installat'nsDeclinat'n If an issue does not result 'nchangesetsbutbeclosedanyways,itmusthaveexactlyoneo' th'follow'n labels.\nLabel Descript'nduplicateThisissueorpullrequestalreadyexistsinvalidThisdoesn’tseemrightsupportRequestferachiev'n a special goal unresolved No progress on this issue update A change 'nbehaviorafterupdatwontchangeThiswillnotbeworkedonHaltYecanassignonefurtherlabelouto' th'follow'n list t'signalreadersthatdevelopmentonanopenissuebecurrentlyhaltedferdifferentreasons.\nLabelDescript'n blocked Depends on other issue t'befixedfirstideaAvalu'ble idea that’s currently not worked on undecided No decision was made yet helpwanted Great idea, send 'naPRneedsfeedbackFurtherinformat'n be needed 3rd-Party If th'issuebenotcausedbyaprogramm'n error 'nth' themes own code, ye can label th'caus'n program or library.\nLabel Descript'nasciidocThisbeatopicrelatedt' process'no' AsciiDoc browser This be a topic related t'th' browser but not th'themedeviceThisbeatopicrelatedt' a certain device hugo This be a topic related t'Cap'n Hugo itself but not th'thememermaidThisbeatopicrelatedt' Merrrmaid itself but not th'themeMak'n Releases A release be based on a milestone named like th'releaseitself-justth' version number, eg: 1.2.3. It’s 'nth' maintainers responsibility t'checksemversemanticso' th'milestone’snamepriort' release an'changeitifnecessary.\nMak'n releases be automated by th'version-releaseGitHubAct'n. It requires th'versionnumbero' th'milestonethatshouldbereleased.Th' release will be created from th'mainbrancho' th'repository.\nTreatreleasedmilestonesasimmut'ble. Don’t rerelease an already released milestone. An already released milestone may already been consumed by yer users.\nDur'nexecut'n o'th' act'nafewth'ns be checked. If a check fails th'act'n fails, result'n'n no new release. Ye can correct th'errorsaf
"content":" Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' math shortcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Usage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use Marrrkdown codefences instead. This be because more an' more other software supports Marrrkdown codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\nMath be also us'ble without enclos'n it 'n a shortcode or Marrrkdown codefence but requires configurat'n by ye. In this case no parameter from th' below t'ble be avail'ble.\n markdown shortcode partial passthrough ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Parameter Name Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formulae. Configurat'n MathJax be configured wit' default sett'ns but ye can cust'mize MathJax’s default sett'ns fer all o' yer files through a JSON object 'n yer hugo.toml or override these sett'ns per plank through yer planks frontmatter.\nTh' JSON object o' yer hugo.toml / frontmatter be forwarded into MathJax’s configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nGlobal Configurat'n File This example reflects th' default configurat'n also used if ye don’t define mathJaxInitialize\nhugo. toml yaml json [params] mathJaxInitialize = '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' params: mathJaxInitialize: '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' { \"params\": { \"mathJaxInitialize\": \"{ \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"$\\\", \\\"$\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"$$\\\", \\\"$$\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } } Page’s Frontmatter Usually ye don’t need t' redefine th' global initializat'n sett'ns fer a single plank. But if ye do, ye have repeat all th' values from yer global configurat'n ye want t' keep fer a single plank as well.\nEg. If ye have redefined th' delimiters t' someth'n exotic like @ symbols 'n yer global config, but want t' additionally align yer math t' th' left fer a specific plank, ye have t' put this t' yer frontmatter:\n toml yaml json +++ mathJaxInitialize = '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' +++ --- mathJaxInitialize: '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' --- { \"mathJaxInitialize\": \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" }, { \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"@\\\", \\\"@\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\
"content":" Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' mermaid shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Usage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use Marrrkdown codefences instead. This be because more an' more other software supports Merrrmaid Marrrkdown codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n markdown shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Th' generated graphs can be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nParameter Name Default Notes align center Allowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' th' ship or th' planks frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files through a JSON object 'n yer hugo.toml, override these sett'ns per plank through yer planks frontmatter or override these sett'n per diagramm through diagram directives.\nTh' JSON object o' yer hugo.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 hugo.toml, frontmatter or diagram directives.\nGlobal Configurat'n File hugo. toml yaml json [params] mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true params: mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true { \"params\": { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } } Page’s Frontmatter toml yaml json +++ mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true +++ --- mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true --- { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } Examples Flowchart wit' YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- 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}} --- title: Example Diagram --- 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] Sequence Diagram wit' Configurat'n Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%%sequenceDiagramAlice-\u003e\u003eJohn:HelloJohn,howbeye?loopHealthcheckJohn-\u003e\u003eJohn:FightagainsthypochondriaendNoterightofJohn:Rationalthoughts!John--\u003e\u003eAlice:Great!J
"content":"Th' notice shortcode 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 shorrrtcodes wit' named parameter ye be free t' use positional as well, use it as GitHub styled alerts or also call this shortcode from yer own partials.\nAvast that if ye want t' use GitHub styled alerts Marrrkdown, this be only avail'ble start'n wit' Cap'n Hugo 0.132.0. In this case no parameter from th' below t'ble be avail'ble.\n markdown shortcode shortcode (positional) partial \u003e [!NOTE] \u003e It be all about th' boxes. {{% 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 %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It be all about th' boxes.\" )}} Parameter Name Posit'n Default Notes style 1 default Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title 2 see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n box. Configurat'n If ye be us'n GitHub styled alerts, by default th' theme also accepts alert levels like info not known t' GitHub’s implementat'n. If this interferes wit' yer layout, ye can turn this extension off by sett'n disableBlockquoteNoticeSupport=true 'n yer hugo.toml.\nGlobal Configurat'n File This example reflects th' default configurat'n also used if ye don’t set anyth'n explicitly.\nhugo. toml yaml json [params] disableBlockquoteNoticeSupport = false params: disableBlockquoteNoticeSupport: false { \"params\": { \"disableBlockquoteNoticeSupport\": false } } Examples By Severity Caut'n wit' marrrkup {{% notice style=\"caution\" %}} An **caut'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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Caut'n An caut'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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\nImportant {{% notice style=\"important\" %}} A **important** disclaimer {{% /notice %}} Important A important disclaimer\nAhoi {{% notice style=\"info\" %}} A **informat'n** disclaimer {{% /notice %}} Ahoi A informat'n disclaimer\nAvast {{% notice style=\"note\"%}}A**notice**disclaimer{{%/notice%}}Avast
"content":"Th' openapi shortcode uses th' Swagger UI library t' display yer OpenAPI / Swagger specificat'ns.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{\u003c openapi src=\"https://petstore3.openapi.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/openapi.html\" (dict \"page\" . \"src\" \"https://petstore3.openapi.io/api/v3/openapi.json\" )}} Parameter Name Default Notes src \u003cempty\u003e Th' path t' th' t' th' OpenAPI specificat'n resource or URL t' be used. Resource paths adhere t' Hugo’s logical path. Avast If ye want t' print out (or generate a PDF) from yer OpenAPI documentat'n, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.\nInstead, open th' print preview 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.\nExample Us'n Local File {{\u003c openapi src=\"petstore.json\" \u003e}} ",
"content":"This 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 (headless) plank 1-1-3 ",
"content":"This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ",
"description":"This be a hidden demo child plank",
"content":"This 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) ",
"description":"This be a non-hidden demo child plank o' a hidden parrrent plank",
"content":"This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode 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 ",
"description":"This be a hidden demo child plank",
"content":" Attachments hugo.png (17 KB) MaybeTreasure.txt (31 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Th' resources shortcode displays th' titles o' resources contained 'n a plank bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features be not supported directly by th' shortcode but rely on Hugo’s handl'n fer resource translat'ns applied when th' theme iterates over all avail'ble resources.\nParameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Resources\nIf 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 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf 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' resources by name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Examples Custom Title, List o' Resources End'n 'n png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Ahoi Styled Box, Descend'n Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Ahoi Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% resources color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title an' Ay'cons For further examples fer style, color, title an' ay'con, see th' notice shortcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.",
"content":"Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns\nCommon Creat'n:\nUse English translat'n Empty search Remove history checkmarks but leave it on th' plank thats used fer th' screenshot Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n Demo Screenshot Rrrambl'n:\nA meaningful full-screen screenshot o' an interest'n plank.\nTh' rrrambl'n should be:\ntimeless: not show'n any dates or often edited rrrambl'n interest'n: show a bunch o' interest'n elements like head'ns, code, etc balanced: no clutter'n wit' overpresent elements or color'n aligned: aligned outlines Used by:\nCap'n Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Plank URL: Screenshot Link\nCreat'n:\nsave as images/screenshot.png Remarks:\nTh' locat'n be mandatory due t' Hugo’s theme ship builder.\nPreview images/screenshot.png:\nHero Image Rrrambl'n:\nShow th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.\nTh' rrrambl'n should be:\nconsistent: always use th' same plank fer all devices pleas'n: use a delightful background Used by:\nCap'n Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Cap'n Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project ship: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/sett'ns 1280 x 640 Plank URL: Hero Image Link\nCreat'n:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize t' 2700 x 1800 centered, scale t' 900 x 600 an' save as images/tn.png From original template size resize t' 3000 x 1500 offset y: -330, scale t' 1280 x 640 an' save as images/hero.png Remarks:\nTh' locat'n o' images/tn.png be mandatory due t' Hugo’s theme ship builder.\nPreview images/hero.png:\nPreview images/tn.png:",
"content":"Ye can use a tab shortcode t' display a single tab.\nThis be especially useful if ye want t' flag yer code example wit' an explicit language.\nIf ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs shortcode.\n c printf(\"Hello World!\"); Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) )}} Parameter Name Default Notes style see notes Th' style scheme used fer th' tab. If ye don’t set a style an' ye display a single code block inside o' th' tab, its default styl'n will adapt t' that o' a code block. Otherwise default be used.\n- by severity: caut'n, important, info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, cyan, green, grey, magenta, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary title fer th' tab. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf 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 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.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n th' tab. Examples Single Code Block wit' Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} Code printf(\"Hello World!\"); Mixed Marrrkdown Rrrambl'n {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **an'** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} Mixed A tab can not only contain code but arbitrary text. In this case text an' code will get a margin.\nprintf(\"Hello World!\"); Understand'n style an' color Behavior Th' style parameter affects how th' color parameter be applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} Th' `style` parameter be set t' a color style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only th' `color` parameter be set. This will set th' background t' a lighter version o' th' chosen CSS color value. {{% /tab %}} {{% tab title=\"default style an' color\" style=\"default\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. Th' `default` style will set th' background t' yer `--MAIN-BG-color` as configured fer yer theme variant resembl'n th' default style but wit' different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} Th' `style` parameter be set t' a severity style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con. {{% /tab %}} {{% tab title=\"severity style an' color\" style=\"info\" color=\"blue\"%}}Th' `style` parameter affects how th'`color`parameterbeapplied.Thiswillsetth' background t'alighterversiono' th'chosenCSScolorvaluean' also affects th'chosenay'con.
"content":"Th' tabs shortcode displays arbitrary rrrambl'n 'n an unlimited number o' tabs.\nThis comes 'n handy eg. fer provid'n code snippets fer multiple languages.\nIf ye just want a single tab ye can instead call th' tab shortcode standalone.\nhello. py sh c print(\"Hello World!\") echo \"Hello World!\" printf(\"Hello World!\"); Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\nSee th' tab shortcode fer a descript'n o' th' parameter fer nested tabs.\n shortcode partial {{\u003c tabs title=\"hello.\" \u003e}} {{% tab title=\"py\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"sh\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{% tab title=\"c\" %}} ```c printf\"Hello World!\"); ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"page\" . \"title\" \"hello.\" \"content\" (slice (dict \"title\" \"py\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) ) (dict \"title\" \"sh\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | .RenderStr'n) ) (dict \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\");\\n```\" | .RenderStr'n) ) ) )}} Parameter Name Default Notes groupid \u003crandom\u003e Arbitrary name o' th' group th' tab view belongs t'.\nTab views wit' th' same groupid sychr'nize their selected tab. Th' tab select'n be restored automatically based on th' groupid fer tab view. If th' selected tab can not be found 'n a tab group th' first tab be selected instead.\nThis sychronizat'n applies t' th' whole ship! style \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. color \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. title \u003cempty\u003e Arbitrary title written 'n front o' th' tab view. ay'con \u003cempty\u003e Font Awesome ay'con name set t' th' left o' th' title. \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Examples Behavior o' th' groupid See what happens t' th' tab views while ye select different tabs.\nWhile press'n a tab o' Group A switches all tab views o' Group A 'n sync (if th' tab be available), th' tabs o' Group B be left untouched.\n Group A, Tab View 1 Group A, Tab View 2 Group B {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"_**XML**_ stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab title=\"text\" %}} Hello World {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"b\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} Group A, Tab View 1 json XML stuff text 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello World Group A, Tab View 2 json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Group B json XML stuff 1{ \"Hello\": \"World\"}\u003cHello\u003eWorld\u003c/Hello\u003eNestedTabViewsan' Color In case ye want t'nesttabviews,th' parent tab that contains nested tab views needs t'bedeclaredwit' {{\u003c tab \u003e}} instead o'{{%tab%}}.Avast,that'n this case it be not poss'blet' put markdown 'nth' parent tab.\nYe can also set style an'colorparameterferalltabsan'overwritethemont
"description":"Synchr'nize select'n o' content 'n different tabbed views",
"content":"Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.",
"description":"Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.",
