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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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, it’s yer “folder home page”\nCreate yer project Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\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 parameter t' a number.\n+++ title = \"My page\" weight = 5 +++ Us'n a custom title fer menu entries By default, th' Relearrrn theme will use a page’s title attribute fer th' menu item (or linkTitle if defined).\nBut a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' menuTitle parameter fer that purpose:\nFor example (for a plank named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++ Override expand state rules fer menu entries Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' alwaysopen sett'n on a per plank basis. If alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\n",
    "description": "",
    "tags": null,
    "title": "Planks orrrganizat'n",
    "uri": "/pir/cont/pages/index.html"
  },
  {
    "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. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.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' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer 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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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 what’s new 'n th' latest release. For a detailed list o' changes, see th' history plank.\n0.95.0 Th' minimum required Cap'n Hugo version.\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 that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n5.11.0 (2023-02-06) Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer static/js directory an' board it from yer own layouts/partials/custom-header.html like this:\n\u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}{{ if $assetBust'n }}?{{ now.Unix }}{{ end }}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' default sett'n o' on, 'n effect since 1.1.0, changed back t' off as there was interference wit' scroll'n on mobile an' big planks.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer config.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis also changed th' lightbox effects parameter from featherlight=false t' lightbox=false. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.\nChange In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' expand shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Translat'n fer Czech. This language be not supported fer search.\nNew GitHub releases be also now tagged fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) release mak'n it easier fer ye t' pin th' theme t' a certain version.\n5.10.0 (2023-01-25) New Th' attachments, badge, button an' notice shorrrtcodes have a new parameter color t' set arbitrary CSS color values.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.\n5.9.0 (2022-12-23) Change Th' required folder name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a files subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a index.files directory. Although th' old files directory be now deprecated, if both directories be present, only th' old files directory will be used fer compatiblity.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer config.toml.\nNew Th' theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New Th' new badge shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.\nNew A new color --ACCENT-color was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old yellow color be still used as default.\n5.7.0 (2022-11-29) Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code ko. Formerly th' country code kr was used instead.\nNew Th' button shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.\nNew Th' search now supports th' Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.\nT' activate this feature, ye need t' configure it 'n yer config.toml as a new outputformat SEARCHPAGE fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'n CTRL+ALT+t now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' TAB key.\nTh' search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.\nNew Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.\nT' configure this 'n yer config.toml make sure t' set Hugo’s disableHugoGeneratorInject=true an' also [params] disableGeneratorVersion=true, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).\n5.5.0 (2022-11-06) 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 doesn’t 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 (2022-11-01) 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 shortcode 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 shortcode an' mermaid shortcode 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 (2022-10-07) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).\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 shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 (2022-08-03) Change If you’ve 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 (2022-07-15) 0.95.0 This release requires a newer Cap'n Hugo version.\nChange 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 (2022-07-05) Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve 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 defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.\nYer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n aft th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:\nfer yer home plank, add th' frontmatter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated frontmatter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' frontmatter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n aft th' upgrade.\nNew Add'n new partials heading-pre.html / heading-post.html an' accord'n frontmatter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew Th' new shortcode math be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n4.2.0 (2022-06-23) Break'n Th' second parameter fer th' include shortcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange Previously, if th' tabs shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.\nChange Th' landingPageURL was removed from config.toml. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically.\nNew All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.\n4.1.0 (2022-06-12) New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank. 4.0.0 (2022-06-05) Break'n Th' custom_css config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' custom-header.html template 'n a much more generic manner.\nBreak'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from --MAIN-LINK-color an' --MAIN-ANCHOR-HOVER-color respectively.\nNew All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew New colors --PRIMARY-color an' --SECONDARY-color were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have primary or secondary as additional values.\nThese two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew Translat'n fer Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 (2022-04-03) Break'n If ye had previously overwritten th' custom-footer.html partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial content-footer.html. custom-footer.html was never meant t' contain HTML other than additional styles an' JavaScript.\nNew If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer config.toml. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.\nNew Ye can activate print support 'n yer config.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n fer Traditional Chinese.\n3.3.0 (2022-03-28) New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between --MAIN-font fer all rrrambl'n text an' --CODE-font fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.\nNew Th' new shortcode swagger be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Cap'n Hugo version.\nChange In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set disableMermaid=false 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.\nNew Additional color variant vari'ble --MERMAID-theme t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.\n3.1.0 (2022-03-15) New attachment an' notice shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons. 3.0.0 (2022-02-22) Break'n We made changes t' th' menu footer. If ye have yer menu-footer.html partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' menu-footer.html partial that be com'n wit' th' exampleSite.\nThis change was made t' allow yer own menu footer t' be placed right aft th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).\nBreak'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.\nThis change will only affect yer installat'n if you’ve not set th' themeVariant parameter 'n yer config.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant=\"learn\" 'n yer config.toml.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color t' --MENU-SEARCH-BORDER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.\nNew Ye can now configure multiple color variants 'n yer config.toml. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.\n2.9.0 (2021-11-19) Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard compliant form ye must not link t' th' *.md file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server aft an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console aft th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not found In this case, ye must apply one o' two opt'ns:\nCopy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.\nStart up a text editor wit' regular expression support fer search an' replace. Apply th' follow'n conversions 'n th' given order on all *.md files. This be th' recommended choice.\nType Search Replace by Branch bundle (ref\\s+\"[^\"]*)/_index\\.md\" $1\" Leaf bundle (ref\\s+\"[^\"]*)/index\\.md\" $1\" Plank (ref\\s+\"[^\"]*)\\.md\" $1\" 2.8.0 (2021-11-03) Change Although never officially documented, this release removes th' font Novacento/Novecento. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.\nNew Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer config.toml. For an example see th' example configurat'n.\n2.7.0 (2021-10-24) New Optional second parameter fer notice shortcode t' set title 'n box header. 2.6.0 (2021-10-21) New Yer ship can now be served from a subfolder if ye set baseURL an' canonifyURLs=true 'n yer config.toml. See th' documentat'n fer a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugos rules highlight'n 'n case guessSyntax=true be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style. 2.4.0 (2021-10-07) Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.\nNew Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer config.toml.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer config.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Cap'n Hugo version.\nNew Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.\n2.2.0 (2021-09-09) New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n disableSeoHiddenPages=true 'n yer config.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Cap'n Hugo version.\nChange In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n th' exampleSite), they will now be ignored by th' search.\nNew Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n disableSearchHiddenPages=true 'n yer config.toml.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.\n2.0.0 (2021-08-28) Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n\nChange In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange --MENU-HOME-LINK-color an' --MENU-HOME-LINK-HOVER-color were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.\nChange Arrow navigat'n an' children shortcode were ignor'n sett'n fer ordersectionsby. This be now changed an' may result 'n different sort'n order o' yer sub planks.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 (2021-07-26) New Shortcode expand wit' new parameter t' open on plank board. 1.1.0 (2021-07-02) Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.\nNew Merrrmaid config opt'ns can be set 'n config.toml.\n1.0.0 (2021-07-01) 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.\nNew Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' Relearrrn an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.\n",
    "description": "",
    "tags": null,
    "title": "What's New",
    "uri": "/pir/basics/migration/index.html"
  },
  {
    "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.\nLet’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\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 it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' 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 Markdown’s 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 it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s 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:\nSmarrrt Arrrse Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'n This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Defint'ns This Marrrkdown dialect supports an extension t' add defint'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) ye can also add a language specifier directly aft th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Result grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables In GFM (GitHub Flavored Markdown) ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | | ------ | ----------- | | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | | ------:|:------:|:----------- | | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Further Image Formatt'n This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result ",
    "description": "",
    "tags": null,
    "title": "Marrrkdown rules",
    "uri": "/pir/cont/markdown/index.html"
  },
  {
    "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 doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shortcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nAttachmentsList o' files attached t' a plank\nBadgeMarker badges t' display 'n yer text\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nAy'conNice ay'cons fer yer plank\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nShip paramGet value o' ship params\nSwaggerUI fer yer Swagger / OpenAPI Specificat'ns\nTabsShow rrrambl'n 'n tabbed views\n",
    "description": "",
    "tags": null,
    "title": "Shorrrtcodes",
    "uri": "/pir/shortcodes/index.html"
  },
  {
    "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 Hugo’s built-in rules highlight'n fer code.\nMarrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders t':\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Cap'n Hugo comes wit' a remark'ble list o' supported languages.\nRecommended configurat'n Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml\n[marrrkup] [marrrkup.highlight] # if `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 or Math codefences guessSyntax = false # choose a color theme or create yer own style = \"base16-snazzy\" ",
    "description": "",
    "tags": null,
    "title": "Code highlight'n",
    "uri": "/pir/cont/syntaxhighlight/index.html"
  },
  {
    "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 chapter contains informat'n only needed fer development an' maintain'n th' theme.\nContribut'nWhat t' know if ye want t' contribute\nMaintain'nWhat t' know as a maintainer\nScreenshotsRecipe t' create various documentat'n screenshots\n",
    "description": "",
    "tags": null,
    "title": "Development",
    "uri": "/pir/dev/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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\nAttachments Shortcode TestTest'n Attachments Shortcode\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\nTablesTest'n different markdown constructs inside o' tables\nWidthTest dynamic width resiz'n o' rrrambl'n if scrollbar be present\n",
    "description": "",
    "tags": null,
    "title": "Tests",
    "uri": "/pir/tests/index.html"
  },
  {
    "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, Czech, Dutch, Finnish 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.\nAvast Make sure yer default language be defined as th' first one 'n th' [Languages] array, as th' theme needs t' make assumpt'ns on it\n# English be th' default language defaultContentLanguage = \"en\" [Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' site’s search via th' Lunr search library does not. You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nCzech Indonesian Polish Search wit' mixed language support In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer 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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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 at least version 0.95.0 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).\n",
    "description": "",
    "tags": null,
    "title": "Requirrrements",
    "uri": "/pir/basics/requirements/index.html"
  },
  {
    "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 don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Install th' theme Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nFrom Git If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.\nIf ye use th' head o' th' main branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.\nAdditionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.\nBesides th' usual version tags (eg 1.2.3) there be also tags fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) released version mak'n it easier fer ye t' pin th' theme t' a certain version.\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (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/index.html"
  },
  {
    "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 if ye want t' dis'ble generat'n fer generator version meta tags o' hugo an' th' theme; # don't forget t' also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into yer home plank disableGeneratorVersion = 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 shortcode 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 shortcode 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 shortcode be present disableSwagger = false # Specifies th' remote locat'n o' th' RapiDoc js customSwaggerURL = \"https://unpkg.com/rapidoc/dist/rapidoc-min.js\" # Initializat'n parameter fer Swagger, see RapiDoc documentat'n swaggerInitialize = \"{ \\\"theme\\\": \\\"light\\\" }\" # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n disableNextPrev = true # Order sections 'n menu by \"weight\" or \"title\". Default t' \"weight\"; # this can be overridden 'n th' planks frontmatter ordersectionsby = \"weight\" # Change default color scheme wit' a variant one. Eg. can be \"auto\", \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"auto\" # Change th' title separator. Default t' \"::\". titleSeparator = \"-\" # If set t' true, th' menu 'n th' sidebar will be displayed 'n a collaps'ble tree view. Although th' functionality works wit' old browsers (IE11), th' display o' th' expander ay'cons be limited t' modern browsers collapsibleMenu = false # If a single plank can contain rrrambl'n 'n multiple languages, add those here additionalContentLanguage = [ \"en\" ] # If set t' true, no index.html will be appended t' prettyURLs; this will cause planks not # t' be serv'ble from th' file system disableExplicitIndexURLs = false # For external links ye can define how they be opened 'n yer browser; this sett'n will only be applied t' th' rrrambl'n area but not th' shortcut menu externalLinkTarget = \"_blank\" Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true relativeURLs = true Without canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nServ'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer config.toml:\nrelativeURLs = true Th' theme will append an additional index.html t' all branch bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer config.toml\n[params] disableExplicitIndexURLs = true Avast If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated JSON t' SEARCH as seen below.\nActivate search If not already present, add th' follow'n lines 'n th' same config.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\"] This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' SEARCH outputformat was named JSON 'n previous releases but was implemented differently. Although JSON still works, it be now deprecated.\nActivate dedicated search plank Ye can add a dedicated search plank fer yer plank by add'n th' SEARCHPAGE outputformat t' yer home plank by add'n th' follow'n lines 'n yer config.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\", \"SEARCHPAGE\"] Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n ENTER inside o' th' menu’s search box .\nActivate print support Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' PRINT output format t' yer home, section an' plank 'n yer config.toml as seen below:\n[outputs] home = [\"HTML\", \"RSS\", \"PRINT\", \"SEARCH\"] section = [\"HTML\", \"RSS\", \"PRINT\"] plank = [\"HTML\", \"RSS\", \"PRINT\"] This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set uglyURLs=true 'n yer config.toml. This be due t' th' fact that fer one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine outputFormats.PRINT 'n yer own config.toml t' yer lik'n.\nMathJax Th' MathJax configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Math fer additional documentat'n.\nExample MathJax be globally disabled. By default it won’t be boarded by any plank.\nOn plank “Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.\nYe also can dis'ble MathJax fer specific planks while globally enabled.\nMerrrmaid Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Merrrmaid fer additional documentat'n.\nExample Merrrmaid be globally disabled. By default it won’t be boarded by any plank.\nOn plank “Architecture” ye coded some JavaScript t' dynamically generate a class diagram. Ye can set th' Merrrmaid parameters locally t' board mermaid on this plank.\nYe also can dis'ble Merrrmaid fer specific planks while globally enabled.\nHome Button Configurat'n If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure two parameters fer th' defined languages:\n[Languages] [Languages.en] ... landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Languages.pir] ... landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ... If those params be not configured fer a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" Th' home button be go'n t' look like this:\n",
    "description": "",
    "tags": null,
    "title": "Configurrrat'n",
    "uri": "/pir/basics/configuration/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. 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. Don’t forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’t 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' page’s 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' page’s 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' page’s 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' page’s 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 page’s meta data above or below th' rrrambl'n. content-footer: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it. Change th' logo Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically\nChange th' favicon If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico 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. That’s 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 = [ \"relearn-light\", \"relearn-dark\" ] Smarrrt Arrrse If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n, an' @import this stylesheet 'n yer color variant stylesheet. For an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto. That’s it.\nIf you’ve set multiple variants, ye can drop auto at any posit'n, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\n[params] themeVariant = [ \"auto\", \"red\" ] If ye don’t configure anyth'n else, th' theme will use relearn-light fer light mode an' relearn-dark fer dark mode.\nIf ye don’t like that, ye can set themeVariantAuto. Th' first element be th' variant fer light mode, th' second fer dark mode\n[params] themeVariantAuto = [ \"learn\", \"neon\" ] Avast This be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nRoll yer own If ye be not happy wit' th' shipped variants ye can either copy an' rename one o' th' shipped files from themes/hugo-theme-relearn/static/css t' static/css, edit them afterwards t' yer lik'n 'n a text editor an' configure th' themeVariant parameter 'n yer config.toml or just use th' interactive variant generator.\nOutput formats Certain parts o' th' theme can be changed fer support o' yer own output formats. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/header.plaintext.html t' change th' way, th' plank header should look like fer that output format.\n",
    "description": "",
    "tags": null,
    "title": "Customizat'n",
    "uri": "/pir/basics/customization/index.html"
  },
  {
    "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 isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant 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 site’s 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/index.html"
  },
  {
    "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.11.1 (2023-02-06) Fixes [bug] variant: include miss'n theme-auto.css 'n distribut'n #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translat'n #455 [feature][change] lightbox: switch t' CSS-only solut'n #451 [feature][change] variant: add support fer prefers-color-scheme #445 [feature][change] expand: refactor fer a11y #339 [feature][change] mermaid: make zoom configur'ble #144 Fixes [bug] swagger: avoid errors when us'n invalid rapi-doc fragment ids #465 [bug] search: fix oddities 'n keyboard handl'n #463 [bug] badge: fix text color fer IE11 #462 [bug] mermaid: rerender graph if search term be present an' variant be switched #460 [bug] tags: show tag on planks when tag has space #459 [bug] edit: remove do'ble slash on root plank link #450 Maintenance [task] build: add mov'n version tags #453 [task][change] theme: remove jQuery #452 [task] build: check fer release notes before release #448 5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb fer huge installat'ns #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links wit' relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shorrrtcodes: support fer accent color #440 [feature] shorrrtcodes: add color parameter whar' applic'ble #438 [feature] theme: announce translat'ns as alternate links #422 Fixes [bug] nav: fix breadcrumbs fer deeply nested sections #442 [bug] theme: improve whitespac'n 'n tables #441 5.9.4 (2023-01-23) Fixes [bug] variant: fix search ay'con an' text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigat'n fer horizontal scroll'n #435 [bug] theme: allow planks on top level #434 Maintenance [task] build: switch t' wildcard version o' act'ns #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts fer Hindi an' Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configur'ble #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links 'n separate tab #419 [feature] theme: make it a Cap'n Hugo module #417 Fixes [bug][change] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true #425 5.8.1 (2022-12-11) Fixes [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] ay'con: add new shortcode #412 [feature] theme: style an' document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spac'n fer tag flyout 'n FF #413 5.7.0 (2022-11-29) Enhancements [feature] button: refactor fer a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color 'n FF an' IE #405 [bug][change] i18n: rename Korean translat'n from country t' lang code #404 Maintenance [task] search: update lunr languages t' 1.10.0 #403 5.6.6 (2022-11-23) Enhancements [feature] search: make build an' js forgiv'n against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator fer use o' neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage o' background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias planks us'ble by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compat'ble wit' Cap'n Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section 'n config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distort'n #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handl'n #390 [feature] search: improve keyboard handl'n #387 [feature] search: add dedicated search plank #386 [feature] theme: make creat'n o' generator meta tag configur'ble #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid lead'n whitespace #394 [bug] theme: fix build errors when referenc'n SVGs 'n markdown #393 [bug] variant: avoid neon t' leak into IE11 fallback #392 [bug] theme: fix urls fer file:// protocol 'n sitemap #385 [bug] theme: add id t' h1 elements #384 [bug] rss: fix display o' hidden subpages #382 [bug] nav: fix key navigat'n when press'n wrong modifiers #379 Maintenance [task] mermaid: update t' version 9.2.2 #391 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: don’t 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: don’t 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 code #298 [bug] menu: make active expander vis'ble on hover #297 [bug] print: dis'ble arrow navigat'n #294 [bug] print: add miss'n plank break aft index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size o' chapter head'n #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Merrrmaid 9.1.3 #293 4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url fer logo an' home button #282 4.2.3 (2022-06-23) Fixes [bug][break'n] include: second parameter be ignored #281 4.2.2 (2022-06-23) No changelog fer this release.\n4.2.1 (2022-06-23) No changelog fer this release.\n4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab select'n if panel does not contain item #279 [feature] shorrrtcodes: convert t' partials #277 Fixes [bug] swagger: avoid builtin syntax-highlightn'n #280 [bug] search: fix console message fer miss'n lunr translat'ns #278 [bug] tabs: fix wrapp'n when hav'n many tabs #272 4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when rrrambl'n starts wit' head'n #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang rrrambl'n #271 4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language wit' wrong lang code #270 [bug] i18n: fix search fer non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigat'n fer scroll'n #268 Fixes [bug] swagger: adjust font-size fer method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compat'ble wit' Cap'n Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc t' 9.3.2 #266 [task] mermaid: update t' 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll plank on CTRL+f #242 4.0.1 (2022-06-05) No changelog fer this release.\n4.0.0 (2022-06-05) Enhancements [feature] shorrrtcodes: add named parameter if miss'n #260 [feature][break'n] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translat'n #254 [feature] attachments: support fer brand colors #252 [feature] notice: support fer brand colors #251 [feature][break'n] config: remove custom_css #248 [feature] theme: use proper file extension fer page-meta.go #246 [feature] variant: add support fer brand color variables #239 [feature] i18n: add Polish translat'n #237 Fixes [bug] shorrrtcodes: accept boolean parameters if given as str'n #261 [bug] print: adjust button an' tab size #259 [bug] print: show Merrrmaid if requested 'n frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display o' tooltip fer head'n anchor #241 3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232 3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support fer oas/swagger documentat'n #226 Fixes [bug] variant: make variant switch work on slow networks #228 3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just th' title plank #224 [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differ'n themes fer color variant switch #219 [feature] mermaid: board javascript on demand #218 Maintenance [task] mermaid: update t' 8.14.0 #220 3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translat'n #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add ay'con parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage o' multiple Cap'n Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color 'n Chrome #213 [bug] mobile: improve behavior o' sidebar menu #210 3.0.4 (2022-02-24) Enhancements [feature] theme: improve font load'n #201 [feature][change] variant: fix inconsistent color vari'ble nam'n #200 Fixes [bug] variant: fix occasional fail when resett'n generator #208 [bug] docs: don’t move header on logo hover 'n IE11 #207 [bug] variant: avoid flash o' menu header when non default variant be active #206 [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205 [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count 'n taxonomy list #195 Fixes [bug] theme: remove Cap'n Hugo build warning if plank be not file based #197 [bug] tags: adhere t' titleSeparator #196 [bug] theme: hide footer divider an' variant selector 'n IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically accord'n t' style #192 Fixes [bug] theme: revert fontawsome t' version 5 fer IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if th' plank has head'ns #182 [feature][break'n] theme: change default colors t' Relearrrn defaults #181 [feature] variant: add a variant selector #178 [feature][break'n] menu: rework footer UX #177 [feature] theme: support fer dark mode #175 [feature] docs: use light rules highlightn'n theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X 'n filled out search box 'n IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change fer ay'cons on hover #176 2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links 'n official documentat'n #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when th' shortcut be an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info t' head #158 Fixes [bug] theme: fix select'n o' *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance fer collect'n o' meta info #157 2.9.0 (2021-11-19) Fixes [bug][break'n] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick t' search field when scroll'n #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add miss'n right border fer inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibl'n planks reliably #152 [bug] menu: br'n active item 'n sight fer large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always board javascript t' avoid break if code fences be used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configur'ble #2 Fixes [bug] mermaid: assert that window.mermaid be actually mermaid #136 [bug] menu: remove usage o' Hugos UniqueID #131 [bug] theme: reduce margin fer children shortcode #130 [bug] theme: left-align h3 'n chapters #129 [bug] theme: align copy link t' clipboard #128 2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124 2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120 2.5.1 (2021-10-12) Fixes [bug] security: fix XSS fer malicioius image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] rules highlight: provide default colors fer unknown languages #113 Fixes [bug] security: fix XSS fer malicioius URLs #114 [bug] menu: write correct local shortcut links #112 2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translat'n #109 [feature][change] theme: simplify stylesheet fer color variants #107 [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative rrrambl'n 'n header #101 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: add default sett'n fer menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config be used #105 [bug] theme: fix sticky header t' remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage o' section element #88 Maintenance [task] theme: ensure IE11 compatiblity #89 [task] docs: Arrr! showcase multilang featurrre #87 2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84 2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readablility o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site rrrambl'n #81 [bug] menu: always hide hidden sub planks #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styl'n #65 [feature] theme: improve readability #64 [feature] menu: show hidden planks if accessed directly #60 [feature][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make rrrambl'n a template #50 [feature] menu: control menu expansion wit' alwaysopen parameter #49 [feature] include: new shortcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ",
    "description": "",
    "tags": null,
    "title": "Historrry",
    "uri": "/pir/basics/history/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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 shortcode as long as ye aren’t view'n this plank or its children directly.\n",
    "description": "",
    "tags": [
      "children",
      "hidden"
    ],
    "title": "Plank 4 (hidden)",
    "uri": "/pir/shortcodes/children/children-4/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "1",
    "uri": "/pir/tests/chapters/1/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "11",
    "uri": "/pir/tests/chapters/10/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "2",
    "uri": "/pir/tests/chapters/2/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "3",
    "uri": "/pir/tests/chapters/3/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "4",
    "uri": "/pir/tests/chapters/4/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "5",
    "uri": "/pir/tests/chapters/5/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "6",
    "uri": "/pir/tests/chapters/6/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "7",
    "uri": "/pir/tests/chapters/7/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "8",
    "uri": "/pir/tests/chapters/8/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "9",
    "uri": "/pir/tests/chapters/9/index.html"
  },
  {
    "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 shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\nshortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"context\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Attachments\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Setup Single language Th' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).\nFor simple planks, 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 branch or leaf bundle, attachments must be placed 'n a nested _index.files or index.files folder, accordingly.\nFor branch bundles:\nrrrambl'n _index.md plank index.md index.files attachment.pdf For leaf bundles:\nrrrambl'n _index.md plank _index.md _index.files attachment.pdf Multilingual Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages an' th' language code must be part o' th' folder name.\nEg. fer a ship 'n English an' Piratish:\nrrrambl'n _index.en.md _index.pir.md plank.en.files attachment.pdf plank.pir.files attachment.pdf plank.en.md plank.pir.md 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) Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% attachments color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" /%}} Attachments 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) Style, Color, Title an' Ay'cons For further examples fer style, color, title an' ay'con, see th' notice shortcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.\n",
    "description": "",
    "tags": null,
    "title": "Attachments",
    "uri": "/pir/shortcodes/attachments/index.html"
  },
  {
    "content": " Attachments NoTreasure.txt (26 B) ",
    "description": "",
    "tags": null,
    "title": "Attachments Brrranch Test",
    "uri": "/pir/tests/attach/attach1/index.html"
  },
  {
    "content": " Attachments NoTreasure.txt (26 B) ",
    "description": "",
    "tags": null,
    "title": "Attachments Leaf Test",
    "uri": "/pir/tests/attach/attach2/index.html"
  },
  {
    "content": " Attachments NoTreasure.txt (26 B) ",
    "description": "",
    "tags": null,
    "title": "Attachments Page Test",
    "uri": "/pir/tests/attach/attach3/index.html"
  },
  {
    "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.\nOur attachment shortcode be a source o' pleasure…\nAttachments Branch Test Attachments hugo.txt (20 B) Attachments Leaf Test Attachments hugo.txt (20 B) Attachments Plank Test Attachments hugo.txt (20 B) ",
    "description": "Test'n Attachments Shorrrtcode",
    "tags": null,
    "title": "Attachments Shorrrtcode Test",
    "uri": "/pir/tests/attach/index.html"
  },
  {
    "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' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.\nImportant Version6.6.6 Captain AhoiNew Awesome\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\nshortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"context\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"context\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"context\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"context\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"context\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default Th' style scheme used fer th' badge.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' badge title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text fer th' badge. Examples Style By Severity {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Break'n{{% /badge %}} AhoiNew AvastChange Smarrrt ArrrseOptional ArrrBreak'n\nBy Brand Colors {{% badge style=\"primary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" ay'con=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" ay'con=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Ay'con an' Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nWithout Ay'con {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nWithout Title Text {{% badge ay'con=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} 6.6.6 Awesome Captain\nAll Set {{% badge ay'con=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nOverride fer Severity {{% badge style=\"info\" ay'con=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% badge color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" %}}Awesome{{% /badge %}} Awesome Wit' Ay'con Rrrambl'n Ye can combine th' badge wit' th' ay'con shortcode t' create even more stunn'n visuals.\nIn this case ye need t' declare {{\u003c badge \u003e}} instead o' {{% badge %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.\n{{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} Pirate\nRank Rank Pirate\nRank Rank Pirate\nInside o' Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" ay'con=\"rocket\" %}}Awesome{{% /badge %}} 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. Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome 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.\n",
    "description": "",
    "tags": null,
    "title": "Badge",
    "uri": "/pir/shortcodes/badge/index.html"
  },
  {
    "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 shortcode 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 shortcode from yer own partials.\nshortcode 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 Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo 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 %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Ay'con T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" iconposit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Cap'n Hugo 'n same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo 'n new Window/Frame (default){{% /button %}} Get Cap'n Hugo 'n same Window/Frame Get Cap'n Hugo 'n new Window/Frame (default) Other Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" %}}Cap'n Hugo{{% /button %}} Cap'n Hugo Severity Style wit' All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse Button t' Internal Plank {{% button href=\"/index.html\" %}}Home{{% /button %}} Home Button wit' JavaScript Act'n If yer JavaScript act'n does not change th' focus afterwards, make sure t' call this.blur() 'n th' end t' unselect th' button.\n{{% button style=\"primary\" ay'con=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element T' use native HTML elements 'n yer Marrrkdown, add this 'n yer config.toml\n[marrrkup.goldmark.renderer] unsafe = true \u003cform act'n=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ",
    "description": "",
    "tags": null,
    "title": "Button",
    "uri": "/pir/shortcodes/button/index.html"
  },
  {
    "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.\nFeatures Smarrrt Arrrse See What’s New within th' latest update.\nUs'ble offline, no external dependencies Us'ble without a HTTP server from th' file system Support fer Internet Explorer 11 Responsive design Configur'ble hidden planks Automatic next/prev buttons t' navigate through menu entries Automatic Search Dedicated search plank Support fer GFM (GitHub Flavored Markdown) Print whole chapters or even th' complete ship Multilingual mode fer English, Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, Finnish, 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 styl'n like siz'n, shadow, border an' alignment Rules highlight'n Customiz'ble look an' feel Predefined (light, dark) an' customiz'ble color variants Automatic switch fer light/dark mode dependend on yer OS sett'ns 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 Badges 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 report 'n th' official repository on GitHub.\nBecome a Contributor Feel free t' update this documentat'n by just click'n th' button 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/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "Categories",
    "uri": "/pir/categories/index.html"
  },
  {
    "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/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "children",
    "uri": "/pir/tags/children/index.html"
  },
  {
    "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 shortcode lists th' child planks o' th' current plank an' its descendants.\nplank X plank 1 plank 2 plank 3 Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\nshortcode 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' shortcode 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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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.\nCode Quality A new release can happen at any time from th' main branch o' th' GitHub project without further accknowledgment. This makes it necessary that, every pushed set o' changesets into th' main branch must be self-contained an' correct, result'n 'n a releas'ble version.\nStay simple fer th' user by focus'n on th' mantra “convent'n over configuration”.\nAt installat'n th' ship should work reason'ble without (m)any configurat'n.\nStay close t' th' Cap'n Hugo way.\nDon’t use npm or any preprocess'n, our contributors may not be front-end developers.\nDocument new features 'n th' exampleSite. This also contains entries t' th' What’s new plank.\nDon’t break exist'n features if ye don’t have t'.\nRemove reported issue from th' browser’s console.\nCheck fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.\nBe compat'ble t' IE11, at least fer main functionality, this means:\ntest 'n IE11 check caniuse.com don’t use JavaScript arrow funct'ns don’t use JavaScript template literals don’t use other fancy JavaScript ES5/6 stuff Conventional Commits Write commit messages 'n th' conventional commit format.\nFollow'n be an impomplete list o' some o' th' used conventional commit types. Be creative.\nCommon Feature Structure Shorrrtcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shorrrtcodes i18n scrollbar expand theme mobile nav ay'con print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice piratify siteparam swagger tabs ",
    "description": "What to know if you want to contribute",
    "tags": null,
    "title": "Contributing",
    "uri": "/pir/dev/contributing/index.html"
  },
  {
    "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 d3-zoom - Pan an' zoom SVG, HTML or Canvas us'n mouse or touch input - plus dependencies d3-color - Color spaces! RGB, HSL, Cubehelix, CIELAB, an' more d3-dispatch - Register named callbacks an' call them wit' arguments d3-ease - Eas'n funct'ns fer smooth animat'n d3-interpolate - Interpolate numbers, colors, str'ns, arrays, objects, whatever d3-select'n - Transform th' DOM by select'n elements an' join'n t' data d3-timer - An efficient queue fer manag'n thousands o' concurrent animat'ns d3-transit'n - Animated transit'ns fer D3 select'ns d3-drag - Drag an' drop SVG, HTML or Canvas us'n mouse or touch input Font Awesome - Th' internet’s ay'con library an' toolkit Lunr - Enables a great search experience without th' need fer external, server-side, search services Lunr Languages - A collect'n o' languages stemmers an' stopwords fer Lunr Javascript library MathJax - Beautiful math an' chemical formulae 'n all browsers Merrrmaid - Generat'n o' diagram an' flowchart from text 'n a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin 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 project’s sources an' its documentat'n Various GitHub Act'ns https://github.com/actions/setup-node https://github.com/Akkjon/close-milestone https://github.com/andstor/file-reader-act'n https://github.com/ashley-taylor/regex-property-act'n https://github.com/Kaven-Universe/github-action-current-date-time https://github.com/mingjun97/file-regex-replace https://github.com/octokit/graphql-act'n https://github.com/peaceiris/actions-gh-pages https://github.com/peaceiris/actions-hugo https://github.com/WyriHaximus/github-action-create-milestone https://github.com/WyriHaximus/github-action-next-semvers gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ",
    "description": "",
    "tags": null,
    "title": "Crrredits",
    "uri": "/pir/more/credits/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "documentat'n",
    "uri": "/pir/tags/documentatn/index.html"
  },
  {
    "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 shortcode displays an expandable/collaps'ble section o' text.\nExpand me... Thank ye! Avast This only works 'n modern browsers flawlessly. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\nshortcode shortcode (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/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "hidden",
    "uri": "/pir/tags/hidden/index.html"
  },
  {
    "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' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.\nshortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"context\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"context\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"context\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.\nCustomis'n Ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n Hugo Built wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplyfies us'n standard ay'cons, th' ay'con customisat'n an' other advanced features o' th' Font Awesome library requires ye t' use HTML directly. Just 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 Built wit' by Relearrrn an' Cap'n Hugo\n",
    "description": "",
    "tags": null,
    "title": "Icon",
    "uri": "/pir/shortcodes/icon/index.html"
  },
  {
    "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 Resource SVG Relative t' plank Relative t' plank up level Static SVG External fully qualified External without scheme External without scheme an' scheme separator HTML Resource SVG Relative t' plank Relative t' plank up level Static SVG 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/index.html"
  },
  {
    "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 shortcode includes other files from yer project inside o' th' current plank.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shortcode from yer own partials.\nshortcode shortcode (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' Hugo’s build-in readFile funct'n hidefirsthead'n 2 false When true an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Examples Arbitrary Rrrambl'n {{% include \"shortcodes/INCLUDE_ME.md\" %}} Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...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/index.html"
  },
  {
    "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.\nSemver This project tries t' follow th' semver policy - although not followed 100% 'n th' past.\nUsually an entry o' Break'n on th' What’s new plank causes a new major release number.\nAll other entries on th' What’s new plank will increase th' minor release number.\nReleases result'n 'n a new major or minor number be called main release.\nReleases contain'n bugixes only, be only increas'n th' patch release number. Those releases don’t result 'n announcements on th' What’s new plank.\nEntries on th' What’s new plank be checked an' enforced dur'n th' version-release GitHub Act'n.\nManag'n Issues Issues be categorized an' managed by assign'n labels t' it.\nOnce work'n on an issue, assign it t' a fitt'n maintainer.\nWhen done, close th' ticket. Once an issue be closed, it needs t' be assigned t' next release milestone.\nA once released ticket be not allowed t' be reopened an' rereleased 'n a different milestone. This would cause th' changelog t' be changed even fer th' milestone th' issue was previously released 'n. Instead write a new ticket.\nManag'n Pull Requests If a PR be merged an' closed it needs an accompanied issue assigned t'. If there be no issue fer a PR, th' maintainer needs t' create one.\nYe can assign multiple PRs t' one issue as long as they belong together.\nUsually set th' same labels an' milestone fer th' PR as fer th' accompanied issue.\nLabels Kind An issue that results 'n changesets must have exactly one o' th' follow'n labels. This needs t' be assigned latest before release.\nLabel Descript'n Changelog section documentat'n Improvements or addit'ns t' documentat'n - discussion This issue was converted t' a discussion - task Maintainence work Maintenance feature New feature or request Features bug Someth'n isn’t work'n Fixes Impact If th' issue would cause a new main release due t' semver semantics it needs one o' th' accord'n labels an' th' match'n badge on th' What’s new plank.\nLabel Descript'n change Introduces changes wit' exist'n installat'ns break'n Introduces break'n changes wit' exist'n installat'ns Declinat'n If an issue does not result 'n changesets but be closed anyways, it must have exactly one o' th' follow'n labels.\nLabel Descript'n duplicate This issue or pull request already exists invalid This doesn’t seem right unresolved No progress on this issue wontfix This will not be worked on Halt Ye can assign one further label out o' th' follow'n list t' signal readers that development on an open issue be currently halted fer different reasons.\nLabel Descript'n blocked Depends on other issue t' be fixed first idea A valu'ble idea that’s currently not worked on undecided No decission was made yet helpwanted Great idea, send 'n a PR needsfeedback Further informat'n be needed 3rd-Party If th' issue be not caused by a programm'n error 'n th' themes own code, ye can label th' caus'n program or library.\nLabel Descript'n browser This be a topic related t' th' browser but not th' theme hugo This be a topic related t' Cap'n Hugo itself but not th' theme mermaid This be a topic related t' Merrrmaid itself but not th' theme Mak'n Releases A release be based on a milestone named like th' release itself - just th' version number, eg: 1.2.3. It’s 'n th' maintainers responsiblity t' check semver semantics o' th' milestone’s name prior t' release an' change it if necessary.\nMak'n releases be automated by th' version-release GitHub Act'n. It requires th' version number o' th' milestone that should be released. Th' release will be created from th' main branch o' th' repository.\nTreat released milestones as immut'ble. Don’t rerelease an already released milestone. An already released milestone may already been consumed by yer users.\nDur'n execut'n o' th' act'n a few th'ns be checked. If a check fails th' act'n fails, result'n 'n no new release. Ye can correct th' errors afterwards an' rerun th' act'n.\nTh' follow'n checks will be enforced\nth' milestone exists there be at least one closed issue assigned t' th' milestone all assigned issues fer this milestone be closed if it’s a main release, there must be a new \u003cmajor\u003e.\u003cminor\u003e at th' beginn'n o' th' What’s new plank if it’s a patch release, there must be th' \u003cmajor\u003e.\u003cminor\u003e from th' previous release at th' beginn'n o' th' What’s new plank Aft a successful run o' th' act'n\nth' History plank be updated, includ'n release version, release date an' text th' What’s new plank be updated, includ'n release version, release date an' text th' version number fer th' \u003cmeta generator\u003e be updated th' updated files be commited th' milestone be closed th' repository be tagged wit' th' version number (eg. 1.2.3), th' main version number (eg. 1.2.x) an' th' major version number (eg. 1.x) a new entry 'n th' GitHub release list wit' th' accord'n changelog will be created th' official documentat'n be built an' deployed th' version number fer th' \u003cmeta generator\u003e be updated t' a temporary an' commited (this helps t' determine if users be runn'n directly on th' main branch or be us'n releases) a new milestone fer th' next patch release be created (this can later be renamed t' a main release if necessary) ",
    "description": "What to know as a maintainer",
    "tags": null,
    "title": "Maintaining",
    "uri": "/pir/dev/maintaining/index.html"
  },
  {
    "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 shortcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shortcode partial ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"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 MathJax’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into MathJax’s 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 Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++ Examples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}} Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Right Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} If ye delimit yer formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence Ye can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ",
    "description": "",
    "tags": null,
    "title": "Math",
    "uri": "/pir/shortcodes/math/index.html"
  },
  {
    "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 shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Avast This only works 'n modern browsers.\nArrr Due t' limitat'ns wit' Merrrmaid, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed expand shortcode. This be a know issue an' can’t 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 shortcode 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 shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"context\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nParameter Name Default Notes align center Allowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' th' ship or th' planks frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml, frontmatter or diagram directives.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true [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 Page’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true +++ 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 Diagram wit' Configurat'n Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! Class Diagram wit' Codefence Rules ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned t' th' Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model {{\u003c mermaid \u003e}} erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, aft des2, 5d Future task2 : des4, aft des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, aft des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, aft des2, 5d Future task2 : des4, aft des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, aft des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") ",
    "description": "",
    "tags": null,
    "title": "Merrrmaid",
    "uri": "/pir/shortcodes/mermaid/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "non-hidden",
    "uri": "/pir/tags/non-hidden/index.html"
  },
  {
    "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 shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\nshortcode shortcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"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' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title 2 see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n box. Examples By Severity Ahoi wit' marrrkup {{% notice style=\"info\" %}} An **informat'n** disclaimer Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Ahoi An informat'n disclaimer\nYe can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\nAvast {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Avast A notice disclaimer\nSmarrrt Arrrse {{% notice style=\"tip\" %}} A **tip** disclaimer Smarrrt Arrrse A tip disclaimer\nArrr {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr A warning disclaimer\nArrr wit' Non-Default Title an' Ay'con {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here be dragons A warning disclaimer\nArrr without a Title an' Ay'con {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary wit' Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary wit' Ay'con only {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen wit' Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey wit' Ay'con only {{% notice style=\"grey\" ay'con=\"bug\" %}} A **grey** disclaimer {{% /notice %}} A grey disclaimer\nOrange wit' Title an' Ay'con {{% notice style=\"orange\" title=\"Orange\" ay'con=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Orange A orange disclaimer\nRed without a Title an' Ay'con {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default wit' Positional Parameter {{% notice default \"Pay Attent'n t' this Avast!\" \"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nTransparent wit' Title an' Ay'con {{% notice style=\"transparent\" title=\"Pay Attent'n t' this Avast!\" ay'con=\"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nWit' User-Defined Color an' Font Awesome Brand Ay'con {{% notice color=\"fuchsia\" title=\"Hugo\" ay'con=\"fab fa-hackerrank\" %}} Victor? Be it ye? {{% /notice %}} Cap'n Hugo Victor? Be it ye?\n",
    "description": "",
    "tags": null,
    "title": "Notice",
    "uri": "/pir/shortcodes/notice/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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 shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ",
    "description": "",
    "tags": [
      "children",
      "hidden"
    ],
    "title": "Plank 1-1-1 (hidden)",
    "uri": "/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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 shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ",
    "description": "",
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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.\nSometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns\nCommon Creat'n:\nUse English translat'n Empty search Remove history checkmarks but leave it on th' plank thats used fer th' screenshot Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n Demo Screenshot Rrrambl'n:\nA meaningful full-screen screenshot o' an interest'n plank.\nTh' rrrambl'n should be:\ntimeless: not show'n any dates or often edited rrrambl'n interest'n: show a bunch o' interest'n elements like head'ns, code, etc balanced: no clutter'n wit' overpresent elements or color'n aligned: aligned outlines Used by:\nCap'n Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Plank URL: Screenshot Link\nCreat'n:\nsave as images/screenshot.png Remarks:\nTh' locat'n be mandatory due t' Hugo’s theme ship builder.\nPreview images/screenshot.png Hero Image Rrrambl'n:\nShow th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.\nTh' rrrambl'n should be:\nconsistent: always use th' same plank fer all devices pleas'n: use a delightful background Used by:\nCap'n Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Cap'n Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project ship: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/sett'ns 1280 x 640 Plank URL: Hero Image Link\nCreat'n:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize t' 2700 x 1800 centered, scale t' 900 x 600 an' save as images/tn.png From original template size resize t' 3000 x 1500 offset y: -330, scale t' 1280 x 640 an' save as images/hero.png Remarks:\nTh' locat'n o' images/tn.png be mandatory due t' Hugo’s theme ship builder.\nPreview images/hero.png Preview images/tn.png ",
    "description": "Recipe t' create various documentat'n scrrreenshots",
    "tags": null,
    "title": "Scrrrenshots",
    "uri": "/pir/dev/screenshots/index.html"
  },
  {
    "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 shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.\nshortcode shortcode (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/index.html"
  },
  {
    "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/index.html"
  },
  {
    "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' swagger shortcode 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 shortcode from yer own partials.\nshortcode 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, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.\nInstead, open th' print preview 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.\nConfigurat'n Swagger be configured wit' default sett'ns. Ye can cust'mize Swagger’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Swagger’s initializat'n. At th' moment, only th' theme sett'n be supported.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml or frontmatter.\nGlobal Configurat'n File [params] swaggerInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" Example Us'n Local File {{\u003c swagger src=\"petstore.json\" \u003e}} ",
    "description": "Adds UI fer yer Swaggerrr / OpenAPI Specificat'ns",
    "tags": null,
    "title": "Swaggerrr",
    "uri": "/pir/shortcodes/swagger/index.html"
  },
  {
    "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.\nLines an' Paragraphs i HTML Paragraph I\nHTML Paragraph II\ni HTML Line I\nHTML Line II i HTML Line I\nHTML Line II i Marrrkdown Multicell I Marrrkdown Multicell II Head'ns i HTML h1 i HTML h2 i HTML h3 i HTML h4 i HTML h5 i HTML h6 Lists i HTML List Item IHTML List Item II Code i Marrrkdown Inline i HTML Inline i HTML Block Links \u0026 Images i Marrrkdown Link i https://example.com i Other i HTML Blockquote i HTML Blockquote wit' nested Paragraph\ni Shorrrtcodes i Important i Get Cap'n Hugo i Expand me... Thank ye! i i 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) |\ni $$\\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)$$ i $\\sqrt{3}$ i graph LR; If --\u003e Then Then --\u003e Else i https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/ i python bash print(\"Hello World!\") echo \"Hello World!\" ",
    "description": "Testing different markdown constructs inside of tables",
    "tags": null,
    "title": "Tables",
    "uri": "/pir/tests/tables/index.html"
  },
  {
    "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 shortcode displays arbitrary rrrambl'n 'n unlimited number o' tabs.\nThis 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 shortcode from yer own partials.\nshortcode 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 Nested Tabs In case ye want t' nest tabs, th' parent tab that contains th' subtabs needs t' be declared wit' {{\u003c tab \u003e}} instead o' {{% tab %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' parent tab.\n{{\u003c tabs groupid=\"main\" \u003e}} {{\u003c tab name=\"Text\" \u003e}} Simple text be poss'ble here... {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab name=\"python\" %}} Python be **super** easy. - most o' th' time. - if ye don't want t' output unicode {{% /tab %}} {{% tab name=\"bash\" %}} Bash be fer **hackers**. {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c tab name=\"Code\" \u003e}} ...but no markdown {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c /tabs \u003e}} Text Code Simple text be poss'ble here... python bash Python be super easy.\nmost o' th' time. if ye don’t want t' output unicode Bash be fer hackers.\n...but no markdown python bash print(\"Hello World!\") echo \"Hello World!\" ",
    "description": "",
    "tags": null,
    "title": "Tabs",
    "uri": "/pir/shortcodes/tabs/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "Tags",
    "uri": "/pir/tags/index.html"
  },
  {
    "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/index.html"
  },
  {
    "content": "",
    "description": "",
    "tags": null,
    "title": "tutorrrial",
    "uri": "/pir/tags/tutorrrial/index.html"
  },
  {
    "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/index.html"
  }
]
