nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-24 00:03:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hugo-theme-relearn/pir/index.json

489 lines
98 KiB
JSON
Raw Normal View History

deploy: f20760ba50cd45420f516cf32968d8a4756e8b84
2022-02-07 21:42:46 +00:00
[
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/basics/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This be a plain demo child plank.\n",
"description": "",
"tags": null,
"title": "Plank X",
"uri": "/hugo-theme-relearn/pir/shortcodes/children/test/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Chapter 2 Rrrambl'n Find 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Chapter 3 Shorrrtcodes Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A 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 rrrambl'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' rrrambl'n 'n different tabbed views\n ",
"description": "",
"tags": null,
"title": "Shorrrtcodes",
"uri": "/hugo-theme-relearn/pir/shortcodes/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Chapter 4 This could be yours Start yer success story. Now!\n",
"description": "",
"tags": null,
"title": "This could be yers",
"uri": "/hugo-theme-relearn/pir/yours/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n In Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\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 rrrambl'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 rrrambl'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 rrrambl'n pre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n post = \"\" # Set th' plank as a chapter, chang'n th' way it's dis
"description": "",
"tags": null,
"title": "Planks orrrganizat'n",
"uri": "/hugo-theme-relearn/pir/cont/pages/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes.\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": "/hugo-theme-relearn/pir/cont/archetypes/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/basics/requirements/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 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:\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 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Let’s face it: Writ'n rrrambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\n Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid 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:\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' 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-s
"description": "",
"tags": null,
"title": "Marrrkdown rules",
"uri": "/hugo-theme-relearn/pir/cont/markdown/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/cont/syntaxhighlight/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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.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. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\n Type Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard complient an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server aft an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console aft th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not found In this case, ye must apply one o' two opt'ns:\n Copy 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.\n Start 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.\n Type 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 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
"description": "",
"tags": null,
"title": "Migrrrat'n",
"uri": "/hugo-theme-relearn/pir/basics/migration/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 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. 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/is
"description": "",
"tags": null,
"title": "Configurrrat'n",
"uri": "/hugo-theme-relearn/pir/basics/configuration/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 rrrambl'n: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n. header: th' header o' th' rrrambl'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' rrrambl'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!\nAvast Th' 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 rrrambl'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: #5e5e5
"description": "",
"tags": null,
"title": "Customizat'n",
"uri": "/hugo-theme-relearn/pir/basics/customization/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n 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 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 = \"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": "/hugo-theme-relearn/pir/cont/menushortcuts/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 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\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": "/hugo-theme-relearn/pir/cont/icons/"
},
{
deploy: f20760ba50cd45420f516cf32968d8a4756e8b84
2022-02-07 21:54:15 +00:00
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Changelog 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 behaviour #156 [bug] search: make dropdown stick t' search field when scroll'n #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add miss'n right border fer inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibl'n planks reliably #152 [bug] menu: br'n active item 'n sight fer large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always board javascript t' avoid break if code fences be used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configur'ble #2 Fixes [bug] mermaid: assert that window.mermaid be actually mermaid #136 [bug] menu: remove usage o' Hugos UniqueID #131 [bug] theme: reduce margin fer children 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: 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
deploy: f20760ba50cd45420f516cf32968d8a4756e8b84
2022-02-07 21:42:46 +00:00
"description": "",
"tags": null,
"title": "Historrry",
"uri": "/hugo-theme-relearn/pir/basics/history/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 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 = \"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 Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\n Smarrrt Arrrse Use 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": "/hugo-theme-relearn/pir/cont/i18n/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/children/children-4/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/cont/tags/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "1",
"uri": "/hugo-theme-relearn/pir/yours/1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "11",
"uri": "/hugo-theme-relearn/pir/yours/10/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "2",
"uri": "/hugo-theme-relearn/pir/yours/2/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "3",
"uri": "/hugo-theme-relearn/pir/yours/3/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "4",
"uri": "/hugo-theme-relearn/pir/yours/4/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "5",
"uri": "/hugo-theme-relearn/pir/yours/5/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "6",
"uri": "/hugo-theme-relearn/pir/yours/6/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "7",
"uri": "/hugo-theme-relearn/pir/yours/7/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "8",
"uri": "/hugo-theme-relearn/pir/yours/8/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "9",
"uri": "/hugo-theme-relearn/pir/yours/9/"
},
{
"content": " Attachments NoTreasure.txt (26 B) Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 rrrambl'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 rrrambl'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": "/hugo-theme-relearn/pir/shortcodes/attachments/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/button/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Categories",
"uri": "/hugo-theme-relearn/pir/categories/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 rrrambl'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 rrrambl'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 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\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": "/hugo-theme-relearn/pir/shortcodes/children/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "children",
"uri": "/hugo-theme-relearn/pir/tags/children/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/credits/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "documentat'n",
"uri": "/hugo-theme-relearn/pir/tags/documentatn/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/expand/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "hidden",
"uri": "/hugo-theme-relearn/pir/tags/hidden/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 rrrambl'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 rrrambl'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": "/hugo-theme-relearn/pir/shortcodes/include/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 --\u
"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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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 Avast A 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 Ahoi An 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 Arrrse A 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 Arrr A 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": "/hugo-theme-relearn/pir/shortcodes/notice/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n This 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 Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\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.\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.\n Main features Smarrrt Arrrse See 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": "/hugo-theme-relearn/pir/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n 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": "/hugo-theme-relearn/pir/shortcodes/siteparam/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n BITS by Dr. Lutz Gollan ",
"description": "",
"tags": null,
"title": "Showcase",
"uri": "/hugo-theme-relearn/pir/showcase/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Choose which rrrambl'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 Arrr When us'n tab views wit' different rrrambl'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": "/hugo-theme-relearn/pir/shortcodes/tabs/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "Tags",
"uri": "/hugo-theme-relearn/pir/tags/"
},
{
"content": " Arrr Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings and stuff.\n Placeholder…\n",
"description": "",
"tags": null,
"title": "Th' one an' only hidden child",
"uri": "/hugo-theme-relearn/pir/yours/children-1/"
},
{
"content": "",
"description": "",
"tags": null,
"title": "tutorrrial",
"uri": "/hugo-theme-relearn/pir/tags/tutorrrial/"
}
]
Reference in a new issue Copy permalink