"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.\n",
"content":" Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml fer documentat'n 'n all cases.\n+++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used. images = [ \"images/hero.png\" ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = \"Example Page\" # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's hugo.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' value can contain th' macro # `${FilePath}` which will be replaced by th' file path o' yer displayed plank. # If not set, th' set value o' yer site's hugo.toml be used. If th' global # parameter be given but ye want t' hide th' button fer th' displayed plank, # ye can set th' value t' an empty str'n. If instead o' hid'n ye want t' have # an disabled button, ye can set th' value t' a str'n contain'n just spaces. # This be useful if ye want t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Prefix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = \"\" # Suffix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = \"\" # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\"#Showsexpanderfersubmenus.#Default:false#Ifsett' true, a submenu 'nth' sidebar will be displayed 'nacollaps'ble # tree view an'aclick'ble expander be set 'nfronto' th'entry.#Ifnotset,th'setvalue
"content":"Arrr!PirrratesFello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n.LikeMerrrmaids,do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'nth' latest release an'flagsitwit' one o'th' follow'nbadges.Foradetailedlisto' changes, see th'historyplank.\n0.112.4Th' minimum required Cap'nHugoversion.\nBreak'n A change that requires act'nbyyeafterupgrad'n t'assureth' ship be still functional.\nChange A change 'ndefaultbehaviorthatmayrequiresact'n by ye if ye want t'revertit.\nNewMarksnewbehavioryemightfindinterest'n or comes configur'ble.\n5.24.0(2024-02-17)0.112.4ThisreleaserequiresanewerCap'n Hugo version.\nChange Th'topbarbuttonreceivedawayt' add text next t'th' ay'con.Forthis,th' original title opt'nwasrenamedt' hint while th'newtitleopt'n be now displayed next t'th' ay'con.\nChangeTh' frontmatter opt'nmenuTitlebenowdeprecated'n favor fer Hugo’s own linkTitle. Ye don’t need t'changeanyth'n as th'oldmenuTitleopt'n be still supported.\nChange Th'lightthemeshaveabitmorecontrastferrrrambl'n text an'head'ns. Also th'syntaxhighlight'n was changed t'th' more colorful MonokaiLight. This br'nsth' syntaxhighlightn'n'n sync wit'th' correspond'ndarkthemevariants,whichbeus'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.\nNew If th'themecannotresolvealinkt' a plank or image, ye can now generate warnings or errors dur'nbuildbysett'n link.errorlevel or image.errorlevel t'eitherwarningorerror'n yer hugo.toml respectively. By default this condit'nbesilentlyignoredan' th'linkbewrittenas-is.\nPleasenotethataplanklinkwillgeneratefalsenegativesifuglyURLs=truean' it references an ordinary plank before 0.123.0.\nPlease note that an image link will generate false negatives if th'fileresides'n yer static directory.\nNew Ye now can configure additional opt'nsfereverythemevariant'n yer hugo.toml. This allows fer optional advanced functionality. Ye don’t need t'changeanyth'n as th'oldconfigurat'n opt'nswillstillwork(butmaygeneratewarningsnow).\nTh' advanced functionality allows ye t'setanexplicitnameferathemevariantan' now allows fer multiple auto mode variants that adjust t'th' light/dark preference o'yerOSsett'ns.\nNew New partial fer defin'nth' head'n.Seedocumentat'n fer further read'n.\nNewSupportferHugo’sbuilt-infigureshortcode.\nNewOntaxonomyan' term planks ye can now use prev/next navigat'naswithinth' normal plank structure.\nNew In additiion t'th' exist'nmenuwidthcustomizat'n, it be now also poss'blet' set th'widtho' th'menuflyoutfersmallscreensizeswit' th'--MENU-WIDTH-SCSSproperty.\nNewImprovementsferaccessibilitywhentabb'n thru th'plankferimages,linksan' tab handles.\nNew Th'editURLconfigparameterbenowoverwrit'ble 'nyerplanksfrontmatter.Inaddit'n it received more versatility by lett'nyecontrolwhar' t'putth' file path into th'URL.Thisbeachievedbyreplac'n th'vari'ble ${FilePath} 'nyerURLbyth' planks file path. Ye don’t need t'changeanyth'n 'nyerexist'n configurat'nasth' old way without th'replacementvari'ble still works.\nNew Th'themesconfigan' frontmatter opt'nsreceivedacomprehensivedocumentat'n update. In addit'nth' theme switched from config.toml t'hugo.toml.\nNewRestoredcompatibilitywit' Cap'nHugoversions0.121.0orhigherferth' highlight shortcode. This does not change th'minimumrequiredCap'n Hugo version.\nNew Restored compatibility wit'Cap'n Hugo versions 0.123.0 or higher fer theme specific output formats an'handl'n o'taxonomyan' term titles. This does not change th'minimumrequiredCap'n Hugo version.\n5.23.0 (2023-11-03) Change Wit'0.120.0th' author sett'nsmoveintoth' [params] array 'nyerhugo.toml.Becausethiscollideswit' th'previousway,th' theme expected author informat'n,itnowadherest' Cap'nHugostandardsan'printsoutawa
"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+++ 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+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number. Because this 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+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number or delete th' whole weight parameter entirely.\nSelf 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+++ 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.\n",
"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.\nAttachmentsList o' files attached t' a plank\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\nSiteParamGet value o' ship params\nTabShow rrrambl'n 'n a single tab\nTabsShow rrrambl'n 'n tabbed views\n",
"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\n",
"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\nWithoutfurtherdelay,letusgooverth' main elements o'Marrrkdownan' what th'result'n HTML looks like:\nSmarrrt Arrrse Bookmark this plank an'th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'nusuallyspansth' whole avail'bledocumentwidth.Thisbecalledablock.Blocksbealwaysseparatedbywhitespacet' their adjacent blocks 'nth' result'ndocument.\nAnytextnotstart'n wit'aspecialsignbewrittenasnormal,plaintextparagraphblockan' must be separated t'itsadjacentblocksbyemptylines.\nLoremipsumdolorsitamet,graecisdeniqueeivel,atduoprimismandamus.Etlegereocurreretpri,animaltacimatescomplectituradcum.Cueuminermisinimicusefficiendi.Laboreofficiishisex,solutaofficiisconcludaturqueeiqui,videsensibusvimad.ResultLoremipsumdolorsitamet,graecisdeniqueeivel,atduoprimismandamus.\nEtlegereocurreretpri,animaltacimatescomplectituradcum.Cueuminermisinimicusefficiendi.Laboreofficiishisex,solutaofficiisconcludaturqueeiqui,videsensibusvimad.\nHead'ns A bloody idea be t'structureyerrrrambl'n us'nhead'ns an'subhead'ns. HTML-head'nsfromh1throughh6beconstructedwit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an'yeshouldonlyhaveonesuchelement'n a document.\n# h1 Head'n##h2Head'n ### h3 Head'n####h4Head'n ##### h5 Head'n######h6Head'n Result h1 Head'nh2Head'n h3 Head'nh4Head'n h5 Head'nh6Head'n Horizontal Rules T'furtherstructureyerrrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit'threeconsecutivedashes---.\nLoremipsumdolorsitamet,graecisdeniqueeivel,atduoprimismandamus.---Etlegereocurreretpri,animaltacimatescomplectituradcum.Cueuminermisinimicusefficiendi.Laboreofficiishisex,solutaofficiisconcludaturqueeiqui,videsensibusvimad.ResultLoremipsumdolorsitamet,graecisdeniqueeivel,atduoprimismandamus.\nEtlegereocurreretpri,animaltacimatescomplectituradcum.Cueuminermisinimicusefficiendi.Laboreofficiishisex,solutaofficiisconcludaturqueeiqui,videsensibusvimad.\nTextMarkersBoldYecanshowimportanceo' a snippet o'textwit' a heavier font-weight by enclos'nitwit' two asterisks **.\nI am rendered wit'**boldtext**ResultIamrenderedwit' bold text\nItalics Ye can emphasize a snippet o'textwit' italics by enclos'nitwit' underscores _.\nI am rendered wit'_italicizedtext_ResultIamrenderedwit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'ntextwit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'nThisMarrrkdowndialectsupportsan
"content":" Th' theme supports non-standard image effects.\nAs described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer hugo.toml aswell 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'\n hugo.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden 'n a planks frontmatter by eg.\n frontmatter +++ [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 Result border = true lightbox = false shadow = false bg-white = true 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\" alt=\"Minion\" class=\"bg-white border 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.\n",
"content":" Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n hugo.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overridden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n[Shortcuts-Title] other = \"\u003cYour value\u003e\"Read more about hugo menu an' hugo i18n translat'n str'ns\nConfigurat'n fer Multilingual mode When us'n a multilingual website, ye can set different menus fer each language. In th' hugo.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = \"more/credits/\" weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = \"tags/\" weight = 40 [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = \"more/credits/\" weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = \"tags/\"weight=40Readmoreabouthugomenuan' hugo multilingual menus\nShortcuts t'planksinsideo' yer project If ye have shortcuts t'planksinsideo' yer project an'yedon’twantthemt' show up 'nplankmenusection,yehavetwochoices:\nMaketh' plank file fer th'shortcutaheadlessbranchbundle(contained'n its own subdirectory an'called_inde
"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, 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\n# English be th' default language defaultContentLanguage = \"en\" [languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\"Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug 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.\n[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\n[params] # When us'n multilingual website, dis'ble th' switch language button. 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+++ 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\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" [[menu.shortcuts]] name = \"\u003ci class='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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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.112.4 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).\nIt’s a kind o' magic\n",
"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.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eInstall th' theme Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nFrom Git If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.\nIf ye use th' head o' th' main branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.\nAdditionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.\nBesides th' usual version tags (eg 1.2.3) there be also tags fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) released version mak'n it easier fer ye t' pin th' theme t' a certain version.\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (hugo.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"html\", \"rss\", \"search\"]Create yer first chapter plank Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.\n### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.renders as\nTh' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command\nhugo new --kind chapter basics/_index.mdBy open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.mdFeel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serveGo t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugoA public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks.\n",
"content":" On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml. Th' defaults be written 'n th' comments o' each opt'n.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\n hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Th' descript'n o' yer ship. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. descript'n = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Brand'n # These opt'ns set yer overall visual apperance. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explainat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] # Filename suffix fer variant files. # Default: not set # Th' theme modifies th' variant stylesheets dur'n build an' tries t' store # them wit' th' same file name. In certain installat'ns it was observed, that # Cap'n Hugo could not overwrite these files due t' permission issues. If ye # experience this, ye can first try t' set th' `--noChmod` opt'n fer Cap'n Hugo. # If this still doesn't help ye can set this opt'n t' eg. \".gen\". This will # be used as a suffix fer these generated files, caus'n them t' be newly # created instead o' overwrit'n th' exist'n ones. themeVariantModifier = \"\"#++++++++++++++++++++++++
"content":" Th' Relearrrn theme provides configurat'n opt'ns t' change yer your 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 thru 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.\n hugo.toml [params] themeVariant = \"relearn-light\" Avast Yer theme variant file must reside 'n yer site’s static/css directory or 'n th' theme’s static/css directory an' th' file name must start wit' theme- an' end wit .css. In th' above example, th' path o' yer theme file must be static/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s static/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.\n hugo.toml [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 highlightn'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.\n hugo.toml [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.\n hugo.toml [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.Incasesomeo' th'filesbemiss'n, th'themefallsbackt' favicon.svg fer each miss'nfile.Allsuppliedfaviconsmustbeo' th'samefileformat.\nIfnofaviconfilebefound,th' theme will lookup th'alternativefilenamelogo'n th'samelocat'n an'willrepeatth' search fer th'listo' supported file types.\nIf ye need t'changethisdefaultbehavior,createanewfilelayouts/p
"content":" Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer hugo.toml\nbaseURL = \"https://example.com/mysite/\"Serv'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer hugo.toml:\nrelativeURLs = trueTh' theme will append an additional index.html t' all plank bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer hugo.toml\n[params] disableExplicitIndexURLs = true Avast Sublemental planks (like sitemap.xml, rss.xml) will always be generated wit' fully quallyfied URLs an' will not work if yer ship be served from th' filesystem.\nAvast If ye want t' use th' search feature from th' file system, migrat'n from an older installat'n o' th' theme, make sure t' change yer outputformat fer th' homepage from th' now deprecated json t' search as seen below.\nActivate search If not already present, add th' follow'n lines 'n yer hugo.toml file.\n[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. Avast that th' search outputformat was named json 'n previous releases but was implemented differently. Although json still works, it be now deprecated.\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.\n[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:\n[outputs] home = [\"html\", \"rss\", \"print\", \"search\"] section = [\"html\", \"rss\", \"print\"] plank = [\"html\", \"rss\", \"print\"]This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set uglyURLs=true 'n yer hugo.toml. This be due t' th' fact that fer one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine outputFormats.print 'n yer own hugo.toml t' yer lik'n.\nHome Button Configurat'n If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure th' landingPageName fer th' defined languages:\n[languages] [languages.en] ... [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [languages.pir] ... [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ...If this opt'n be not configured fer a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\"Th' home button be go'nt'looklikethis:\nS
"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 thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' 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 static/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.\nDownload variant Reset variant\nGraph Download variant Reset variant\n",
"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 addtional 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'themedistingushiesbetweentwotypeso' 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'nabuttondependendonth' screen size can be configured wit'th' above described hide act'n,yemaywantt' hide th'buttononcertainothercondit'ns aswell.\nFor example, th'printbutton'n its default configurat'nshouldonlybedisplayedifprintsupportwasconfigured.Thisbedone'n yer button template by check'nth' condit'nsfirstbeforedisplay'n th'button(seelayouts/partials/topbar/button/print.html).\nAnotherpreferedcondit'n fer hid'nabuttonbe,ifth' displayed overlay be empty. This be th'caseferth' toc (see layouts/partials/topbar/button/toc.html) aswell as th'morebutton(seelayouts/partials/topbar/button/more.html)an' controlled by th'parameteronempty.\nThisparametercanhaveoneo' th'follow'n values:\ndis'ble:th' button displayed 'ndisabledstate
"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.\n",
"content":" Attachments NoTreasure.txt (26 B) Th' attachments shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Arrr Since Cap'n Hugo 0.112.0 this only works fer leaf bundles. Branch bundles an' simple planks must be switched t' leaf bundles or ye be currently locked t' a Cap'n Hugo version \u003c 0.112.0.\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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:\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' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).\nIf yer plank be a leaf bundle, attachments must be placed 'n a nested index.files folder, accordingly.\nrrrambl'n _index.md plank _index.md _index.files attachment.pdf If yer plank be a branch bundle, attachments must be placed 'n a nested _index.files folder, accordingly.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.112.0\nrrrambl'n _index.md plank index.md index.files attachment.pdf For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' .files.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.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' have as many folders as languages an' th' language code must be part o' th' folder name.\nEg. fer a ship 'n English an' Piratish:\nrrrambl'n index.en.md index.pir.md plank index.en.md index.pir.md index.en.files attachment.pdf index.pir.files attachment.pdf Examples Custom Title, List o' Attachments End'n 'n pdf or mp4 {{% attachments title=\"Related **files**\" pattern=\".*\\.(pdf|mp4)\" /%}} Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Ahoi Styled Box, Descend'n Sort Order {{% attachments style=\"info\" sort=\"desc\"/%}}Ahoimovieselectricsheep-flock-244-32500-2.mp4(340KB)hugo.txt(20B)hugo.png(17KB)Carroll_AliceAuPaysDesMerveilles.pdf(175KB)BachGavotteShort.mp3(357KB)adivorciarsetoca00cape.pdf(361KB)Wit' User-Defined Color an'FontAwesomeBrandA
"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=\"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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Break'n{{% /badge %}} AhoiNew AvastChange Smarrrt ArrrseOptional ArrrBreak'n\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=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" ay'con=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Ay'con an' Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\"%}}Captain{{%/badge
"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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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=\"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\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\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\"
"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.\nA theme fer Cap'n Hugo designed fer documentat'n.\n★ What’s new 'n th' latest release ★\nMotivat'n Th' 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 Internet Explorer 11 Support fer Open Graph an' Twitter Cards Configur'ble them'n an' visuals Configur'ble brand images Automatic switch fer light/dark variant dependend 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, 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 files attached t' plank bundles 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 Support T' get support, feel free t' open a new discussion topic or issue report 'n th' official repository on GitHub.\nContribut'ns Feel free t' contribute t' this documentat'n by just click'n th' edit button displayed on top right o' each plank.\nYe be most welcome t' contribute bugfixes or new features by mak'n pull requests t' th' official repository. 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.\n",
"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 accknowledgment. 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.\nBe compat'ble t' IE11, at least fer main functionality, this means:\ntest 'n IE11 check caniuse.com don’t use JavaScript arrow funct'ns don’t use JavaScript template literals don’t use other fancy JavaScript ES5/6 stuff Conventional Commits Write commit messages 'n th' conventional commit format.\nFollow'n be an impomplete 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. ↩︎\nAvast This only works 'n modern browsers flawlessly. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\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)\n",
"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 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 codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\n codefence 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 Hugos 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 [marrrkup] [marrrkup.highlight] # line numbers 'n a t'ble layout will shift if code be wrapp'n, so better # use inline; besides that visually both layouts have th' same look an' behavior lineNumbersInT'ble = false # th' shipped variants come wit' their own modified chroma rules highlightn'n # stylesheets which be linked 'n yer generated HTML planks; ye can use Cap'n Hugo t' generate # own stylesheets t' yer lik'n an' use them 'n yer variant; # if ye want t' use Hugo's internal styles instead o' th' shipped stylesheets: # - remove `noClasses` or set `noClasses = true` # - set `style` t' a predefined style name # note: wit' us'n th' internal styles, th' `--CODE-theme` sett'n 'n yer variant # stylesheet will be ignored an' th' internal style be used fer all variants an' # even print noClasses = false # style = \"tango\"OptionalSett'ns [params] highlightWrap = truePage’s Frontmatter +++ highlightWrap = true +++Examples Line Numbers wit'Start'n Offset As mentioned above, line numbers 'nat'ble layout will shift if code be wrapp'n,sobetteruseinline.T' make th'nseasierferye,setlineNumbersInT'ble = false 'nyerhugo.tomlan' add lineNos = true when call'nth'shortcode
"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.\n",
"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 files from yer project inside o' th' current plank.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% include file=\"shortcodes/INCLUDE_ME.md\" %}} {{% include \"shortcodes/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/INCLUDE_ME.md\" )}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' file t' be included. Path resolut'n adheres t' Hugo’s build-in readFile funct'n 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_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”↩︎\n",
"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'nbugixesonly,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’tseemrightsupportSolvedbyreconfigur'n th'authorsshipunresolvedNoprogressonthisissueupdateAdocumentedchange'n behaviour wontfix This will not be worked on Halt Ye can assign one further label out o'th' follow'nlistt' signal readers that development on an open issue be currently halted fer different reasons.\nLabel Descript'nblockedDependsonotherissuet' be fixed first idea A valu'bleideathat’scurrentlynotworkedonundecidedNodecisionwasmadeyethelpwantedGreatidea,send'n a PR needsfeedback Further informat'nbeneeded3rd-PartyIfth' issue be not caused by a programm'nerror'n th'themesowncode,yecanlabelth' caus'nprogramorlibrary.\nLabelDescript'n 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'errorsafterwardsan' rerun th'act'n.\nTh'follow'ncheckswillb
"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)$$ Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n codefence shortcode partial ```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\" )}} 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. Ye can cust'mize MathJax’s default sett'ns fer all o' yer files thru a JSON object 'n yer hugo.toml or override these sett'ns per plank thru 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 [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\"Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++Examples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Right Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \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}}If ye delimit yer formulae by two consecutive $$ it generates a new block.\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)$$ Codefence Ye can also use codefences.\n```math $$\\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)$$ ``` $$\\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)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ",
"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 Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n codefence 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 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 thru a JSON object 'n yer hugo.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer 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 [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = truePage’s Frontmatter +++ 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!John-\u003e\u003eBob:Howaboutye?Bob--\u003e\u003eJohn:Jollybloody!ClassDiagramwit' Codefence Rules ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'ngenderAnimal:+isMammal()Animal:+mate()classDuck{+Str'nbeakColor+swim()+quack()}classFish{-
"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 or also call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% 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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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. Examples By Severity Ahoi wit' marrrkup {{% notice style=\"info\" %}} An **informat'n** disclaimer Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Ahoi An informat'n disclaimer\nYe can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\nAvast {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Avast A notice disclaimer\nSmarrrt Arrrse {{% notice style=\"tip\" %}} A **tip** disclaimer Smarrrt Arrrse A tip disclaimer\nArrr {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr A warning disclaimer\nArrr wit' Non-Default Title an' Ay'con {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here be dragons A warning disclaimer\nArrr without a Title an' Ay'con {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary wit' Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary wit' Ay'con only {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\"%}}A**blue**disclaimer{{%/notice%}}Abluedisc
"content":" Th' openapi shortcode uses th' Swagger UI library t' display yer OpenAPI / Swagger specificat'ns.\nAvast This only works 'n modern browsers.\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' URL t' th' OpenAPI specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle. 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 ",
"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) ",
"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 ",
"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:\n",
"content":" Th' siteparam shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.\n shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested parameter wit' Marrrkdown an' HTML formatt'n T' use formatted parameter, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true hugo.toml [params] [params.siteparam.test] text = \"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting\" Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n\n",
"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: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, 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.{{%/tab%}}{{\u003c/tabs\u003
"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'overwritethemon
"content":" Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. Aswell 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.\n",
