hugo-theme-relearn/pir/index.search.js

538 lines
148 KiB
JavaScript
Raw Normal View History

var relearn_search_index = [
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nDiscover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.\n",
"description": "",
"tags": null,
"title": "Basics",
"uri": "/pir/basics/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": null,
"title": "Plank X",
"uri": "/pir/shortcodes/children/test/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nIn Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, its yer “folder home page”\nCreate yer project Th' follow'n steps be here t' help ye initialize yer new website. If ye dont 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\u003e Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\nFrontmatter Configurat'n Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml 'n all cases.\nTh' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones:\n+++ # T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it. # Avast: Toc be always disabled fer chapter planks disableToc = false # If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules fer th' expand state o' a page's menu entry alwaysopen = true # If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries ordersectionsby = \"title\" # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n headingPre = \"\" # Th' title o' th' plank head'n will be postfixed by this HTML rrrambl'n headingPost = \"\" # Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n menuPre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n menuPost = \"\" # Hide a menu entry by sett'n this t' true hidden = false # Display name o' this plank modifier. If set, it will be displayed 'n th' footer. LastModifierDisplayName = \"\" # Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer LastModifierEmail = \"\" +++ Add ay'con t' a menu entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n sibl'n menu/page entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight paramet
"description": "",
"tags": null,
"title": "Planks orrrganizat'n",
"uri": "/pir/cont/pages/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nUs'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. 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. Its 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.md This 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.md This 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.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md This 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.md Partials 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' HTMLs \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 config.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",
"description": "",
"tags": null,
"title": "Arrrchetypes",
"uri": "/pir/cont/archetypes/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nFind out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.\n",
"description": "",
"tags": null,
"title": "Rambl'n",
"uri": "/pir/cont/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis document shows ye whats new 'n th' latest release. For a detailed list o' changes, see th' history plank.\nBreak'n: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.\nChange: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.\nNew: Marks new behavior ye might find interest'n or comes configur'ble.\n5.5.0 Change: Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.\nFor that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.\nIf ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesnt respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML img URLs manually t' th' respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 Change: Wit' th' proper sett'ns 'n yer config.toml yer plank be now serv'ble from th' local file system us'n file:// URLs.\nPlease note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer config.toml from JSON t' SEARCH. Th' now deprecated JSON outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from http:// or https://.\nChange: Th' button shorrrtcode has a new parameter target t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.\nNew: Th' math shorrrtcode an' mermaid shorrrtcode now also support th' align parameter if codefence rules be used.\nNew: Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.\nNew: Translat'n fer Finnish (Suomi).\n5.3.0 Change: In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Although th' functionality o' th' new implementat'n works wit' old browsers (Internet Explorer 11), th' display o' th' expander ay'cons does not an' be limited t' modern browsers.\nNew: Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline opt'n be now documented.\nNew: Print'n fer th' swagger shorrrtcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 Change: If youve set collapsibleMenu = true 'n yer config.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 Change: Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer config.tomlt':\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' permalink'ble = false 5.0.0 Break'n: Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case youve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript def
"description": "",
"tags": null,
"title": "What's new",
"uri": "/pir/basics/migration/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nLets face it: Writ'n rrrambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so its also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid XHTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdowns formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like its been marked up wit' tags or formatt'n instruct'ns. While Markdowns rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdowns rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nAhoi Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nHead'ns Head'ns from h1 through h6 be constructed wit' a # fer each level:\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Renders t':\nh1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n HTML:\n\u003ch1\u003eh1 Head'n\u003c/h1\u003e \u003ch2\u003eh2 Head'n\u003c/h2\u003e \u003ch3\u003eh3 Head'n\u003c/h3\u003e \u003ch4\u003eh4 Head'n\u003c/h4\u003e \u003ch5\u003eh5 Head'n\u003c/h5\u003e \u003ch6\u003eh6 Head'n\u003c/h6\u003e Comments Comments should be HTML compat'ble\n\u003c!-- This be a comment --\u003e Comment below should NOT be seen:\nHorizontal Rules Th' HTML \u003chr\u003e element be fer creat'n a thematic break between paragraph-level elements. In Marrrkdown, ye can create a \u003chr\u003e wit' --- - three consecutive dashes\nrenders t':\nParagraphs Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within \u003cp\u003e\u003c/p\u003e tags 'n th' rendered HTML.\nSo this body copy:\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. renders t' this HTML:\n\u003cp\u003eLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\u003c/p\u003e Text Markers Bold For emphasiz'n a snippet o' text wit' a heavier font-weight.\nTh' follow'n snippet o' text be rendered as bold text.\n**rendered as bold text** renders t':\nrendered as bold text\nan' this HTML\n\u003cstrong\u003erendered as bold text\u003c/strong\u003e Italics For emphasiz'n a snippet o' text wit' italics.\nTh' follow'n snippet o' text be rendered as italicized text.\n_rendered as italicized text_ renders t':\nrendered as italicized text\nan' this HTML:\n\u003cem\u003erendered as italicized text\u003c/em\u003e Strikethrough In GFM (GitHub flavored Markdown) ye can do strikethroughs.\n~~Strike through this text.~~ Which renders t':\nStrike through this text.\nHTML:\n\u003cdel\u003eStrike through this text.\u003c/del\u003e Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document.\nAdd \u003e before any text ye want t' quote.\n\u003e **Fusion Drive** combines a ha
"description": "",
"tags": null,
"title": "Marrrkdown rules",
"uri": "/pir/cont/markdown/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nCap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesnt support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because its pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shorrrtcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nAttachmentsList o' files attached t' a plank\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nShip paramGet value o' ship params\nSwaggerUI fer yer Swagger / OpenAPI Specificat'ns\nTabbed viewsShow rrrambl'n 'n tabbed views\n",
"description": "",
"tags": null,
"title": "Shorrrtcodes",
"uri": "/pir/shortcodes/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme uses Hugos built-in rules highlight'n fer code.\nMarrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders t':\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Cap'n Hugo comes wit' a remark'ble list o' supported languages.\nRecommended configurat'n Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml\n[marrrkup] [marrrkup.highlight] # if set t' `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this be a mandatory # sett'n fer yer ship guessSyntax = false # choose a color theme or create yer own style = \"base16-snazzy\" ",
"description": "",
"tags": null,
"title": "Code highlight'n",
"uri": "/pir/cont/syntaxhighlight/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome planks fer internal test'n o' different styles\nChaptersStart yer success story. Now!\nCodeSome test'n fer different styles used 'n rules highlight'n an' preformatted blocks\nImagesSome test'n fer different styles o' image links\nWidthTest dynamic width resiz'n o' rrrambl'n if scrollbar be present\n",
"description": "",
"tags": null,
"title": "Tests",
"uri": "/pir/tests/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nYe can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be 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' config.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" url = \"more/credits/\" weight = 30 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" url = \"tags/\" weight = 40 Read more about hugo menu an' hugo multilingual menus\n",
"description": "",
"tags": null,
"title": "Menu extrrra shorrrtcuts",
"uri": "/pir/cont/menushortcuts/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme fer Cap'n Hugo loads th' Font Awesome library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.\nFind'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.\nTh' HTML t' include th' heart ay'con be:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Includ'n 'n markdown Paste th' \u003ci\u003e HTML into marrrkup an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n Hugo Which appears as\nBuilt wit' by Relearrrn an' Cap'n Hugo\nCustomis'n ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\n",
"description": "",
"tags": null,
"title": "Ay'cons an' logos",
"uri": "/pir/cont/icons/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nIt provides:\nTranslat'n str'ns fer default values (English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free t' contribute! 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 config.toml file.\nFor example wit' current English an' Piratized English website.\n# English be th' default language defaultContentLanguage = \"en\" [Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. Its not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each pages rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' sites search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' sites search does not. Youll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nIndonesian Korean Polish Search wit' mixed language support In case yer pages 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 config.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 config.toml\n[params] # When us'n multilingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = true ",
"description": "",
"tags": null,
"title": "Multilingual an' i18n",
"uri": "/pir/cont/i18n/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.\nConfigurat'n Just add tags t' any plank:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.\nEach tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.\nList all th' tags In th' config.toml file ye can add a shortcut t' display all th' tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ",
"description": "",
"tags": [
"documentat'n",
"tutorrrial"
],
"title": "Tags",
"uri": "/pir/cont/tags/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 1-1 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1",
"uri": "/pir/shortcodes/children/children-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download latest version o' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac) : its that simple.\n",
"description": "",
"tags": null,
"title": "Requirrrements",
"uri": "/pir/basics/requirements/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' follow'n steps be here t' help ye initialize yer new website. If ye dont know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Install th' theme Install th' Relearrrn theme by follow'n this documentat'n\nThis themes repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (config.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"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.md By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serve Go t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugo A public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks\n",
"description": "",
"tags": null,
"title": "Installat'n",
"uri": "/pir/basics/installation/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nGlobal ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default).\nAvast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) 'n th' # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true; # this can be overridden 'n th' planks frontmatter alwaysopen = true # Prefix URL t' edit current plank. Will display an \"Edit\" button on top right hand corner o' every plank. # Useful t' give opportunity t' people t' create merge request fer yer doc. # See th' config.toml file from this documentat'n ship t' have an example. editURL = \"\" # Author o' th' ship, will be used 'n meta informat'n author = \"\" # Descript'n o' th' ship, will be used 'n meta informat'n descript'n = \"\" # Shows a checkmark fer visited planks on th' menu showVisitedLinks = false # Dis'ble search funct'n. It will hide search bar disableSearch = false # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box disableSearchHiddenPages = false # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden disableTagHiddenPages = false # Javascript an' CSS cache be automatically busted when new version o' ship be generated. # Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization) disableAssetsBust'n = false # Set this t' true t' dis'ble copy-to-clipboard button fer inline code. disableInlineCopyToClipBoard = false # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it. disableShortcutsTitle = false # If set t' false, a Home button will appear below th' search bar on th' menu. # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be \"/\") disableLandingPageButton = true # When us'n mulitlingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs 'n th' header an' only show th' current plank title disableBreadcrumb = true # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks disableToc = false # If set t' false, board th' MathJax module on every plank regardless if a MathJax shorrrtcode be present disableMathJax = false # Specifies th' remote locat'n o' th' MathJax js customMathJaxURL = \"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\" # Initializat'n parameter fer MathJax, see MathJax documentat'n mathJaxInitialize = \"{}\" # If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shorrrtcode or Merrrmaid codefence be present disableMermaid = false # Specifies th' remote locat'n o' th' Merrrmaid js customMermaidURL = \"https://unpkg.com/mermaid/dist/mermaid.min.js\" # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # If set t' false, board th' Swagger module on every plank regardless if a Swagger shorrrtcode be present disableSwagger = false # Specifies th' remote locat'n o' th' RapiDoc js customSwaggerURL = \"https://unpkg.com/rapidoc/dist/rapidoc-min.js\" # Initializat'n parameter fer Swagger, see RapiDoc documentat'n swaggerInitialize = \"{ \\\"theme\\\": \\\"light\\\" }\" # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n disableNextPrev = true # Order sections 'n menu by \"weight\" or \"title\". Default t' \"weight\"; # this can be overridden 'n th' planks frontmatter ordersectionsby = \"weight\" # Change default color scheme wit' a variant one. E
"description": "",
"tags": null,
"title": "Configurrrat'n",
"uri": "/pir/basics/configuration/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 2",
"uri": "/pir/shortcodes/children/children-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, dont change th' code directly. Instead follow this plank. Youd create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. See output-formats footer.html: th' footer o' th' plank. See output-formats body.html: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats article.html: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Dont forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Dont forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon heading-pre.html: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' pages headingPre sett'n into account. heading-post.html: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' pages headingPost sett'n into account. logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' pages menuPre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' pages menuPost sett'n into account. menu-footer.html: footer o' th' the left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye want t' display pages meta data above or below th' rrrambl'n. content-footer: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye dont like it. Change th' logo Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically\nChange th' favicon If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file 'n layouts/partials/ named favicon.html. Then write someth'n like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' colors Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!\nYe can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.\nSingle variant Set th' themeVariant value wit' th' name o' yer theme file. Thats it!\n[params] themeVariant = \"relearn-light\" In th' above example yer theme file has t' be named theme-relearn-light.css\nMultiple variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer.\n[params] # Change default color scheme wit' a variant one. themeVariant = [ \
"description": "",
"tags": null,
"title": "Customizat'n",
"uri": "/pir/basics/customization/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis interactive tool may help ye t' generate yer own color variant stylesheet.\nT' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isnt 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 youve changed a color, th' variant switch will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer sites static/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer config.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.\nAvast This only works 'n modern browsers.\nVariant generator Download variant Reset variant Graph Download variant Reset variant ",
"description": "",
"tags": null,
"title": "Stylesheet generrrat'r",
"uri": "/pir/basics/generator/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nChangelog 5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on planks #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo 'n 404.html #376 [bug] theme: allow menu items an' children t' be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflow'n issue wit' anchors an' tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: opt'mize plank board fer images #304 Fixes [bug] theme: fix context 'n render hooks #373 [bug] print: make canonical URL absolute #371 5.4.3 (2022-11-05) Enhancements [feature] history: refactor fer a11y #341 Fixes [bug] theme: fix multilang links when ship served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output t' env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow pass'n o' parameters wit' codefence rules #363 [feature] i18n: add Finnish translat'n #361 [feature] mermaid: allow pass'n o' parameters wit' codefence rules #360 [feature] i18n: support RTL #357 [feature][change] button: add opt'n fer target #351 [feature][change] theme: allow t' be served by file:// protocol #349 5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translat'n #343 [feature] theme: opt'n t' align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label an' rrrambl'n #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links o' subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused plank parameter from docs #336 [bug] print: remove menu placeholder 'n Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors whar' applic'ble #307 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls fer uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translat'n #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312 Fixes [bug] print: switch mermaid an' swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: dont count tags if plank be hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overrid'n partials fer output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles aft rework o' archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: board CSS if JS be disabled #305 5.0.1 (2022-07-07) Enhancements [feature][break'n] theme: opt'mize load'n o' js an' css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize render'n #300 [feature] history: dont reload plank when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align rrrambl'n wit' topbar ay'con limits #290 [feature] button: allow fer empty href #288 [feature] i18n: make Simplified Chinese th' standard language fer th' zn code #287 [feature] clipboard: move head styles t' stylesheet #286 [feature] math: add mathjax render'n #235 [feature] theme: allow fer plank head'n modificat'n #139 Fixes [bug] favicon: fix URL if ship resides 'n subfolder #302 [bug] code: show copy-to-clipboard marker fer blocklevel cod
"description": "",
"tags": null,
"title": "Historrry",
"uri": "/pir/basics/history/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 3-1 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 3",
"uri": "/pir/shortcodes/children/children-3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\n",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 4 (hidden)",
"uri": "/pir/shortcodes/children/children-4/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "1",
"uri": "/pir/tests/chapters/1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "11",
"uri": "/pir/tests/chapters/10/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "2",
"uri": "/pir/tests/chapters/2/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "3",
"uri": "/pir/tests/chapters/3/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "4",
"uri": "/pir/tests/chapters/4/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "5",
"uri": "/pir/tests/chapters/5/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "6",
"uri": "/pir/tests/chapters/6/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "7",
"uri": "/pir/tests/chapters/7/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "8",
"uri": "/pir/tests/chapters/8/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "9",
"uri": "/pir/tests/chapters/9/"
},
{
"content": " Attachments NoTreasure.txt (26 B) Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' attachments shorrrtcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"context\" . \"sort\" \"asc\" )}} Th' shorrrtcode lists files found 'n a specific folder.\nCurrently, it supports two implementat'ns fer planks\nIf yer plank be a Marrrkdown file, attachments must be placed 'n a folder named like yer plank an' end'n wit' .files.\nrrrambl'n _index.md plank.files attachment.pdf plank.md If yer plank be a folder, attachments must be placed 'n a nested files folder.\nrrrambl'n _index.md plank index.md files attachment.pdf Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages.\nParameter Name Default Notes style transparent Th' color scheme used t' highlight th' box rrrambl'n.\n- by severity: info, note, tip, warning\u003cnd color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default,t` title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwault.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other colors: Attachments\nIf ye wa ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n le** there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n iseverity\n- fer all other colors: 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) Examples Custom Title, List o' Attachments End'n 'n pdf or mp4 {{% attachments title=\"Related files\" pattern=\".*(pdf|mp4)\" /%}} Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Ahoi Styled Box, Descend'n Sort Order {{% attachments style=\"info\" sort=\"desc\" /%}} Ahoi movieselectricsheep-flock-244-32500-2.mp4 (340 KB) hugo.txt (20 B) hugo.png (17 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) BachGavotteShort.mp3 (357 KB) adivorciarsetoca00cape.pdf (361 KB) Style an' Ay'cons For further examples fer style, title an' ay'con, see th' notice shorrrtcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.\n",
"description": "",
"tags": null,
"title": "Attachments",
"uri": "/pir/shortcodes/attachments/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' button shorrrtcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode 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 \"context\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"context\" . \"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 Th' destinat'n URL fer th' button. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble. style transparent Th' color scheme used t' paint th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other colors: \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 fer th' URL. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- _blank fer any address start'n wit' http:// or https://\n- no specific value fer all other links \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 colors: \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 By Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo By Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Ay'con T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://go
"description": "",
"tags": null,
"title": "Button",
"uri": "/pir/shortcodes/button/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme be a theme fer Cap'n Hugo, a static website generator written 'n Go. Whar' Cap'n Hugo be often used fer blogs, this theme be designed wit' documentat'n 'n mind.\nAhoi Th' theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.\nMain features Smarrrt Arrrse See whats new within th' latest update.\nUs'ble offline, no external dependencies Support fer Internet Explorer 11 Responsive design Configur'ble hidden planks Automatic next/prev buttons t' navigate through menu entries Automatic Search Print whole chapters or even th' complete ship Multilingual mode fer English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese Support fer languages written right t' left Unrestricted menu configurat'n relat'n t' amount o' items an' level o' nest'n Font Awesome ay'cons Tagg'n support Image resiz'n, shadow… Rules highlight'n Attachments files List child planks Math an' chemical formulae us'n th' MathJax library Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Swagger UI fer OpenAPI Specificat'ns Customiz'ble look an' feel Predefined (light, dark) an' customiz'ble color variants Buttons Tip/Note/Info/Warn'n boxes Expand Tabs File inclusion Gett'n support T' get support, feel free t' open a new discussion topic or issue 'n th' official repository on GitHub.\nBecome a contributor Feel free t' update this documentat'n by just click'n th' Edit link displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed.\nYe be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' official repository via GitHub. Please visit th' contribut'n guidelines first.\nLicense This theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others. See th' credits fer a detailed list.\n",
"description": "",
"tags": null,
"title": "Cap'n Hugo Relearrrn Theme",
"uri": "/pir/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Categories",
"uri": "/pir/categories/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nStart yer success story. Now!\n",
"description": "",
"tags": null,
"title": "Chapters",
"uri": "/pir/tests/chapters/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "children",
"uri": "/pir/tags/children/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' children shorrrtcode 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 shorrrtcode from yer own partials.\nshorrrtcode partial {{% children sort=\"weight\" %}} {{ partial \"shortcodes/children.html\" (dict \"context\" . \"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' shorrrtcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort see notes Th' sort order o' th' displayed list.\nIf not set it be sorted by th' ordersectionsby sett'n o' th' ship an' th' planks frontmatter\n- weight: t' sort on menu order\n- title: t' sort alphabetically on menu label. Examples All Default {{% children %}} plank X plank 1 plank 2 plank 3 Wit' Descript'n {{% children descript'n=\"true\" %}} plank 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 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-2This 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 plank 1-1-3 plank 2 plank 3 plank 3-1 ",
"description": "",
"tags": null,
"title": "Children",
"uri": "/pir/shortcodes/children/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome test'n fer different styles used 'n rules highlight'n an' preformatted blocks.\nInline Code This be some very long inline code. Whar' does it wrap?\nWhat about wrapp'n short inline code if multiple sections be written side by side?\nWhat about wrapp'n short inline code if multiple sections be written side/by/side?\nWhat about wrapp'n long inline code if multiple sections be written side567 by34567 side567?\nWhat about wrapp'n long inline code if multiple sections be written side567/by34567/side567?\nCan we just use a simple HTML element ?\nBlock Code Code fences without any selected language { \"well\": \"some JSON 'n codefences 'n here\" } { \"well\": \"some JSON 'n HTML elements here\" } { \"well\": \"Code fences wit' non exist'n language\" } Block Preformatted Some preformatted stuff wit' markdown indentat'n Some preformatted stuff 'n HTML elements ",
"description": "Some test'n fer different styles used 'n rules highlightn'n an' preformatted blocks",
"tags": null,
"title": "Code",
"uri": "/pir/tests/code/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nContributors Special thanks t' everyone who has contributed t' this project.\nMany thanks t' Mathieu Cornic fer his work on port'n th' Learrrn theme t' Cap'n Hugo.\nMany thanks t' Andy Miller fer initially creat'n th' Learrrn theme fer Grav.\nPackages an' libraries autoComplete - A lightweight an' powerful vanilla JavaScript complet'n suggester clipboard.js - A modern approach t' copy text t' clipboard Featherlight - A lightweight jQuery lightbox plugin Font Awesome - Th' internets ay'con library an' toolkit jQuery - Th' “Write less, do more” JavaScript library jquery-svg-zoom-pan - A jQuery plugin t' en'ble pan an' zoom 'n SVG images Lunr - Enables a great search experience without th' need fer external, server-side, search services 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 RapiDoc - Create beautiful, customiz'ble, interactive API documentat'n from OpenAPI Specificat'ns WorkSans - Work Sans be a 9 weight typeface family based loosely on early Grotesques Tool'n GitHub - Continuous deployment, test'n an' host'n o' this projects sources an' its documentat'n gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ",
"description": "",
"tags": null,
"title": "Crrredits",
"uri": "/pir/more/credits/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "documentat'n",
"uri": "/pir/tags/documentatn/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' expand shorrrtcode displays an expandable/collaps'ble section o' text.\nExpand me... Thank ye! Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"context\" . \"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",
"description": "",
"tags": null,
"title": "Expand",
"uri": "/pir/shortcodes/expand/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "hidden",
"uri": "/pir/tags/hidden/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome test'n fer different styles o' image links.\nMarrrkdown Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator HTML Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator ",
"description": "Some test'n fer different styles o' image links",
"tags": null,
"title": "Images",
"uri": "/pir/tests/images/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' include shorrrtcode 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 shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% include file=\"shortcodes/INCLUDE_ME.md\" %}} {{% include \"shortcodes/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"context\" . \"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' Hugos 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. ...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)\n",
"description": "",
"tags": null,
"title": "Include",
"uri": "/pir/shortcodes/include/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' math shorrrtcode 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 shorrrtcode from yer own partials.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shorrrtcode 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 \"context\" . \"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 formuale. Configurat'n MathJax be configured wit' default sett'ns. Ye can cust'mize MathJaxs default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into MathJaxs configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" [marrrkup] [marrrkup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a # mandatory sett'n fer yer ship if ye want t' use Math codefences guessSyntax = false Pages 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 but without further parameter.\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-}$$ ",
"description": "",
"tags": null,
"title": "Math",
"uri": "/pir/shortcodes/math/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' mermaid shorrrtcode 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.\nArrr Due t' limitat'ns wit' Merrrmaid, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed expand shorrrtcode. This be a know issue an' cant be fixed by this theme.\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 shorrrtcode from yer own partials.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shorrrtcode partial ```mermaid { align=\"center\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"context\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" )}} 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. \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaids default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Mermaids mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml, frontmatter or diagram directives.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [marrrkup] [marrrkup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a # mandatory sett'n fer yer ship if ye want t' use Merrrmaid codefences guessSyntax = false Pages Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ Examples Flowchart wit' Non-Default Merrrmaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% 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 {{\u003c mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts \u003cbr\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about ye? Bob--\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts \u003cbr\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about ye?
"description": "",
"tags": null,
"title": "Merrrmaid",
"uri": "/pir/shortcodes/mermaid/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "non-hidden",
"uri": "/pir/tags/non-hidden/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' notice shorrrtcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (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 \"context\" . \"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' color scheme used t' highlight th' box rrrambl'n.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent 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 colors: \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 colors: \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\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen wit' Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey wit' Ay'con onl
"description": "",
"tags": null,
"title": "Notice",
"uri": "/pir/shortcodes/notice/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1 (hidden) plank 1-1-2 plank 1-1-3 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1",
"uri": "/pir/shortcodes/children/children-1/children-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1 (hidden)",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1-1-1 (hidden) ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1-1 (hidden)",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank.\n",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1-1-1",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\nSubpages o' this plank plank 1-1-2-1 plank 1-1-2-2 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2-1",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2-2",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-3",
"uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 3-1",
"uri": "/pir/shortcodes/children/children-3/test3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' siteparam shorrrtcode 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 shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"context\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=\"editURL\" %}} editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n",
"description": "",
"tags": null,
"title": "Ship param",
"uri": "/pir/shortcodes/siteparam/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nGoboLinux Wiki by NEONsys.org BITS by Dr. Lutz Gollan Pamasol Electrics by Pamasol Swiss Aerosol Solut'ns ",
"description": "",
"tags": null,
"title": "Showcase",
"uri": "/pir/more/showcase/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis shorrrtcode uses th' RapiDoc library t' display yer Swagger / OpenAPI 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 shorrrtcode from yer own partials.\nshorrrtcode partial {{\u003c swagger src=\"https://petstore3.swagger.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/swagger.html\" (dict \"context\" . \"src\" \"https://petstore3.swagger.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 Swagger documentat'n, dont 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.\nConfigurat'n Swagger be configured wit' default sett'ns. Ye can cust'mize Swaggers default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Swaggers initializat'n. At th' moment, only th' theme sett'n be supported.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml or frontmatter.\nGlobal Configurat'n File [params] swaggerInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" Example Us'n Local File {{\u003c swagger src=\"petstore.json\" \u003e}} ",
"description": "Adds UI fer yer Swaggerrr / OpenAPI Specificat'ns",
"tags": null,
"title": "Swaggerrr",
"uri": "/pir/shortcodes/swagger/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' tabs shorrrtcode displays arbitrary rrrambl'n 'n unlimited number o' tabs. This comes 'n handy eg. fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.\npython bash print(\"Hello World!\") echo \"Hello World!\" Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{\u003c tabs \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"context\" . \"tabs\" (slice (dict \"name\" \"python\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | markdownify) ) (dict \"name\" \"bash\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | markdownify) ) ) )}} Parameter Name Default Notes groupid default Arbitrary name o' th' group th' tab view belongs t'.\nTab views wit' th' same groupid sychr'nize their selected tab. This sychronizat'n applies t' th' whole ship! \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Avast When us'n tab views wit' different rrrambl'n sets, make sure t' use a common groupid fer equal sets o' tabs but distinct groupid fer different sets.\nTh' tab select'n be restored automatically based on th' groupid an' if it cannot find a tab item because it came from th' 'default' group on a different plank then th' first tab be selected instead.\nExamples Distinct groupid {{\u003c tabs groupid=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab name=\"properties\" %}} ```properties Hello = World ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML properties { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello = World Non-Distinct groupid See what happens t' this tab view if ye select properties tab from th' previous example.\n{{\u003c tabs groupid=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e ",
"description": "",
"tags": null,
"title": "Tabbed views",
"uri": "/pir/shortcodes/tabs/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Tags",
"uri": "/pir/tags/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nPlaceholder…\n",
"description": "",
"tags": null,
"title": "Th' one an' only hidden child",
"uri": "/pir/tests/chapters/children-1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "tutorrrial",
"uri": "/pir/tags/tutorrrial/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nMake a vis'ble block\nAn' another one\n",
"description": "Test dynamic width rrresizing o' content if scrrrollbar 's present",
"tags": null,
"title": "Width",
"uri": "/pir/tests/width/"
}
]