hugo-theme-relearn/pir/index.json
2022-10-04 13:36:17 +00:00

537 lines
142 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[
{
"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": "/hugo-theme-relearn/pir/basics/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": null,
"title": "Plank X",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/test/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nIn Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, its yer “folder home page”\nCreate yer project Th' follow'n steps be here t' help ye initialize yer new website. If ye dont know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\nFrontmatter Configurat'n Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml 'n all cases.\nTh' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones:\n+++ # T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it. # Avast: Toc be always disabled fer chapter planks disableToc = false # If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules fer th' expand state o' a page's menu entry alwaysopen = true # If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries ordersectionsby = \"title\" # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n headingPre = \"\" # Th' title o' th' plank head'n will be postfixed by this HTML rrrambl'n headingPost = \"\" # Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n menuPre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n menuPost = \"\" # Hide a menu entry by sett'n this t' true hidden = false # Display name o' this plank modifier. If set, it will be displayed 'n th' footer. LastModifierDisplayName = \"\" # Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer LastModifierEmail = \"\" +++ Add ay'con t' a menu entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n sibl'n menu/page entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight 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 pages title attribute fer th' menu item (or linkTitle if defined).\nBut a pages title has t' be descriptive on its own while th' menu be a hierarchy. Weve 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 recursivley all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shorrrtcode an' its children planks.\n",
"description": "",
"tags": null,
"title": "Planks orrrganizat'n",
"uri": "/hugo-theme-relearn/pir/cont/pages/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nUs'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. Its best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.md This leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.md This leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum. Replace th' X wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md This leads t' a file wit' th' follow'n rrrambl'n\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum. Replace th' X wit' a number or delete th' whole weight parameter entirly.\nSelfdefined 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' follw'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.md Partials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTMLs \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n",
"description": "",
"tags": null,
"title": "Arrrchetypes",
"uri": "/hugo-theme-relearn/pir/cont/archetypes/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nFind out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.\n",
"description": "",
"tags": null,
"title": "Rambl'n",
"uri": "/hugo-theme-relearn/pir/cont/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis document shows ye whats new 'n th' latest release. For a detailed list o' changes, see th' history plank.\nBreak'n: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.\nChange: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.\nNew: Marks new behavior ye might find interest'n or comes configur'ble.\n5.2.0 Change: If youve set collapsibleMenu = true 'n yer config.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 Change: Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer config.tomlt':\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' permalink'ble = false 5.0.0 Break'n: Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case youve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript 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 dont 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 arent set. Therefore ye dont 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' modifiy th' way yer page`s main head'n gets styled.\nNew: Th' new shorrrtcode 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 Break'n: Th' second parameter fer th' include shorrrtcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye havent used this parameter 'n yer shorrrtcode, th' default behavior hasnt changed an' ye dont need t' change anyth'n.\nIf youve used th' second boolean parameter, ye have t' rename it an' invert its value t' achive th' same behavior.\nChange: Previously, if th' tabs shorrrtcode 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 savely remove this aswell 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 shorrrtcode.\n4.1.0 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 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 complexitity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye dont 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 respectivley.\nNew: All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye dont need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew: Th' button shorrrtcode 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 dont need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew: Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 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 New: Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishs 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 shorrrtcode 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 Change: In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shorrrtcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shorrrtcode 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 shorrrtcode 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.\nThis change requires at least Cap'n Hugo 0.93.0 t' be used. Th' minimum requirement will be reported dur'n build on th' console if not met.\nNew: Additional color variant vari'ble --MERMAID-theme t' set th' variants 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 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 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 youve 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 couldnt fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye dont 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 dont 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' dont need t' be changed as apropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see whats 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, weve 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 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 complient an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard complient form ye must not link t' th' *.md file but t' its logical name. Youll 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 youve 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 complient an' ye dont need t' change anyth'n. Youll notice this very easily once youve 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 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 New: Optional second parameter fer notice shorrrtcode t' set title 'n box header. 2.6.0 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 Change: New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugos rules highlightn'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 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 shorrrtcode. 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 New: Showcase multilanguage features by provd'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. 2.2.0 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 Change: In case th' sites structure contains addional *.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 shorrrtcode, th' expand will be opened.\nNew: Th' menu will scroll th' active item into view on board.\n2.0.0 Change: Syntaxhighlightn'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 dont 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 shorrrtcode 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: Shorrrtcode children wit' new parameter containerstyle.\nNew: New shorrrtcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 New: Shorrrtcode expand wit' new parameter t' open on plank board. 1.1.0 New: Merrrmaid config opt'ns can be set 'n config.toml. 1.0.0 New: 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. ",
"description": "",
"tags": null,
"title": "What's new",
"uri": "/hugo-theme-relearn/pir/basics/migration/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nLets face it: Writ'n rrrambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so its also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid XHTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdowns formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like its been marked up wit' tags or formatt'n instruct'ns. While Markdowns rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdowns rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nAhoi Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nHead'ns Head'ns from h1 through h6 be constructed wit' a # fer each level:\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Renders t':\nh1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n HTML:\n\u003ch1\u003eh1 Head'n\u003c/h1\u003e \u003ch2\u003eh2 Head'n\u003c/h2\u003e \u003ch3\u003eh3 Head'n\u003c/h3\u003e \u003ch4\u003eh4 Head'n\u003c/h4\u003e \u003ch5\u003eh5 Head'n\u003c/h5\u003e \u003ch6\u003eh6 Head'n\u003c/h6\u003e Comments Comments should be HTML compat'ble\n\u003c!-- This be a comment --\u003e Comment below should NOT be seen:\nHorizontal Rules Th' HTML \u003chr\u003e element be fer creat'n a “thematic break” between paragraph-level elements. In Marrrkdown, ye can create a \u003chr\u003e wit' --- - three consecutive dashes\nrenders t':\nParagraphs Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within \u003cp\u003e\u003c/p\u003e tags 'n th' rendered HTML.\nSo this body copy:\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. renders t' this HTML:\n\u003cp\u003eLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\u003c/p\u003e Text Markers Bold For emphasiz'n a snippet o' text wit' a heavier font-weight.\nTh' follow'n snippet o' text be rendered as bold text.\n**rendered as bold text** renders t':\nrendered as bold text\nan' this HTML\n\u003cstrong\u003erendered as bold text\u003c/strong\u003e Italics For emphasiz'n a snippet o' text wit' italics.\nTh' follow'n snippet o' text be rendered as italicized text.\n_rendered as italicized text_ renders t':\nrendered as italicized text\nan' this HTML:\n\u003cem\u003erendered as italicized text\u003c/em\u003e Strikethrough In GFM (GitHub flavored Markdown) ye can do strikethroughs.\n~~Strike through this text.~~ Which renders t':\nStrike through this text.\nHTML:\n\u003cdel\u003eStrike through this text.\u003c/del\u003e Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document.\nAdd \u003e before any text ye want t' quote.\n\u003e **Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined. Renders t':\nFusion Drive combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.\nan' this HTML:\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eFusion Drive\u003c/strong\u003e combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.\u003c/p\u003e \u003c/blockquote\u003e Blockquotes 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. Renders t':\nDonec 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.\nLists Unordered A list o' items 'n which th' order o' th' items does not explicitly matter.\nYe may use any o' th' follow'n symbols t' denote bullets fer each list item:\n* valid bullet - valid bullet + valid bullet For example\n+ Lorem ipsum dolor sit amet + Consectetur adipisc'n elit + Integer molestie lorem at massa + Facilisis 'n pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem Renders t':\nLorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem An' this HTML\n\u003cul\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipisc'n elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis 'n pretium nisl aliquet\u003c/li\u003e \u003cli\u003eNulla volutpat aliquam velit \u003cul\u003e \u003cli\u003ePhasellus iaculis neque\u003c/li\u003e \u003cli\u003ePurus sodales ultricies\u003c/li\u003e \u003cli\u003eVestibulum laoreet porttitor sem\u003c/li\u003e \u003cli\u003eAc tristique libero volutpat at\u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003eFaucibus porta lacus fringilla vel\u003c/li\u003e \u003cli\u003eAenean sit amet erat nunc\u003c/li\u003e \u003cli\u003eEget porttitor lorem\u003c/li\u003e \u003c/ul\u003e Ordered A list o' items 'n which th' order o' items does explicitly matter.\n1. Lorem ipsum dolor sit amet 4. Consectetur adipisc'n elit 2. Integer molestie lorem at massa 8. Facilisis 'n pretium nisl aliquet 4. Nulla volutpat aliquam velit 99. Faucibus porta lacus fringilla vel 21. Aenean sit amet erat nunc 6. Eget porttitor lorem Renders t':\nLorem 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 An' this HTML:\n\u003col\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipisc'n elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis 'n pretium nisl aliquet\u003c/li\u003e \u003cli\u003eNulla volutpat aliquam velit\u003c/li\u003e \u003cli\u003eFaucibus porta lacus fringilla vel\u003c/li\u003e \u003cli\u003eAenean sit amet erat nunc\u003c/li\u003e \u003cli\u003eEget porttitor lorem\u003c/li\u003e \u003c/ol\u003e Smarrrt Arrrse If ye just use 1. fer each number, Marrrkdown will automatically number each item. For example:\n1. Lorem ipsum dolor sit amet 1. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 1. Facilisis 'n pretium nisl aliquet 1. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 1. Eget porttitor lorem Renders t':\nLorem 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 Code Inline code Wrap inline snippets o' code wit' `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` should be wrapped as **code**. Renders t':\nIn this example, \u003cdiv\u003e\u003c/div\u003e should be wrapped as code.\nHTML:\n\u003cp\u003eIn this example, \u003ccode\u003e\u0026lt;div\u0026gt;\u0026lt;/div\u0026gt;\u003c/code\u003e should be wrapped as \u003cstrong\u003ecode\u003c/strong\u003e.\u003c/p\u003e Indented code Or indent several lines o' code by at least two spaces, as 'n:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Renders t':\n// Some comments line 1 o' code line 2 o' code line 3 o' code HTML:\n\u003cpre\u003e \u003ccode\u003e // Some comments line 1 o' code line 2 o' code line 3 o' code \u003c/code\u003e \u003c/pre\u003e Block code “fences” Use “fences” ``` t' block 'n multiple lines o' code.\n``` Sample text here... ``` HTML:\n\u003cpre\u003e \u003ccode\u003eSample text here...\u003c/code\u003e \u003c/pre\u003e Rules highlight'n GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, ```js, an' rules highlight'n will automatically be applied 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\nFor example, t' apply rules highlight'n t' JavaScript code:\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'] } } } }; ``` Renders t':\ngrunt.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 Tables be created 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. | Renders t':\nOpt'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. An' this HTML:\n\u003ct'ble\u003e \u003ctr\u003e \u003cth\u003eOpt'n\u003c/th\u003e \u003cth\u003eDescript'n\u003c/th\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003edata\u003c/td\u003e \u003ctd\u003epath t' data files t' supply th' data that will be passed into templates.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eengine\u003c/td\u003e \u003ctd\u003eengine t' be used fer process'n templates. Handlebars be th' default.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eext\u003c/td\u003e \u003ctd\u003eextension t' be used fer dest files.\u003c/td\u003e \u003c/tr\u003e \u003c/t'ble\u003e Right aligned text Add'n a colon on th' right side o' th' dashes below any head'n will right align text fer that column.\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. | 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. Two tables adjacent Opt'n Descript'n ext extension t' be used fer dest files. Opt'n Descript'n ext extension t' be used fer dest files. Links Basic link [Assemble](http://assemble.io) Renders t' (hover over th' link, there be no tooltip):\nAssemble\nHTML:\n\u003ca href=\"http://assemble.io\"\u003eAssemble\u003c/a\u003e Add a tooltip [Upstage](https://github.com/upstage/ \"Visit Upstage!\") Renders t' (hover over th' link, there should be a tooltip):\nUpstage\nHTML:\n\u003ca href=\"https://github.com/upstage/\" title=\"Visit Upstage!\"\u003eUpstage\u003c/a\u003e Named Anchors Named anchors en'ble ye t' jump t' th' specified anchor point on th' same plank. For example, each o' these chapters:\n# T'ble o' Contents - [Chapter 1](#chapter-1) - [Chapter 2](#chapter-2) - [Chapter 3](#chapter-3) will jump t' these sections:\n## Chapter 1 \u003ca id=\"chapter-1\"\u003e\u003c/a\u003e Rrrambl'n fer chapter one. ## Chapter 2 \u003ca id=\"chapter-2\"\u003e\u003c/a\u003e Rrrambl'n fer chapter one. ## Chapter 3 \u003ca id=\"chapter-3\"\u003e\u003c/a\u003e Rrrambl'n fer chapter one. NOTE that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.\nImages Images have a similar rules t' links but include a preced'n exclamat'n point.\n![Minion](https://octodex.github.com/images/minion.png) or\n![Alt text](https://octodex.github.com/images/stormtroopocat.jpg \"The Stormtroopocat\") Like links, Images also have a footnote style rules\nAlternative usage : note images ![Alt text][id] Wit' a reference later 'n th' document defin'n th' URL locat'n:\n[id]: https://octodex.github.com/images/dojocat.jpg \"The Dojocat\" Further image formatt'n Th' Cap'n Hugo Marrrkdown parser supports additional non-standard functionality.\nResiz'n image Add HTTP parameters 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=20pc) ![Minion](https://octodex.github.com/images/minion.png?height=50px) ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=300px) Add CSS classes Add a HTTP classes parameter t' th' link image t' add CSS classes. shadowan' border be avail'ble but ye could define other ones.\n![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) Lightbox Add a HTTP featherlight parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n featherlight t' false.\n![Minion](https://octodex.github.com/images/minion.png?featherlight=false) ",
"description": "",
"tags": null,
"title": "Marrrkdown rules",
"uri": "/hugo-theme-relearn/pir/cont/markdown/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nCap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesnt support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because its pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shorrrtcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nAttachments List o' files attached t' a plank\nButton Click'ble buttons\nChildren List th' child planks o' a plank\nExpand Expandable/collaps'ble sections o' text\nInclude Displays rrrambl'n from other files\nMath Beautiful math an' chemical formulae\nMerrrmaid Generate diagrams an' flowcharts from text\nNotice Disclaimers t' help ye structure yer plank\nShip param Get value o' ship params\nSwagger UI fer yer Swagger / OpenAPI Specificat'ns\nTabbed views Show rrrambl'n 'n tabbed views\n",
"description": "",
"tags": null,
"title": "Shorrrtcodes",
"uri": "/hugo-theme-relearn/pir/shortcodes/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme uses Hugos built-in rules highlight'n fer code.\nMarrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders t':\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Cap'n Hugo comes wit' a remark'ble list o' supported languages.\nRecommended configurat'n Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml\n[marrrkup] [marrrkup.highlight] # if set t' `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this be a mandatory # sett'n fer yer ship guessSyntax = false # choose a color theme or create yer own style = \"base16-snazzy\" ",
"description": "",
"tags": null,
"title": "Code highlight'n",
"uri": "/hugo-theme-relearn/pir/cont/syntaxhighlight/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome planks fer internal test'n o' differnt styles\nChapters Start yer success story. Now!\nCode Some test'n fer different styles used 'n rules highlightn'n an' preformatted blocks\nImages Some test'n fer different styles o' image links\nWidth Test dynamic width resiz'n o' rrrambl'n if scrollbar be present\n",
"description": "",
"tags": null,
"title": "Tests",
"uri": "/hugo-theme-relearn/pir/tests/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nYe can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overriden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n[Shortcuts-Title] other = \"\u003cYour value\u003e\" Read more about hugo menu an' hugo i18n translat'n str'ns\nConfigurat'n fer Multilingual mode When us'n a multilingual website, ye can set different menus fer each language. In th' config.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" url = \"more/credits/\" weight = 30 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" url = \"tags/\" weight = 40 Read more about hugo menu an' hugo multilingual menus\n",
"description": "",
"tags": null,
"title": "Menu extrrra shorrrtcuts",
"uri": "/hugo-theme-relearn/pir/cont/menushortcuts/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme fer Cap'n Hugo loads th' Font Awesome library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.\nFind'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.\nTh' HTML t' include th' heart ay'con be:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Includ'n 'n markdown Paste th' \u003ci\u003e HTML into marrrkup an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n Hugo Which appears as\nBuilt wit' by Relearrrn an' Cap'n Hugo\nCustomis'n ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\n",
"description": "",
"tags": null,
"title": "Ay'cons an' logos",
"uri": "/hugo-theme-relearn/pir/cont/icons/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nIt provides:\nTranslat'n str'ns fer default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free t' contribute! Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.\nFor example wit' current English an' Piratized English website.\n# English be th' default language defaultContentLanguage = \"en\" [Languages] [Languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. Its not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each pages rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' sites search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' sites search does not. Youll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nIndonesian Korean Polish Search wit' mixed language support In case yer pages rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a russian documentat'n fer yer english API), ye can add those languages t' yer config.toml t' broaden search.\n[params] additionalContentLanguage = [ \"en\" ] As this be an array, ye can add multiple additional languages.\nAvast Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additonal 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 mulitlingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = true ",
"description": "",
"tags": null,
"title": "Multilingual an' i18n",
"uri": "/hugo-theme-relearn/pir/cont/i18n/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.\nConfigurat'n Just add tags t' any plank:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.\nEach tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.\nList all th' tags In th' config.toml file ye can add a shortcut t' display all th' tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ",
"description": "",
"tags": [
"documentat'n",
"tutorrrial"
],
"title": "Tags",
"uri": "/hugo-theme-relearn/pir/cont/tags/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 1-1 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download latest version o' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac) : its that simple.\n",
"description": "",
"tags": null,
"title": "Requirrrements",
"uri": "/hugo-theme-relearn/pir/basics/requirements/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' follow'n steps be here t' help ye initialize yer new website. If ye dont know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Install th' theme Install th' Relearrrn theme by follow'n this documentat'n\nThis themes repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (config.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Create yer first chapter plank Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.\n### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it. renders as\nTh' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command\nhugo new --kind chapter basics/_index.md By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serve Go t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugo A public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks\n",
"description": "",
"tags": null,
"title": "Installat'n",
"uri": "/hugo-theme-relearn/pir/basics/installation/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nGlobal ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default).\nAvast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) 'n th' # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true; # this can be overridden 'n th' planks frontmatter alwaysopen = true # Prefix URL t' edit current plank. Will display an \"Edit\" button on top right hand corner o' every plank. # Useful t' give opportunity t' people t' create merge request fer yer doc. # See th' config.toml file from this documentat'n ship t' have an example. editURL = \"\" # Author o' th' ship, will be used 'n meta informat'n author = \"\" # Descript'n o' th' ship, will be used 'n meta informat'n descript'n = \"\" # Shows a checkmark fer visited planks on th' menu showVisitedLinks = false # Dis'ble search funct'n. It will hide search bar disableSearch = false # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box disableSearchHiddenPages = false # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden disableTagHiddenPages = false # Javascript an' CSS cache be automatically busted when new version o' ship be generated. # Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization) disableAssetsBust'n = false # Set this t' true t' dis'ble copy-to-clipboard button fer inline code. disableInlineCopyToClipBoard = false # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it. disableShortcutsTitle = false # If set t' false, a Home button will appear below th' search bar on th' menu. # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be \"/\") disableLandingPageButton = true # When us'n mulitlingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs 'n th' header an' only show th' current plank title disableBreadcrumb = true # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks disableToc = false # If set t' false, board th' MathJax module on every plank regardless if a MathJax shorrrtcode be present disableMathJax = false # Specifies th' remote locat'n o' th' MathJax js customMathJaxURL = \"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\" # Initializat'n parameter fer MathJax, see MathJax documentat'n mathJaxInitialize = \"{}\" # If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shorrrtcode or Merrrmaid codefence be present disableMermaid = false # Specifies th' remote locat'n o' th' Merrrmaid js customMermaidURL = \"https://unpkg.com/mermaid/dist/mermaid.min.js\" # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # If set t' false, board th' Swagger module on every plank regardless if a Swagger shorrrtcode be present disableSwagger = false # Specifies th' remote locat'n o' th' RapiDoc js customSwaggerURL = \"https://unpkg.com/rapidoc/dist/rapidoc-min.js\" # Initializat'n parameter fer Swagger, see RapiDoc documentat'n swaggerInitialize = \"{ \\\"theme\\\": \\\"light\\\" }\" # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n disableNextPrev = true # Order sections 'n menu by \"weight\" or \"title\". Default t' \"weight\"; # this can be overridden 'n th' planks frontmatter ordersectionsby = \"weight\" # Change default color scheme wit' a variant one. Eg. can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"relearn-light\" # 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. collapsibleMenu = false # If a single plank can contain rrrambl'n 'n multiple languages, add those here additionalContentLanguage = [ \"en\" ] A word on runn'n yer ship 'n a subfolder Th' theme runs best if yer ship be installed 'n th' root o' yer webserver. 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 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.\nActivate search If not already present, add th' follow lines 'n th' same config.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"JSON\"] Relearrrn theme uses th' last improvement avail'ble 'n hugo version 20+ t' generate a json index file ready t' be consumed by lunr.js javascript search engine.\nCap'n Hugo generate lunrjs index.json at th' root o' public folder. When ye build th' ship wit' hugo server, hugo generates it internally an' o' course it doesnt show up 'n th' filesystem\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\", \"JSON\"] 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 browsers usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugos URL handl'n even if youve 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 youre 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 wont 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 wont 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": "/hugo-theme-relearn/pir/basics/configuration/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 2",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, dont change th' code directly. Instead follow this plank. Youd create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. See output-formats footer.html: th' footer o' th' plank. See output-formats body.html: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats article.html: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Dont forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Dont forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon heading-pre.html: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsiblity t' take th' pages headingPre sett'n into account. heading-post.html: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsiblity t' take th' pages headingPost sett'n into account. logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' pages menuPre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' pages menuPost sett'n into account. menu-footer.html: footer o' th' the left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye want t' display pages meta data above or below th' rrrambl'n. content-footer: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye dont like it. Change th' logo Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically\nChange th' favicon If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file 'n layouts/partials/ named favicon.html. Then write someth'n like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' colors Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!\nYe can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.\nSingle variant Set th' themeVariant value wit' th' name o' yer theme file. Thats it!\n[params] themeVariant = \"relearn-light\" In th' above exaple yer theme file has t' be named theme-relearn-light.css\nMultiple variants Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a variant switch will be shown 'n th' menu footer.\n[params] # Change default color scheme wit' a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Smarrrt Arrrse If ye want t' switch th' rules highlightn'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugos 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.\nRoll yer own If ye be not happy wit' th' shipped variants ye can either copy one o' th' shipped files, edit them '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": "/hugo-theme-relearn/pir/basics/customization/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis interactive tool may help ye t' generate yer own color variant stylesheet.\nT' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isnt overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' differnet head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce youve changed a color, th' variant switch will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' install it 'n yer ship.\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": "/hugo-theme-relearn/pir/basics/generator/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nChangelog 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls fer uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve japanese translat'n #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312 Fixes [bug] print: switch mermaid an' swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: dont count tags if plank be hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overrid'n partials fer output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles aft rework o' archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: board CSS if JS be disabled #305 5.0.1 (2022-07-07) Enhancements [feature][break'n] theme: opt'mize load'n o' js an' css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize render'n #300 [feature] history: dont reload plank when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align rrrambl'n wit' topbar ay'con limits #290 [feature] button: allow fer empty href #288 [feature] i18n: make simplified chinese th' standard language fer th' zn code #287 [feature] clipboard: move head styles t' stylesheet #286 [feature] math: add mathjax render'n #235 [feature] theme: allow fer plank head'n modificat'n #139 Fixes [bug] favicon: fix URL if ship resides 'n subfolder #302 [bug] code: show copy-to-clipboard marker fer blocklevel 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: dont 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 incompatiblities #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: dont 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: dont 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 shorrrtcode #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: dont 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 shorrrtcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highligher: 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 superflous 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": "/hugo-theme-relearn/pir/basics/history/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank.\nSubpages o' this plank plank 3-1 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 3",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\n",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 4 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-4/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "1",
"uri": "/hugo-theme-relearn/pir/tests/chapters/1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "11",
"uri": "/hugo-theme-relearn/pir/tests/chapters/10/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "2",
"uri": "/hugo-theme-relearn/pir/tests/chapters/2/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "3",
"uri": "/hugo-theme-relearn/pir/tests/chapters/3/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "4",
"uri": "/hugo-theme-relearn/pir/tests/chapters/4/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "5",
"uri": "/hugo-theme-relearn/pir/tests/chapters/5/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "6",
"uri": "/hugo-theme-relearn/pir/tests/chapters/6/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "7",
"uri": "/hugo-theme-relearn/pir/tests/chapters/7/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "8",
"uri": "/hugo-theme-relearn/pir/tests/chapters/8/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "9",
"uri": "/hugo-theme-relearn/pir/tests/chapters/9/"
},
{
"content": " Attachments NoTreasure.txt (26 B) Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' attachments shorrrtcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"context\" . \"sort\" \"asc\" )}} Th' shortcurt lists files found 'n a specific folder.\nCurrently, it supports two implementat'ns fer planks\nIf yer plank be a Marrrkdown file, attachements must be placed 'n a folder named like yer plank an' end'n wit' .files.\nrrrambl'n _index.md plank.files attachment.pdf plank.md If yer plank be a folder, attachements must be placed 'n a nested files folder.\nrrrambl'n _index.md plank index.md files attachment.pdf Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages.\nParameter Name Default Notes style transparent Th' color scheme used t' highlight th' box rrrambl'n.\n- by severity: info, note, tip, warning\u003cnd color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default,t` title see notes Arbitray text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwault.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other colors: Attachments\nIf ye wa ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n le** there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n iseverity\n- fer all other colors: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:\n- t' match a file suffix o' jpg, use .*jpg (not *.jpg)\n- t' match file names end'n 'n jpg or png, use .*(jpg|png) Examples Custom Title, List o' Attachments End'n 'n pdf or mp4 {{% attachments title=\"Related files\" pattern=\".*(pdf|mp4)\" /%}} Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Ahoi Styled Box, Descend'n Sort Order {{% attachments style=\"info\" sort=\"desc\" /%}} Ahoi movieselectricsheep-flock-244-32500-2.mp4 (340 KB) hugo.txt (20 B) hugo.png (17 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) BachGavotteShort.mp3 (357 KB) adivorciarsetoca00cape.pdf (361 KB) Style an' Ay'cons For further examples fer style, title an' ay'con, see th' notice shorrrtcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.\n",
"description": "",
"tags": null,
"title": "Attachments",
"uri": "/hugo-theme-relearn/pir/shortcodes/attachments/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' button shorrrtcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"context\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"context\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Th' destinat'n URL fer th' button. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble. style transparent Th' color scheme used t' paint th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other colors: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. \u003ccontent\u003e see notes Arbitray text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other colors: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo By Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo By Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Ay'con T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://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 Other Severity Style wit' all Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse ",
"description": "",
"tags": null,
"title": "Button",
"uri": "/hugo-theme-relearn/pir/shortcodes/button/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' Relearrrn theme be a theme fer Cap'n Hugo, a static website generator written 'n Go. Whar' Cap'n Hugo be often used fer blogs, this theme be designed wit' documentat'n 'n mind.\nAhoi Th' theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.\nMain features Smarrrt Arrrse See whats new within th' latest update.\nUs'ble offline, no external dependencies Support fer Internet Explorer 11 Responsive design Configur'ble hidden planks Automatic next/prev buttons t' navigate through menu entries Automatic Search Print whole chapters or even th' complete ship Multilingual mode fer English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese Unrestricted menu configurat'n relat'n t' amount o' items an' level o' nest'n Font Awesome ay'cons Tagg'n support Image resiz'n, shadow… Rules highlight'n Attachments files List child planks Math an' chemical formulae us'n th' MathJax library Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Swagger UI fer OpenAPI Specificat'ns Customiz'ble look an' feel Predefined (light, dark) an' customiz'ble color variants Buttons Tip/Note/Info/Warn'n boxes Expand Tabs File inclusion Gett'n support T' get support, feel free t' open a new discussion topic or issue 'n th' official repository on GitHub.\nBecome a contributor Feel free t' update this documentat'n by just click'n th' Edit link displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed.\nYe be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' official repository via GitHub. Please visit th' contribut'n guidelines first.\nLicense This theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others. See th' credits fer a detailed list.\n",
"description": "",
"tags": null,
"title": "Cap'n Hugo Relearrrn Theme",
"uri": "/hugo-theme-relearn/pir/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Categories",
"uri": "/hugo-theme-relearn/pir/categories/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nStart yer success story. Now!\n",
"description": "",
"tags": null,
"title": "Chapters",
"uri": "/hugo-theme-relearn/pir/tests/chapters/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "children",
"uri": "/hugo-theme-relearn/pir/tags/children/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' children shorrrtcode lists th' child planks o' a plank an' its descendants .\nplank X plank 1 plank 2 plank 3 Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{% children sort=\"weight\" %}} {{ partial \"shortcodes/children.html\" (dict \"context\" . \"sort\" \"weight\" )}} Parameter Name Default Notes plank \u003ccurrent\u003e Specify th' plank name (section name) t' display children fer. containerstyle ul Choose th' style used t' group all children. It could be any HTML tag name. style li Choose th' style used t' display each descendant. It could be any HTML tag name. showhidden false When true, child planks hidden from th' menu will be displayed aswell. descript'n false When true shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - read more info about summaries on gohugo.io. depth 1 Th' depth o' descendants t' display. For example, if th' value be 2, th' shorrrtcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort see notes Th' sort order o' th' displayed list.\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 X This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1 This be a demo child plank\nplank 2 This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3 This be a demo child plank\nInfinte Depth an' Hidden Planks {{% children depth=\"999\" showhidden=\"true\" %}} plank X plank 1 plank 1-1 plank 1-1-1 (hidden) plank 1-1-1-1 plank 1-1-1-1-1 (hidden) plank 1-1-1-1-1-1 plank 1-1-2 plank 1-1-2-1 plank 1-1-2-2 plank 1-1-3 plank 2 plank 3 plank 3-1 plank 4 (hidden) Head'n Styles fer Container an' Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" descript'n=\"true\" %}} plank X This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1 This be a demo child plank\nplank 1-1 This be a demo child plank\nplank 1-1-2 This be a demo child plank\nplank 1-1-3 This be a demo child plank\nplank 2 This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3 This be a demo child plank\nplank 3-1 This be a plain plank test nested 'n a parent\nDivs fer Group an' Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} plank X plank 1 plank 1-1 plank 1-1-2 plank 1-1-3 plank 2 plank 3 plank 3-1 ",
"description": "",
"tags": null,
"title": "Children",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome test'n fer different styles used 'n rules highlightn'n an' preformatted blocks.\nInline Code This be some very long inline code. Whar' does it wrap?\nWhat about wrapp'n short inline code if multiple sections be written side by side?\nWhat about wrapp'n short inline code if multiple sections be written side/by/side?\nWhat about wrapp'n long inline code if multiple sections be written side567 by34567 side567?\nWhat about wrapp'n long inline code if multiple sections be written side567/by34567/side567?\nCan we just use a simple HTML element ?\nBlock Code Code fences without any selected language { \"well\": \"some JSON 'n codefences 'n here\" } { \"well\": \"some JSON 'n HTML elements here\" } { \"well\": \"Code fences wit' unexist'n language\" } Block Preformatted Some preformatted stuff wit' markdown indent'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": "/hugo-theme-relearn/pir/tests/code/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nContributors Special thanks t' everyone who has contributed t' this project.\nMany thanks t' Mathieu Cornic fer his work on port'n th' Learrrn theme t' Cap'n Hugo.\nMany thanks t' Andy Miller fer initially creat'n th' Learrrn theme fer Grav.\nPackages an' libraries autoComplete - A lightweight an' powerful vanilla JavaScript complet'n suggester clipboard.js - A modern approach t' copy text t' clipboard Featherlight - A lightweight jQuery lightbox plugin Font Awesome - Th' internets ay'con library an' toolkit jQuery - Th' “Write less, do more” JavaScript library jquery-svg-zoom-pan - A jQuery plugin t' en'ble pan an' zoom 'n SVG images Lunr - Enables a great search experience without th' need fer external, server-side, search services MathJax - Beautiful math an' chemical formulae 'n all browsers Merrrmaid - Generat'n o' diagram an' flowchart from text 'n a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin RapiDoc - Create beautiful, customiz'ble, interactive API documentat'n from OpenAPI Specificat'ns WorkSans - Work Sans be a 9 weight typeface family based loosely on early Grotesques Tool'n GitHub - Continuous deployement, test'n an' host'n o' this projects sources an' its documentat'n gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ",
"description": "",
"tags": null,
"title": "Crrredits",
"uri": "/hugo-theme-relearn/pir/more/credits/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "documentat'n",
"uri": "/hugo-theme-relearn/pir/tags/documentatn/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' expand shorrrtcode displays an expandable/collaps'ble section o' text.\nExpand me... Thank ye! Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"context\" . \"title\" \"Expand me...\" \"content\" \"Thank ye!\" )}} Parameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitray text t' appear next t' th' expand/collapse ay'con. open 2 false When true th' rrrambl'n text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitray text t' be displayed on expand. Examples All Defaults {{% expand %}}Yes, ye did it!{{% /expand %}} Expand me... Yes, ye did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need t' press ye!{{% /expand %}} Expand me... No need t' press ye! Arbitrary Text {{% expand title=\"Show me almost endless possibilities\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /expand %}} Show me almost endless possibilities Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)\n",
"description": "",
"tags": null,
"title": "Expand",
"uri": "/hugo-theme-relearn/pir/shortcodes/expand/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "hidden",
"uri": "/hugo-theme-relearn/pir/tags/hidden/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nSome test'n fer different styles o' image links.\nMarrrkdown Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator HTML Relative t' plank Relative t' plank up level Static External fully qualified External without scheme External without scheme an' scheme separator ",
"description": "Some test'n fer different styles o' image links",
"tags": null,
"title": "Images",
"uri": "/hugo-theme-relearn/pir/tests/images/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' include shorrrtcode includes other files from yer project inside o' th' current plank.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% include file=\"shortcodes/INCLUDE_ME.md\" %}} {{% include \"shortcodes/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"context\" . \"file\" \"shortcodes/INCLUDE_ME.md\" )}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' file t' be included. Path resolut'n adheres t' Hugos build-in readFile funct'n hidefirsthead'n 2 false When true an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Examples Arbitray Rrrambl'n {{% include \"shortcodes/INCLUDE_ME.md\" %}} Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\n",
"description": "",
"tags": null,
"title": "Include",
"uri": "/hugo-theme-relearn/pir/shortcodes/include/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' math shorrrtcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shorrrtcode from yer own partials.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shorrrtcode partial ```math $$\\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}} $$\\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)$$\" )}} Parameter Parameter be only supported when us'n shorrrtcode or partial rules. Defaults be used when us'n codefence rules.\nName Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formuale. Configurat'n MathJax be configured wit' default sett'ns. Ye can cust'mize MathJaxs default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into MathJaxs configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" [marrrkup] [marrrkup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a # mandatory sett'n fer yer ship if ye want t' use Math codefences guessSyntax = false Pages Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++ Examples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}} Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Left Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"left\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} If ye delimit yer formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence Ye can also use codefences but without further parameter.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ",
"description": "",
"tags": null,
"title": "Math",
"uri": "/hugo-theme-relearn/pir/shortcodes/math/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' mermaid shorrrtcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Avast This only works 'n modern browsers.\nArrr Due t' limitat'ns wit' Merrrmaid, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed expand shorrrtcode. This be a know issue an' cant be fixed by this theme.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shorrrtcode from yer own partials.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n (see th' configurat'n section).\ncodefence shorrrtcode partial ```mermaid graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid \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\" )}} 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 Parameter be only supported when us'n shorrrtcode or partial rules. Defaults be used when us'n codefence rules.\nName Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaids default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Mermaids mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml, frontmatter or diagram directives.\nAvast T' use codefence rules ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [marrrkup] [marrrkup.highlight] # if `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a # mandatory sett'n fer yer ship if ye want t' use Merrrmaid codefences guessSyntax = false Pages Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ Examples Flowchart wit' Non-Default Merrrmaid Theme {{\u003c mermaid align=\"left\" \u003e}} %%{init:{\"theme\":\"forest\"}}%% graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{Decision} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence {{\u003c mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts \u003cbr\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about ye? Bob--\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts prevail... John--\u003eAlice: Great! John-\u003eBob: How about ye? Bob--\u003eJohn: Jolly bloody! GANTT {{\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 Class {{\u003c mermaid \u003e}} classDiagram Class01 \u003c|-- AveryLongClass : Cool Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --\u003e C2 : Whar' am i? Class09 --* C3 Class09 --|\u003e Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 \u003c--\u003e C2: Cool label {{\u003c /mermaid \u003e}} classDiagram Class01 \u003c|-- AveryLongClass : Cool Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --\u003e C2 : Whar' am i? Class09 --* C3 Class09 --|\u003e Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 \u003c--\u003e C2: Cool label State Diagram wit' Codefence Rules ```mermaid 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 ``` 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 ",
"description": "",
"tags": null,
"title": "Merrrmaid",
"uri": "/hugo-theme-relearn/pir/shortcodes/mermaid/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "non-hidden",
"uri": "/hugo-theme-relearn/pir/tags/non-hidden/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' notice shorrrtcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"context\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It be all about th' boxes.\" )}} Parameter Name Posit'n Default Notes style 1 default Th' color scheme used t' highlight th' box rrrambl'n.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent title 2 see notes Arbitray text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other colors: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other colors: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitray 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' possiblities 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' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)\nAvast {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Avast A notice disclaimer\nSmarrrt Arrrse {{% notice style=\"tip\" %}} A **tip** disclaimer Smarrrt Arrrse A tip disclaimer\nArrr {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr A warning disclaimer\nArrr wit' Non-Default Title an' Ay'con {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here be dragons A warning disclaimer\nArrr without a Title an' Ay'con {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary wit' Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary wit' Ay'con only {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen wit' Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey wit' Ay'con 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 {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default wit' Title an' Ay'con {{% notice style=\"default\" 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.\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.\n",
"description": "",
"tags": null,
"title": "Notice",
"uri": "/hugo-theme-relearn/pir/shortcodes/notice/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1 (hidden) plank 1-1-2 plank 1-1-3 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1-1-1 (hidden) ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shorrrtcode as long as ye arent view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1-1 (hidden)",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a non-hidden demo child plank o' a hidden parent plank.\n",
"description": "",
"tags": [
"children",
"hidden"
],
"title": "Plank 1-1-1-1-1-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\nSubpages o' this plank plank 1-1-2-1 plank 1-1-2-2 ",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-2-2",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 1-1-3",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis be a plain demo child plank.\n",
"description": "",
"tags": [
"children",
"non-hidden"
],
"title": "Plank 3-1",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' siteparam shorrrtcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shorrrtcode from yer own partials.\nshorrrtcode shorrrtcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"context\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=\"editURL\" %}} editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n",
"description": "",
"tags": null,
"title": "Ship param",
"uri": "/hugo-theme-relearn/pir/shortcodes/siteparam/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nGoboLinux Wiki by NEONsys.org BITS by Dr. Lutz Gollan Pamasol Electrics by Pamasol Swiss Aerosol Solut'ns ",
"description": "",
"tags": null,
"title": "Showcase",
"uri": "/hugo-theme-relearn/pir/more/showcase/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nThis shorrrtcode uses th' RapiDoc library t' display yer Swagger / OpenAPI Specificat'ns.\nAvast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{\u003c swagger src=\"https://petstore3.swagger.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/swagger.html\" (dict \"context\" . \"src\" \"https://petstore3.swagger.io/api/v3/openapi.json\" )}} Parameter Name Default Notes src \u003cempty\u003e Th' URL t' th' OpenAPI Specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle. Configurat'n Swagger be configured wit' default sett'ns. Ye can cust'mize Swaggers default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Swaggers initializat'n. At th' moment, only th' theme sett'n be supported.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml or frontmatter.\nGlobal Configurat'n File [params] swaggerInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" Example Us'n Local File {{\u003c swagger src=\"petstore.json\" \u003e}} ",
"description": "Adds UI fer yer Swaggerrr / OpenAPI Specificat'ns",
"tags": null,
"title": "Swaggerrr",
"uri": "/hugo-theme-relearn/pir/shortcodes/swagger/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nTh' tabs shorrrtcode displays arbitrary rrrambl'n 'n unlimited number o' tabs. This comes 'n handy eg. fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.\npython bash print(\"Hello World!\") echo \"Hello World!\" Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.\nshorrrtcode partial {{\u003c tabs \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"context\" . \"tabs\" (slice (dict \"name\" \"python\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | markdownify) ) (dict \"name\" \"bash\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | markdownify) ) ) )}} Parameter Name Default Notes groupid default Arbitrary name o' th' group th' tab view belongs t'.\nTab views wit' th' same groupid sychr'nize their selected tab. This sychronizat'n applies t' th' whole ship! \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Avast When us'n tab views wit' different rrrambl'n sets, make sure t' use a common groupid fer equal sets o' tabs but distinct groupid fer different sets.\nTh' tab select'n be restored automatically based on th' groupid an' if it cannot find a tab item because it came from th' 'default' group on a different plank then th' first tab be selected instead.\nExamples Distinct groupid {{\u003c tabs groupid=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab name=\"properties\" %}} ```properties Hello = World ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML properties { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello = World Non-Distinct groupid See what happens t' this tab view if ye select properties tab from th' previous example.\n{{\u003c tabs groupid=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} json XML { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e ",
"description": "",
"tags": null,
"title": "Tabbed views",
"uri": "/hugo-theme-relearn/pir/shortcodes/tabs/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Tags",
"uri": "/hugo-theme-relearn/pir/tags/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nPlaceholder…\n",
"description": "",
"tags": null,
"title": "Th' one an' only hidden child",
"uri": "/hugo-theme-relearn/pir/tests/chapters/children-1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "tutorrrial",
"uri": "/hugo-theme-relearn/pir/tags/tutorrrial/"
},
{
"content": " Arrr! Pirrrates Fello' pirrates, be awarrre some stuff may not work fer us in this trrranslat'n. Like table of rrramblings, see'ng Merrrmaids, do'ng math or chemistrrry and stuff.\nMake a vis'ble block\nAn' another one\n",
"description": "Test dynamic width rrresizing o' content if scrrrollbar 's present",
"tags": null,
"title": "Width",
"uri": "/hugo-theme-relearn/pir/tests/width/"
}
]