mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
1 line
No EOL
84 KiB
JSON
1 line
No EOL
84 KiB
JSON
[{"content":" Chapter 1 Basics Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.\n","description":"","tags":null,"title":"Basics","uri":"/pir/basics/"},{"content":" This be a plain demo child plank.\n","description":"","tags":null,"title":"Plank X","uri":"/pir/shortcodes/children/test/"},{"content":" Chapter 2 Rambl'n Find out how t' create an' org'nize yer rambl'n quickly an' intuitively.\n","description":"","tags":null,"title":"Rambl'n","uri":"/pir/cont/"},{"content":" Chapter 3 Shorrrtcodes Cap'n Hugo uses Marrrkdown fer its simple rambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shorrrtcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nAttachments Th' Attachments shorrrtcode displays a list o' files attached t' a plank\nButton Nice buttons on yer plank\nChildren List th' child planks o' a plank\nExpand Displays an expandable/collaps'ble section o' text on yer plank\nInclude Displays rambl'n from other Marrrkdown files\nMerrrmaid Generat'n o' diagram an' flowchart from text 'n a similar manner as Marrrkdown\nNotice Disclaimers t' help ye structure yer plank\nShip param Get value o' ship params variables 'n yer plank\nTabbed views Synchr'nize select'n o' rambl'n 'n different tabbed views\n ","description":"","tags":null,"title":"Shorrrtcodes","uri":"/pir/shortcodes/"},{"content":" Chapter 4 This could be yours Start yer success story. Now!\n","description":"","tags":null,"title":"This could be yers","uri":"/pir/yours/"},{"content":" In Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rambl'n folder wit' all yer planks.\nrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast_index.md be required 'n each folder, it’s yer “folder home page”\n Types Th' Relearrrn theme defines two types o' planks. Default an' Chapter. Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.\nA 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 rambl'n that can be found under it. Ye can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an ay'con.\n+++ chapter = true pre = \"\u003cb\u003e1. \u003c/b\u003e\" title = \"Basics\" weight = 5 +++ ### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it. T' tell th' Relearrrn theme t' consider a plank as a chapter, set chapter=true 'n th' Front Matter o' th' plank.\nA Default plank be any other rambl'n plank.\n+++ title = \"Installation\" weight = 15 +++ Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n 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 Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\nFront Matter configurat'n Each Cap'n Hugo plank has t' define a Front Matter '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 'n menu will be prefixed by this HTML rambl'n pre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rambl'n post = \"\" # Set th' plank as a chapter, chang'n th' way it's displayed chapter = false # 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 pre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" pre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n sibl'n menu/page entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight parameter t' a number.\n+++ title = \"My page\" weight = 5 +++ Us'n a custom title fer menu entries By default, th' Relearrrn theme will use a page’s title attribute fer th' menu item (or linkTitle if defined).\nBut a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' menuTitle parameter fer that purpose:\nFor example (for a plank named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++ Override expand state rules fer menu entries Ye can change how th' theme expands menu entries on th' side o' th' rambl'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:\n all 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.\nYer Plank T' configure yer plank, ye basically have three choices:\n Create an _index.md document 'n rambl'n folder an' fill th' file wit' Marrrkdown rambl'n Create an index.html file 'n th' static folder an' fill th' file wit' HTML rambl'n Configure yer server t' automatically redirect home plank t' one yer documentat'n plank ","description":"","tags":null,"title":"Planks orrrganizat'n","uri":"/pir/cont/pages/"},{"content":" Us'n th' command: hugo new [relative new rambl'n path], ye can start a rambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes.\nIt be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.\nChapter T' create a Chapter plank, run th' follow'n commands\nhugo new --kind chapter \u003cname\u003e/_index.md It will create a plank wit' predefined Front-Matter:\n+++ chapter = true pre = \"\u003cb\u003eX. \u003c/b\u003e\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ ### Chapter X # Some Chapter title Lorem Ipsum. Default T' create a default plank, run either one o' th' follow'n commands either\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md It will create a plank wit' predefined Front-Matter:\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ Lorem Ipsum. ","description":"","tags":null,"title":"Arrrchetypes","uri":"/pir/cont/archetypes/"},{"content":" This be a demo child plank.\nSubpages o' this plank plank 1-1 ","description":"","tags":["children","non-hidden"],"title":"Plank 1","uri":"/pir/shortcodes/children/children-1/"},{"content":" Thanks 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) : it’s that simple.\n","description":"","tags":null,"title":"Requirrrements","uri":"/pir/basics/requirements/"},{"content":" Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003e Install th' theme Install th' Relearrrn theme by follow'n this documentat'n\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\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 rambl'n planks Then, create rambl'n planks inside th' previously created chapter. Here be two ways t' create rambl'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 rambl'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:\n Ye 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 rambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvastThis website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks\n ","description":"","tags":null,"title":"Installat'n","uri":"/pir/basics/installation/"},{"content":" Let’s face it: Writ'n rambl'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:\n Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid XHTML output. Keeps th' rambl'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:\n Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\n Without 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!\n Head'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 Heading\u003c/h1\u003e \u003ch2\u003eh2 Heading\u003c/h2\u003e \u003ch3\u003eh3 Heading\u003c/h3\u003e \u003ch4\u003eh4 Heading\u003c/h4\u003e \u003ch5\u003eh5 Heading\u003c/h5\u003e \u003ch6\u003eh6 Heading\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':\n Paragraphs 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' rambl'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':\n 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.\n an' 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':\n Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\n 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.\n Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\n Lists 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':\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 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':\n Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem 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 ArrrseIf ye just use 1. fer each number, Marrrkdown will automatically number each item. For example:\n 1. 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':\n Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem 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':\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. An' this HTML:\n\u003ct'ble\u003e \u003ctr\u003e \u003cth\u003eOption\u003c/th\u003e \u003cth\u003eDescription\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 Rambl'n fer chapter one. ## Chapter 2 \u003ca id=\"chapter-2\"\u003e\u003c/a\u003e Rambl'n fer chapter one. ## Chapter 3 \u003ca id=\"chapter-3\"\u003e\u003c/a\u003e Rambl'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 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   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   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 ","description":"","tags":null,"title":"Marrrkdown rules","uri":"/pir/cont/markdown/"},{"content":" Th' Relearrrn theme uses Hugo’s built-in rules highlight'n fer code.\nMarrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders t':\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Cap'n Hugo comes wit' a remark'ble list o' supported languages.\nRecommended configurat'n Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml\n[markup] [markup.highlight] style = \"base16-snazzy\" # choose a color theme or create yer own guessSyntax = false # if set t' true, avoid unstyled code if no language was given but mermaid code fences will not work anymore ","description":"","tags":null,"title":"Code highlight'n","uri":"/pir/cont/syntaxhighlight/"},{"content":" This document shows ye what’s 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.\n 2.8.0 Change: Although never officially documented, this release removes th' font Novacento/Novecento from th' release. 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.\n New: 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.\n New: 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.\n 2.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: Add new colors --MAIN-CODE-color an' --MAIN-CODE-BG-color fer rules highlightn'n fallback 'n yer stylesheet 'n case guessSyntax=true be set. Ideally they 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. Th' documentat'n was adjusted accordingly.\n New: 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.\n New: 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.\n New: New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shorrrtcode. Poss'ble values be title or weight.\n New: Alternate rambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n 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' site’s 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 exampleSite), they will now be ignored by th' search.\n New: 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.\n New: If a search term be found 'n an expand shorrrtcode, th' expand will be opened.\n New: Th' menu will scroll th' active item into view on board.\n 2.0.0 Change: Syntaxhighlightn'n was switched t' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as describedd on 'n th' Cap'n Hugo documentat'n\n Change: In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color.\n Change: --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.\n Change: 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.\n Change: If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\n Change: A plank without a title will be treated as hidden=true.\n New: Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\n New: New partials fer defin'n pre/post rambl'n fer menu items an' th' rambl'n. See documentat'n fer further read'n.\n New: Shorrrtcode children wit' new parameter containerstyle.\n New: New shorrrtcode include t' include arbitrary file rambl'n into a plank.\n 1.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. ","description":"","tags":null,"title":"Migrrrat'n","uri":"/pir/basics/migration/"},{"content":" Global 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 this page\" 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' true, prevents Cap'n Hugo from includ'n th' Merrrmaid module if not needed (will reduce board times an' traffic) disableMermaid = false # Specifies th' remote locat'n o' th' Merrrmaid js customMermaidURL = \"https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js\" # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # Hide Next an' Previous plank buttons normally displayed full height beside rambl'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. Can be \"red\", \"blue\", \"green\". themeVariant = \"\" # Provide a list o' custom css files t' board relative from th' `static/` folder 'n th' ship root. custom_css = [\"css/foo.css\", \"css/bar.css\"] # Change th' title separator. Default t' \"::\". titleSeparator = \"-\" 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.\n Cap'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 doesn’t show up 'n th' filesystem\n Merrrmaid 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.\n Example:\nMerrrmaid be globally disabled. By default it won’t be boarded by any plank. On plank “Architecture” ye need a class diagram. Ye can set th' Merrrmaid parameters locally t' only board mermaid on this plank (not on th' others).\n Ye 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[Lanugages] [Lanugages.en] ... landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Lanugages.pir] ... landingPageURL = \"/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:\nlandingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" Th' home button be go'n t' look like this:\n","description":"","tags":null,"title":"Configurrrat'n","uri":"/pir/basics/configuration/"},{"content":" This be a demo child plank wit' no descript'n.\nSo its rambl'n be used as descript'n.\n","description":"","tags":["children","non-hidden"],"title":"Plank 2","uri":"/pir/shortcodes/children/children-2/"},{"content":" Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\n rambl'n: th' rambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rambl'n. header: th' header o' th' rambl'n plank (contains th' breadcrumbs). Not meant t' be overwritten custom-header: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file footer: th' footer o' th' rambl'n plank (contains th' arrows). Not meant t' be overwritten custom-footer: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Don’t forget t' include javascript HTML tag directive 'n yer file favicon: th' favicon logo: th' logo, on top left hand corner. meta: HTML meta tags, if ye want t' change default behavior menu: left menu. Not meant t' be overwritten menu-pre: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s pre sett'n into account. menu-post: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' page’s post sett'n into account. menu-footer: footer o' th' the left menu search: search box toc: t'ble o' contents 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!\nAvastTh' size o' th' logo will adapt automatically\n Change 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 default colors Th' Relearrrn theme let ye choose between some predefined color scheme variants, but feel free t' add one yourself!\nStandard variant [params] # Change default color scheme wit' a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"\" Red variant [params] # Change default color scheme wit' a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"red\" Blue variant [params] # Change default color scheme wit' a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"blue\" Green variant [params] # Change default color scheme wit' a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"green\" ‘Mine‘ variant First, create a new CSS file 'n yer local static/css folder prefixed by theme (e.g. wit' mine theme static/css/theme-mine.css). Copy th' follow'n rambl'n an' modify colors 'n CSS variables.\n:root { --MAIN-TEXT-color: #323232; /* Color o' text by default */ --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color o' titles h2-h3-h4-h5-h6 */ --MAIN-LINK-color: #1C90F3; /* Color o' links */ --MAIN-LINK-HOVER-color: #167ad0; /* Color o' hovered links */ --MAIN-ANCHOR-color: #1C90F3; /* color o' anchors on titles */ --MAIN-CODE-color: #e2e4e5; /* fallback color fer code background */ --MAIN-CODE-BG-color: #282a36; /* fallback color fer code text */ --MENU-HOME-LINK-color: #323232; /* Color o' th' home button text */ --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color o' th' hovered home button text */ --MENU-HEADER-BG-color: #1C90F3; /* Background color o' menu header */ --MENU-HEADER-BORDER-color: #33a1ff; /*Color o' menu header border */ --MENU-SEARCH-BG-color: #167ad0; /* Search field background color (by default borders + icons) */ --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */ --MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field ay'cons color */ --MENU-SECTIONS-ACTIVE-BG-color: #20272b; /* Background color o' th' active section an' its children */ --MENU-SECTIONS-BG-color: #252c31; /* Background color o' other sections */ --MENU-SECTIONS-LINK-color: #ccc; /* Color o' links 'n menu */ --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color o' links 'n menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color o' active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color o' background fer th' active category (only) */ --MENU-VISITED-color: #33a1ff; /* Color o' 'page visited' ay'cons 'n menu */ --MENU-SECTION-HR-color: #20272b; /* Color o' \u003chr\u003e separator 'n menu */ } Then, set th' themeVariant value wit' th' name o' yer custom theme file. That’s it!\n[params] # Change default color scheme wit' a variant one. Can be \"red\", \"blue\", \"green\". themeVariant = \"mine\" ","description":"","tags":null,"title":"Customizat'n","uri":"/pir/basics/customization/"},{"content":" Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rambl'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 = \"/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 = \"/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 rambl'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 = \"Documentation for Hugo Relearn 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 = \"/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 = \"/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 = \"Documentat'n fer 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 = \"/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 = \"/credits/\" weight = 30 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" url = \"/tags/\" weight = 40 Read more about hugo menu an' hugo multilingual menus\n","description":"","tags":null,"title":"Menu extrrra shorrrtcuts","uri":"/pir/cont/menushortcuts/"},{"content":" Th' 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 rambl'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\n Change colour (by default th' ay'con will inherit th' parent colour) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\n","description":"","tags":null,"title":"Ay'cons an' logos","uri":"/pir/cont/icons/"},{"content":" Changelog 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature] 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] Support Custom Notice 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] 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] theme: simplify stylesheet fer color variants #107 [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative rambl'n 'n header #101 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: add default sett'n fer menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config be used #105 [bug] theme: fix sticky header t' remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage o' section element #88 Maintenance [task] theme: ensure IE11 compatiblity #89 [task] docs: Arrr! showcase multilang featurrre #87 2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84 2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readablility o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug] search: hide non-site rambl'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] 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 rambl'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] code highligher: switch t' standard hugo highlighter #32 Fixes [bug] arrow-nav: default sort'n ignores ordersectionsby #63 [bug] children: default sort'n ignores ordersectionsby #62 [bug] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superflous singular taxonomy from taxonomy title #46 [bug] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ","description":"","tags":null,"title":"Historrry","uri":"/pir/basics/history/"},{"content":" Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nIt provides:\n Translat'n str'ns fer default values (English, Arabic, Dutch, Piratized English, German, Hindi, Indonesian, Japanese, Piratized English, Portuguese, Russian, Simplified Chinese, Spanish, Turkish). Feel free t' contribute! Automatic menu generat'n from multilingual rambl'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 = \"Documentation for Hugo Relearn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, fer each new plank, append th' id o' th' language t' th' file.\n Single 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 AhoiBe aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rambl'n.\n Smarrrt ArrrseUse slug Front Matter parameter t' translate urls too.\n Overwrite translat'n str'ns Translat'ns str'ns be used fer common default values used 'n th' theme (Edit this plank 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":"/pir/cont/i18n/"},{"content":" This be a demo child plank.\nSubpages o' this plank plank 3-1 ","description":"","tags":["children","non-hidden"],"title":"Plank 3","uri":"/pir/shortcodes/children/children-3/"},{"content":" This 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 aren’t view'n this plank or its children directly.\n","description":"","tags":["children","hidden"],"title":"Plank 4 (hidden)","uri":"/pir/shortcodes/children/children-4/"},{"content":" Th' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.\nConfigurat'n Just add tags t' any plank:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.\nEach tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.\nList all th' tags In th' config.toml file ye can add a shortcut t' display all th' tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ","description":"","tags":["documentat'n","tutorrrial"],"title":"Tags","uri":"/pir/cont/tags/"},{"content":" Attachments NoTreasure.txt (26 B) Th' Attachments shorrrtcode displays a list o' files attached t' a plank.\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 Th' shortcurt lists files found 'n a specific folder. Currently, it support two implementat'ns fer planks\n If yer plank be a Marrrkdown file, attachements must be placed 'n a folder named like yer plank an' end'n wit' .files.\n rambl'n _index.md plank.files attachment.pdf plank.md If yer plank be a folder, attachements must be placed 'n a nested ‘files’ folder.\n rambl'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.\nThat’s all!\nParameters Parameter Default Descript'n title “Attachments” List’s title sort “asc” Sort'n th' output 'n ascend'n or descend'n order style \"\" Choose between orange, grey, blue an' green fer nice style pattern “.*” A regular expressions, used t' filter th' attachments by file name. Th' pattern parameter value must be regular expressions. For example:\n T' match a file suffix o' ‘jpg’, use *.jpg (not *.jpg). T' match file names end'n 'n ‘jpg’ or ‘png’, use .*(jpg|png) Examples List o' attachments end'n 'n pdf or mp4 {{%attachments title=\"Related files\" pattern=\".*(pdf|mp4)\"/%}} renders as\nRelated files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Colored styled box {{%attachments style=\"orange\" /%}} renders as\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) {{%attachments style=\"grey\" /%}} renders as\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) {{%attachments style=\"blue\" /%}} renders as\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) {{%attachments style=\"green\" /%}} renders as\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) ","description":"","tags":null,"title":"Attachments","uri":"/pir/shortcodes/attachments/"},{"content":" A button be a just a click'ble button wit' optional ay'con.\n{{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" %}}Get Cap'n Hugo wit' icon{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" ay'con-position=\"right\" %}}Get Cap'n Hugo wit' ay'con right{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo wit' ay'con Get Cap'n Hugo wit' ay'con right ","description":"","tags":null,"title":"Button","uri":"/pir/shortcodes/button/"},{"content":"","description":"","tags":null,"title":"Categories","uri":"/pir/categories/"},{"content":" Use th' children shorrrtcode t' list th' child planks o' a plank an' th' further descendants (children’s children). By default, th' shorrrtcode displays links t' th' child planks.\nUsage Parameter Default Descript'n plank current 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 descript'n “false” Allows ye t' include a short text under each plank 'n th' list. When no descript'n exists fer th' plank, children shorrrtcode takes th' first 70 words o' yer rambl'n. Read more info about summaries on gohugo.io depth 1 Enter a number t' specify th' depth o' descendants t' display. For example, if th' value be 2, th' shorrrtcode will display 2 levels o' child planks. Tips: set 999 t' get all descendants sort ordersectionsby Sort children by weight, t' sort on menu order - title, t' sort alphabetically on menu label. If not set it be sorted by th' ordersectionsby sett'n o' th' ship an' th' planks frontmatter Demo {{% children %}} plank X plank 1 plank 2 plank 3 {{% children description=\"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 rambl'n be used as descript'n.\nplank 3 This be a demo child plank\n {{% 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) {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"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 rambl'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\n {{% children containerstyle=\"div\" style=\"div\" depth=\"999\" %}} plank X plank 1 plank 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 ","description":"","tags":null,"title":"Children","uri":"/pir/shortcodes/children/"},{"content":"","description":"","tags":null,"title":"children","uri":"/pir/tags/children/"},{"content":" Contributors Special thanks t' everyone who has contributed t' this project.\nMany thanks t' @matcornic fer his work on th' Learrrn theme.\nPackages an' libraries Merrrmaid - generat'n o' diagram an' flowchart from text 'n a similar manner as Marrrkdown font awesome - th' iconic font an' CSS framework jQuery - Th' Write Less, Do More, JavaScript Library jquery-svg-zoom-pan - en'ble pan an' zoom 'n Merrrmaid graphs lunr - Lunr enables ye t' provide a great search experience without th' need fer external, server-side, search services… clipboard.js - copy text t' clipboard modernizr - A JavaScript toolkit that allows web developers t' use new CSS3 an' HTML5 features while maintain'n a fine level o' control over browsers that don’t support Tool'n gren - Releasenotes generator Cap'n Hugo - Static ship generator Netlify - Continuous deployement an' host'n o' this documentat'n Wercker - Continous test'n ","description":"","tags":null,"title":"Crrredits","uri":"/pir/credits/"},{"content":"","description":"","tags":null,"title":"documentat'n","uri":"/pir/tags/documentatn/"},{"content":" Th' Expand shorrrtcode displays an expandable/collaps'ble section o' text on yer plank.\nUsage {{% expand [ \u003cstr'n\u003e [ \"true\" | \"false\" ] ] %}} Yes! {{% /expand %}} Th' first optional parameter defines th' text that appears next t' th' expand/collapse ay'con. Th' default text be \"Expand me...\".\nTh' second optional parameter controls if th' block be initially shown as expanded (\"true\") or collapsed (\"false\"). Th' default ist \"false\".\nExamples I'll tell ye a secret... …maybe th' next time you’ll open this expander!\n All defaults Expand me... Yes, ye did it!\n Show marrrkup {{% expand %}} Yes, ye did it! {{% /expand %}} Initially expanded Expand me... No need t' press ye!\n Show marrrkup {{% expand \"Expand me...\" \"true\" %}} No need t' press ye! {{% /expand %}} Arbitrary text Show me endless possibilities Some expand'ble text.\nYe can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides expand etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% expand \"Show me endless possibilities\" %}} Some expand'ble text. Ye can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - other shorrrtcodes besides `expand` - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless {{% /expand %}} ","description":"","tags":null,"title":"Expand","uri":"/pir/shortcodes/expand/"},{"content":"","description":"","tags":null,"title":"hidden","uri":"/pir/tags/hidden/"},{"content":" Th' include shorrrtcode includes other files from yer project inside o' th' current file. This can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nUsage {{% include \u003cstr'n\u003e [ \"true\" | \"false\" ] %}} Th' first required parameter be th' path t' th' file t' be included.\nIf th' file’s rambl'n will be displayed as HTML, th' second optional parameter controls if th' first head'n o' th' included file should be displayed (\"true\")- which be th' default - or be hidden.\nExamples Arbitray rambl'n Ye can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides include etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% include \"shortcodes/INCLUDE_ME.md\" %}} ","description":"","tags":null,"title":"Include","uri":"/pir/shortcodes/include/"},{"content":" Merrrmaid be a library help'n ye t' generate diagram an' flowcharts from text, 'n a similar manner as Marrrkdown.\nUsage Just insert yer Merrrmaid code 'n th' mermaid shorrrtcode like this:\n{{\u003c mermaid [ align=(\"left\"|\"right\"|\"center\"|\"justify\") ] \u003e}} classDiagram Person *-- Dog {{\u003c /mermaid \u003e}} Ye can set an optional align attribute which defaults t' \"center\".\nIf ye don’t need alignment ye can use th' alternative rules us'n code fences if ye have turned off guessSyntax fer th' marrrkup.highlight sett'n (see below):\n```mermaid classDiagram Person *-- Dog ``` 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.\nExamples Flowchart graph LR; A[Hard edge] --|Link text| B(Round edge) B -- C{Decision} C --|One| D[Result one] C --|Two| E[Result two] Show marrrkup {{\u003c mermaid align=\"left\" \u003e}} 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}} Sequence sequenceDiagram participant Alice participant Bob Alice-John: Hello John, how be ye? loop Healthcheck John-John: Fight against hypochondria end Note right of John: Rational thoughts prevail... John--Alice: Great! John-Bob: How about ye? Bob--John: Jolly bloody! Show marrrkup {{\u003c mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts \u003cbr/\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about ye? Bob--\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} GANTT 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 Show marrrkup {{\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}} Class classDiagram Class01 C2 : Whar' am i? Class09 --* C3 Class09 --| Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 C2: Cool label Show marrrkup {{\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}} State 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 Show marrrkup ```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 ``` Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns sidewise thru yer planks frontmatter.\nThis JSON object be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nAlso, if ye want t' use mermaid codefences, ye have t' turn off guessSyntax fer th' marrrkup.highlight sett'n.\nExample [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [markup] [markup.highlight] guessSyntax = false # if set t' true, avoid unstyled code if no language was given but mermaid code fences will not work anymore or planks frontmatter\n+++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ ","description":"","tags":null,"title":"Merrrmaid","uri":"/pir/shortcodes/mermaid/"},{"content":"","description":"","tags":null,"title":"non-hidden","uri":"/pir/tags/non-hidden/"},{"content":" Th' notice shorrrtcode shows four types o' disclaimers t' help ye structure yer plank.\nUsage {{% notice ( note | info | tip | warning ) [ \u003cstr'n\u003e ] %}} Some marrrkup {{% /notice %}} Th' first parameter be required an' indicates th' type o' notice.\nTh' second parameter be optional. If provided, it will be used as th' title o' th' notice. If not provided, then th' type o' notice will be used as th' title. For example, th' title o' a warning notice will be “Warning”.\nExamples Avast AvastA notice disclaimer\nYe can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides notice etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% notice note %}} A **notice** disclaimer Ye can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - other shorrrtcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless {{% /notice %}} Ahoi AhoiAn informat'n disclaimer\nYe can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides notice etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% notice info %}} An **informat'n** disclaimer Ye can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - other shorrrtcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless {{% /notice %}} Smarrrt Arrrse Smarrrt ArrrseA tip disclaimer\nYe can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides notice etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% notice tip %}} A **tip** disclaimer Ye can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - other shorrrtcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless {{% /notice %}} Arrr ArrrA warning disclaimer\nYe can add:\n multiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links other shorrrtcodes besides notice etc. ...and even source code th' possiblities be endless\n Show marrrkup {{% notice warning %}} A **warning** disclaimer Ye can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - other shorrrtcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e th' possiblities be endless {{% /notice %}} Notice wit' Custom Title Ye can cust'mize th' title o' th' notice by pass'n it as a second parameter.\nPay Attent'n t' this Avast!Th' title be now th' parameter that was provided.\n Show marrrkup {{% notice note \"Pay Attent'n t' this Avast!\" %}} Th' title be now th' parameter that was provided. {{% /notice %}} ","description":"","tags":null,"title":"Notice","uri":"/pir/shortcodes/notice/"},{"content":" This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1 (hidden) plank 1-1-2 plank 1-1-3 ","description":"","tags":["children","non-hidden"],"title":"Plank 1-1","uri":"/pir/shortcodes/children/children-1/children-1-1/"},{"content":" This 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 aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ","description":"","tags":["children","hidden"],"title":"Plank 1-1-1 (hidden)","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/"},{"content":" This be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search.\nSubpages o' this plank plank 1-1-1-1-1 (hidden) ","description":"","tags":["children","hidden"],"title":"Plank 1-1-1-1","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"},{"content":" This 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 aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ","description":"","tags":["children","hidden"],"title":"Plank 1-1-1-1-1 (hidden)","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/"},{"content":" This be a non-hidden demo child plank o' a hidden parent plank.\n","description":"","tags":["children","hidden"],"title":"Plank 1-1-1-1-1-1","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/"},{"content":" This be a plain demo child plank.\nSubpages o' this plank plank 1-1-2-1 plank 1-1-2-2 ","description":"","tags":["children","non-hidden"],"title":"Plank 1-1-2","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/"},{"content":" This be a plain demo child plank.\n","description":"","tags":["children","non-hidden"],"title":"Plank 1-1-2-1","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/"},{"content":" This be a plain demo child plank.\n","description":"","tags":["children","non-hidden"],"title":"Plank 1-1-2-2","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/"},{"content":" This be a plain demo child plank.\n","description":"","tags":["children","non-hidden"],"title":"Plank 1-1-3","uri":"/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/"},{"content":" This be a plain demo child plank.\n","description":"","tags":["children","non-hidden"],"title":"Plank 3-1","uri":"/pir/shortcodes/children/children-3/test3/"},{"content":" ArrrArrr fello pirrates, be awarrre some featurrres may not work fer us in this trrranslat’n. Like table of contents orrr seeing Merrrmaids.\n Cap'n Hugo Relearrrn Theme Th' 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.\nAhoiTh' 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.\n Main features Smarrrt ArrrseSee what’s new within th' latest update.\n Automatic Search Multilingual mode Unlimited menu levels Automatic next/prev buttons t' navigate through menu entries Image resiz'n, shadow… Attachments files List child planks Merrrmaid diagram (flowchart, sequence, gantt) Customiz'ble look an' feel an' theme 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 this plank 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":"Relearrrn Theme fer Cap'n Hugo","uri":"/pir/"},{"content":" Th' siteparam shorrrtcode be used t' help ye print values o' ship params.\nUsage {{% siteparam \u003cstr'n\u003e %}} Th' first required parameter be th' name o' th' ship param t' be displayed.\nExamples For instance, 'n this current ship, th' editURL vari'ble be used 'n config.toml\n[params] editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" Use th' siteparam shorrrtcode t' display its value.\n`editURL` Value : {{% siteparam \"editURL\" %}} be displayed as\neditURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n","description":"","tags":null,"title":"Ship param","uri":"/pir/shortcodes/siteparam/"},{"content":" BITS by Dr. Lutz Gollan ","description":"","tags":null,"title":"Showcase","uri":"/pir/showcase/"},{"content":" Choose which rambl'n t' see across th' plank. Very handy fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.\nCode example {{\u003c tabs \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"R\" %}} ```R \u003e print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"Bash\" %}} ```Bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} Renders as:\npython R Bash print(\"Hello World!\") \u003e print(\"Hello World!\") echo \"Hello World!\" Tab views wit' th' same tabs that belong t' th' same group sychr'nize their select'n:\npython R Bash print(\"Hello World!\") \u003e print(\"Hello World!\") echo \"Hello World!\" Config example {{\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}} Renders as:\njson XML properties { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello = World ArrrWhen us'n tab views wit' different rambl'n sets, make sure t' use a common groupId fer equal sets but distinct groupId fer different sets. Th' groupId defaults t' 'default'. Take this into account across th' whole ship! Th' 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 all tabs will be empty at first.\n ","description":"","tags":null,"title":"Tabbed views","uri":"/pir/shortcodes/tabs/"},{"content":"","description":"","tags":null,"title":"Tags","uri":"/pir/tags/"},{"content":" Placeholder…\n","description":"","tags":null,"title":"Th' one an' only hidden child","uri":"/pir/yours/children-1/"},{"content":"","description":"","tags":null,"title":"tutorrrial","uri":"/pir/tags/tutorrrial/"}] |