diff --git a/404.html b/404.html index 8b27ed7198..fb92c88e96 100644 --- a/404.html +++ b/404.html @@ -3,18 +3,19 @@ + - + 404 Page not found :: Documentation for Hugo Relearn Theme - - - - - - - - + + + + + + + + diff --git a/basics/changelog/index.html b/basics/changelog/index.html index 07c61dd453..4b14ed0d51 100644 --- a/basics/changelog/index.html +++ b/basics/changelog/index.html @@ -3,21 +3,22 @@ + - + :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn - - - + + +
- - - + + +
    @@ -546,14 +547,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/basics/index.html b/basics/index.html index c419d3bd2c..0aff974b73 100644 --- a/basics/index.html +++ b/basics/index.html @@ -3,21 +3,22 @@ + - + Basics :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/basics/installation/index.html b/basics/installation/index.html index ca48f616d6..59eee4b7b6 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -3,21 +3,22 @@ + - + Installation :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -217,14 +218,14 @@ hugo new basics/second-content/_index.md
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/basics/migration/index.html b/basics/migration/index.html index 5188d16305..377c6ca6e3 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -3,21 +3,22 @@ + - + What's new :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -359,14 +360,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 1db9ded302..db2403fee9 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -3,21 +3,22 @@ + - + Requirements :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index 403c4defce..09ad1d7ab7 100644 --- a/categories/index.html +++ b/categories/index.html @@ -3,21 +3,22 @@ + - + Categories :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -149,14 +150,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index 2f25d05bd5..cb3e1be4c8 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -3,20 +3,21 @@ + - + Archetypes :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -191,14 +192,14 @@ Lorem Ipsum.
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 14a7c2f16f..d7b35ecef4 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -3,21 +3,22 @@ + - + Multilingual and i18n :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -217,14 +218,14 @@ languageName = "Arrr! Pirrrates"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/icons/index.html b/cont/icons/index.html index 09c204d75c..e23c90b175 100644 --- a/cont/icons/index.html +++ b/cont/icons/index.html @@ -3,20 +3,21 @@ + - + Icons and logos :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -181,14 +182,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/index.html b/cont/index.html index cf0ca79abd..09d3b32328 100644 --- a/cont/index.html +++ b/cont/index.html @@ -3,21 +3,22 @@ + - + Content :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 7c622ca5aa..30e99a737f 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -3,20 +3,21 @@ + - + Markdown syntax :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -683,14 +684,14 @@ grunt.initConfig({
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index d51dadea3f..10a5116acb 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -3,20 +3,21 @@ + - + Menu extra shortcuts :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -268,14 +269,14 @@ other = "<Your value>"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/pages/index.html b/cont/pages/index.html index 1afb536e04..58e185b74f 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -3,21 +3,22 @@ + - + Pages organization :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -298,14 +299,14 @@ menuTitle = "Linux"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/syntaxhighlight/index.html b/cont/syntaxhighlight/index.html index 6959168ef6..9994662e4f 100644 --- a/cont/syntaxhighlight/index.html +++ b/cont/syntaxhighlight/index.html @@ -3,20 +3,21 @@ + - + Code highlighting :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -201,14 +202,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/cont/tags/index.html b/cont/tags/index.html index d580aeeaef..5c6d99a1b7 100644 --- a/cont/tags/index.html +++ b/cont/tags/index.html @@ -3,20 +3,21 @@ + - + Tags :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -183,14 +184,14 @@ weight = 30
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/credits/index.html b/credits/index.html index 08918bdefb..eff1f5486b 100644 --- a/credits/index.html +++ b/credits/index.html @@ -3,20 +3,21 @@ + - + Credits :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -167,14 +168,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/index.html b/index.html index feaeca3dab..06ab852986 100644 --- a/index.html +++ b/index.html @@ -3,21 +3,22 @@ + - + Relearn Theme for Hugo :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -162,14 +163,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/index.json b/index.json index 1dc1002a41..7b12a52bf9 100644 --- a/index.json +++ b/index.json @@ -1 +1 @@ -[{"content":"Chapter 1 Basics Discover what this Hugo theme is all about and the core-concepts behind it.\n","description":"","tags":null,"title":"Basics","uri":"/basics/"},{"content":"This is a plain demo child page.\n","description":"This is a plain page test, and the beginning of a YAML multiline description...\n","tags":null,"title":"page X","uri":"/shortcodes/children/test/"},{"content":"Chapter 2 Content Find out how to create and organize your content quickly and intuitively.\n","description":"","tags":null,"title":"Content","uri":"/cont/"},{"content":"This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.\nBreaking: A change that requires action by you after upgrading to assure the site is still functional.\nChange: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.\nNew: Marks new behavior you might find interesting or comes configurable.\n 2.9.0 Breaking: This release removes the themes implementation of ref/relref in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.\nIn a standard complient form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\n Type Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configuration Leaf bundle basics/configuration/index.md basics/configuration Page basics/configuration.md basics/configuration If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the 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\": page not found In this case, you must apply one of two options:\n Copy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.\n Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all *.md files. This is the recommended choice.\n Type Search Replace by Branch bundle (ref\\s+\"[^\"]*)/_index\\.md\" $1\" Leaf bundle (ref\\s+\"[^\"]*)/index\\.md\" $1\" Page (ref\\s+\"[^\"]*)\\.md\" $1\" 2.8.0 Change: Although never officially documented, this release removes the font Novacento/Novecento from the release. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.\n New: The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\n New: You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.\n 2.7.0 New: Optional second parameter for notice shortcode to set title in box header. 2.6.0 New: Your site can now be served from a subfolder if you set baseURL and canonifyURLs=true in your config.toml. See the documentation for a detailed example. 2.5.0 Change: Add new colors --MAIN-CODE-color and --MAIN-CODE-BG-color for syntax highlightning fallback in your stylesheet in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style. 2.4.0 Change: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The documentation was adjusted accordingly.\n New: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.\n New: You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\n New: New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\n New: Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n 2.2.0 New: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your config.toml. 2.1.0 Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in exampleSite), they will now be ignored by the search.\n New: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.\n New: If a search term is found in an expand shortcode, the expand will be opened.\n New: The menu will scroll the active item into view on load.\n 2.0.0 Change: Syntaxhighlightning was switched to built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as describedd on in the Hugo documentation\n Change: In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color.\n Change: --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets.\n Change: Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\n Change: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\n Change: A page without a title will be treated as hidden=true.\n New: You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\n New: New partials for defining pre/post content for menu items and the content. See documentation for further reading.\n New: Shortcode children with new parameter containerstyle.\n New: New shortcode include to include arbitrary file content into a page.\n 1.2.0 New: Shortcode expand with new parameter to open on page load. 1.1.0 New: Mermaid config options can be set in config.toml. ","description":"","tags":null,"title":"What's new","uri":"/basics/migration/"},{"content":"Chapter 3 Shortcodes Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.\nBut this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.\nTo avoid this limitations, Hugo created shortcodes. A shortcode is a simple snippet inside a page.\nThe Relearn theme provides multiple shortcodes on top of existing ones.\nAttachments The Attachments shortcode displays a list of files attached to a page\nButton Nice buttons on your page\nChildren List the child pages of a page\nExpand Displays an expandable/collapsible section of text on your page\nInclude Displays content from other Markdown files\nMermaid Generation of diagram and flowchart from text in a similar manner as Markdown\nNotice Disclaimers to help you structure your page\nSite param Get value of site params variables in your page\nTabbed views Synchronize selection of content in different tabbed views\n ","description":"","tags":null,"title":"Shortcodes","uri":"/shortcodes/"},{"content":"Chapter 4 This could be yours Start your success story. Now!\n","description":"","tags":null,"title":"This could be yours","uri":"/yours/"},{"content":"In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.\nFolders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.\ncontent ├── 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 Note_index.md is required in each folder, it’s your “folder home page”\n Types The Relearn theme defines two types of pages. Default and Chapter. Both can be used at any level of the documentation, the only difference being layout display.\nA Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it. You can define any HTML as prefix for the menu. In the example below, it’s just a number but that could be an icon.\n+++ chapter = true pre = \"\u003cb\u003e1. \u003c/b\u003e\" title = \"Basics\" weight = 5 +++ ### Chapter 1 # Basics Discover what this Hugo theme is all about and the core-concepts behind it. To tell the Relearn theme to consider a page as a chapter, set chapter=true in the Front Matter of the page.\nA Default page is any other content page.\n+++ title = \"Installation\" weight = 15 +++ The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e The Relearn theme provides archetypes to help you create this kind of pages.\nFront Matter configuration Each Hugo page has to define a Front Matter in toml, yaml or json. This site will use toml in all cases.\nThe Relearn theme uses the following parameters on top of Hugo ones :\n+++ # Table of contents (toc) is enabled by default. Set this parameter to true to disable it. # Note: Toc is always disabled for chapter pages disableToc = false # If set, this will be used for the page's menu entry (instead of the `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules for the expand state of a page's menu entry alwaysopen = true # If set, this will explicitly override common rules for the sorting order of a page's submenu entries ordersectionsby = \"title\" # The title of the page in menu will be prefixed by this HTML content pre = \"\" # The title of the page in menu will be postfixed by this HTML content post = \"\" # Set the page as a chapter, changing the way it's displayed chapter = false # Hide a menu entry by setting this to true hidden = false # Display name of this page modifier. If set, it will be displayed in the footer. LastModifierDisplayName = \"\" # Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer LastModifierEmail = \"\" +++ Add icon to a menu entry In the page frontmatter, add a pre param to insert any HTML code before the menu label. The example below uses the GitHub icon.\n+++ title = \"GitHub repo\" pre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering sibling menu/page entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ title = \"My page\" weight = 5 +++ Using a custom title for menu entries By default, the Relearn theme will use a page’s title attribute for the menu item (or linkTitle if defined).\nBut a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the menuTitle parameter for that purpose:\nFor example (for a page named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++ Override expand state rules for menu entries You can change how the theme expands menu entries on the side of the content with the alwaysopen setting on a per page basis. If alwaysopen=false for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.\nThe theme generates the menu based on the following rules:\n all parent entries of the active page including their siblings are shown regardless of any settings immediate children entries of the active page are shown regardless of any settings if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursivley all remaining entries are not shown You can see this feature in action on the example page for children shortcode and its children pages.\nYour Page To configure your page, you basically have three choices:\n Create an _index.md document in content folder and fill the file with Markdown content Create an index.html file in the static folder and fill the file with HTML content Configure your server to automatically redirect home page to one your documentation page ","description":"","tags":null,"title":"Pages organization","uri":"/cont/pages/"},{"content":"Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes.\nIt is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.\nChapter To create a Chapter page, run the following commands\nhugo new --kind chapter \u003cname\u003e/_index.md It will create a page with 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 To create a default page, run either one of the following commands either\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md It will create a page with predefined Front-Matter:\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ Lorem Ipsum. ","description":"","tags":null,"title":"Archetypes","uri":"/cont/archetypes/"},{"content":"This is a demo child page.\nSubpages of this page page 1-1 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1","uri":"/shortcodes/children/children-1/"},{"content":"Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.\nJust download latest version of Hugo binary for your OS (Windows, Linux, Mac) : it’s that simple.\n","description":"","tags":null,"title":"Requirements","uri":"/basics/requirements/"},{"content":"The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e Install the theme Install the Relearn theme by following this documentation\nThis theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, you can download the theme as .zip file and extract it in the themes directory\nBasic configuration When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (config.toml) and set the theme as the default. You can also add the [outputs] section to enable the search functionality.\n# Change the default theme to be use when building the site with Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Create your first chapter page Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.\n### Chapter 1 # Basics Discover what this Hugo theme is all about and the core concepts behind it. renders as\nThe Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command\nhugo new --kind chapter basics/_index.md By opening the given file, you should see the property chapter=true on top, meaning this page is a chapter.\nBy default all chapters and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata.\nCreate your first content pages Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nLaunching the website locally Launch by using the following command:\nhugo serve Go to http://localhost:1313\nYou should notice three things:\n You have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files. The home page explains how to customize it by following the instructions. When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes. Neat! Build the website When your site is ready to deploy, run the following command:\nhugo A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.\nNoteThis website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages\n ","description":"","tags":null,"title":"Installation","uri":"/basics/installation/"},{"content":"Let’s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.\nMarkdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.\nSome of the key benefits are:\n Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown. Produces valid XHTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this:\n The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. John Gruber\n Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nInfo Bookmark this page and the official Commonmark reference for easy future reference!\n Headings Headings from h1 through h6 are constructed with a # for each level:\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Renders to:\nh1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading 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 compatible\n\u003c!-- This is a comment --\u003e Comment below should NOT be seen:\nHorizontal Rules The HTML \u003chr\u003e element is for creating a “thematic break” between paragraph-level elements. In Markdown, you can create a \u003chr\u003e with --- - three consecutive dashes\nrenders to:\n Paragraphs Any text not starting with a special sign is written as normal, plain text and will be wrapped within \u003cp\u003e\u003c/p\u003e tags in the 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 to 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 emphasizing a snippet of text with a heavier font-weight.\nThe following snippet of text is rendered as bold text.\n**rendered as bold text** renders to:\nrendered as bold text\nand this HTML\n\u003cstrong\u003erendered as bold text\u003c/strong\u003e Italics For emphasizing a snippet of text with italics.\nThe following snippet of text is rendered as italicized text.\n_rendered as italicized text_ renders to:\nrendered as italicized text\nand this HTML:\n\u003cem\u003erendered as italicized text\u003c/em\u003e Strikethrough In GFM (GitHub flavored Markdown) you can do strikethroughs.\n~~Strike through this text.~~ Which renders to:\nStrike through this text.\nHTML:\n\u003cdel\u003eStrike through this text.\u003c/del\u003e Blockquotes For quoting blocks of content from another source within your document.\nAdd \u003e before any text you want to quote.\n\u003e **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. Renders to:\n Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.\n and this HTML:\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eFusion Drive\u003c/strong\u003e combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.\u003c/p\u003e \u003c/blockquote\u003e Blockquotes can also be nested:\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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 to:\n Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\n Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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 of items in which the order of the items does not explicitly matter.\nYou may use any of the following symbols to denote bullets for each list item:\n* valid bullet - valid bullet + valid bullet For example\n+ Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in 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 And this HTML\n\u003cul\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipiscing elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis in 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 of items in which the order of items does explicitly matter.\n1. Lorem ipsum dolor sit amet 4. Consectetur adipiscing elit 2. Integer molestie lorem at massa 8. Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem And this HTML:\n\u003col\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipiscing elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis in 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 TipIf you just use 1. for each number, Markdown will automatically number each item. For example:\n 1. Lorem ipsum dolor sit amet 1. Consectetur adipiscing elit 1. Integer molestie lorem at massa 1. Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in 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 of code with `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` should be wrapped as **code**. Renders to:\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 of code by at least two spaces, as in:\n// Some comments line 1 of code line 2 of code line 3 of code Renders to:\n// Some comments line 1 of code line 2 of code line 3 of code HTML:\n\u003cpre\u003e \u003ccode\u003e // Some comments line 1 of code line 2 of code line 3 of code \u003c/code\u003e \u003c/pre\u003e Block code “fences” Use “fences” ``` to block in multiple lines of code.\n``` Sample text here... ``` HTML:\n\u003cpre\u003e \u003ccode\u003eSample text here...\u003c/code\u003e \u003c/pre\u003e Syntax highlighting GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code “fence”, ```js, and syntax highlighting will automatically be applied in the rendered HTML.\nSee Code Highlighting for additional documentation.\nFor example, to apply syntax highlighting to JavaScript code:\n```js grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Renders to:\ngrunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.\n| Option | Description | | ------ | ----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Renders to:\n Option Description data path to data files to supply the data that will be passed into templates. engine engine to be used for processing templates. Handlebars is the default. ext extension to be used for dest files. And this HTML:\n\u003ctable\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 to data files to supply the data that will be passed into templates.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eengine\u003c/td\u003e \u003ctd\u003eengine to be used for processing templates. Handlebars is the default.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eext\u003c/td\u003e \u003ctd\u003eextension to be used for dest files.\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e Right aligned text Adding a colon on the right side of the dashes below any heading will right align text for that column.\n| Option | Description | | ------:| -----------:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Option Description data path to data files to supply the data that will be passed into templates. engine engine to be used for processing templates. Handlebars is the default. ext extension to be used for dest files. Two tables adjacent Option Description ext extension to be used for dest files. Option Description ext extension to be used for dest files. Links Basic link [Assemble](http://assemble.io) Renders to (hover over the link, there is 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 to (hover over the 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 enable you to jump to the specified anchor point on the same page. For example, each of these chapters:\n# Table of Contents * [Chapter 1](#chapter-1) * [Chapter 2](#chapter-2) * [Chapter 3](#chapter-3) will jump to these sections:\n## Chapter 1 \u003ca id=\"chapter-1\"\u003e\u003c/a\u003e Content for chapter one. ## Chapter 2 \u003ca id=\"chapter-2\"\u003e\u003c/a\u003e Content for chapter one. ## Chapter 3 \u003ca id=\"chapter-3\"\u003e\u003c/a\u003e Content for chapter one. NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.\nImages Images have a similar syntax to links but include a preceding exclamation point.\n![Minion](https://octodex.github.com/images/minion.png) or\n![Alt text](https://octodex.github.com/images/stormtroopocat.jpg \"The Stormtroopocat\") Like links, Images also have a footnote style syntax\nAlternative usage : note images ![Alt text][id] With a reference later in the document defining the URL location:\n[id]: https://octodex.github.com/images/dojocat.jpg \"The Dojocat\" Further image formatting The Hugo Markdown parser supports additional non-standard functionality.\nResizing image Add HTTP parameters width and/or height to the link image to resize the image. Values are CSS values (default is auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20pc) ![Minion](https://octodex.github.com/images/minion.png?height=50px) ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=300px) Add CSS classes Add a HTTP classes parameter to the link image to add CSS classes. shadowand border are available but you could define other ones.\n![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) Lightbox Add a HTTP featherlight parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining featherlight to false.\n![Minion](https://octodex.github.com/images/minion.png?featherlight=false) ","description":"","tags":null,"title":"Markdown syntax","uri":"/cont/markdown/"},{"content":"The Relearn theme uses Hugo’s built-in syntax highlighting for code.\nMarkdown syntax Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders to:\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Hugo comes with a remarkable list of supported languages.\nRecommended configuration You can choose a color theme from the list of supported themes and add it in your config.toml\n[markup] [markup.highlight] style = \"base16-snazzy\" # choose a color theme or create your own guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore ","description":"","tags":null,"title":"Code highlighting","uri":"/cont/syntaxhighlight/"},{"content":"Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) in the # menu; if no setting is given, the first menu level is set to false, all others to true; # this can be overridden in the pages frontmatter alwaysopen = true # Prefix URL to edit current page. Will display an \"Edit this page\" button on top right hand corner of every page. # Useful to give opportunity to people to create merge request for your doc. # See the config.toml file from this documentation site to have an example. editURL = \"\" # Author of the site, will be used in meta information author = \"\" # Description of the site, will be used in meta information description = \"\" # Shows a checkmark for visited pages on the menu showVisitedLinks = false # Disable search function. It will hide search bar disableSearch = false # Disable search in hidden pages, otherwise they will be shown in search box disableSearchHiddenPages = false # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden disableTagHiddenPages = false # Javascript and CSS cache are automatically busted when new version of site is generated. # Set this to true to disable this behavior (some proxies don't handle well this optimization) disableAssetsBusting = false # Set this to true to disable copy-to-clipboard button for inline code. disableInlineCopyToClipBoard = false # A title for shortcuts in menu is set by default. Set this to true to disable it. disableShortcutsTitle = false # If set to false, a Home button will appear below the search bar on the menu. # It is redirecting to the landing page of the current language if specified. (Default is \"/\") disableLandingPageButton = true # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs in the header and only show the current page title disableBreadcrumb = true # If set to true, hide table of contents menu in the header of all pages disableToc = false # If set to true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic) disableMermaid = false # Specifies the remote location of the Mermaid js customMermaidURL = \"https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js\" # Initialization parameter for Mermaid, see Mermaid documentation mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # Hide Next and Previous page buttons normally displayed full height beside content disableNextPrev = true # Order sections in menu by \"weight\" or \"title\". Default to \"weight\"; # this can be overridden in the pages frontmatter ordersectionsby = \"weight\" # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\". themeVariant = \"\" # Provide a list of custom css files to load relative from the `static/` folder in the site root. custom_css = [\"css/foo.css\", \"css/bar.css\"] # Change the title separator. Default to \"::\". titleSeparator = \"-\" A word on running your site in a subfolder The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nActivate search If not already present, add the follow lines in the same config.toml file.\n[outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.\n Hugo generate lunrjs index.json at the root of public folder. When you build the site with hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem\n Mermaid The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.\n Example:\nMermaid is globally disabled. By default it won’t be loaded by any page. On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).\n You also can disable Mermaid for specific pages while globally enabled.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the 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 are not configured for a specific language, they will get their default values:\nlandingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" The home button is going to look like this:\n","description":"","tags":null,"title":"Configuration","uri":"/basics/configuration/"},{"content":"This is a demo child page with no description.\nSo its content is used as description.\n","description":"","tags":["children","non-hidden"],"title":"page 2","uri":"/shortcodes/children/children-2/"},{"content":"The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\n content: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content. header: the header of the content page (contains the breadcrumbs). Not meant to be overwritten custom-header: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file footer: the footer of the content page (contains the arrows). Not meant to be overwritten custom-footer: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file favicon: the favicon logo: the logo, on top left hand corner. meta: HTML meta tags, if you want to change default behavior menu: left menu. Not meant to be overwritten menu-pre: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account. menu-post: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account. menu-footer: footer of the the left menu search: search box toc: table of contents Change the logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNoteThe size of the logo will adapt automatically\n Change the favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change default colors The Relearn theme let you choose between some predefined color scheme variants, but feel free to add one yourself!\nStandard variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"\" Red variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"red\" Blue variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"blue\" Green variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"green\" ‘Mine‘ variant First, create a new CSS file in your local static/css folder prefixed by theme (e.g. with mine theme static/css/theme-mine.css). Copy the following content and modify colors in CSS variables.\n:root { --MAIN-TEXT-color: #323232; /* Color of text by default */ --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */ --MAIN-LINK-color: #1C90F3; /* Color of links */ --MAIN-LINK-HOVER-color: #167ad0; /* Color of hovered links */ --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ --MAIN-CODE-color: #e2e4e5; /* fallback color for code background */ --MAIN-CODE-BG-color: #282a36; /* fallback color for code text */ --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */ --MENU-HEADER-BG-color: #1C90F3; /* Background color of menu header */ --MENU-HEADER-BORDER-color: #33a1ff; /*Color of 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 icons color */ --MENU-SECTIONS-ACTIVE-BG-color: #20272b; /* Background color of the active section and its children */ --MENU-SECTIONS-BG-color: #252c31; /* Background color of other sections */ --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ --MENU-SECTION-HR-color: #20272b; /* Color of \u003chr\u003e separator in menu */ } Then, set the themeVariant value with the name of your custom theme file. That’s it!\n[params] # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\". themeVariant = \"mine\" ","description":"","tags":null,"title":"Customization","uri":"/basics/customization/"},{"content":"You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the 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 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 are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n[Shortcuts-Title] other = \"\u003cYour value\u003e\" Read more about hugo menu and hugo i18n translation strings\nConfiguration for Multilingual mode When using a multilingual website, you can set different menus for each language. In the config.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the 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 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 and hugo multilingual menus\n","description":"","tags":null,"title":"Menu extra shortcuts","uri":"/cont/menushortcuts/"},{"content":"The Relearn theme for Hugo loads the Font Awesome library, allowing you to easily display any icon or logo available in the Font Awesome free collection.\nFinding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the HTML reference and paste into the Markdown content.\nThe HTML to include the heart icon is:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Including in markdown Paste the \u003ci\u003e HTML into markup and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and Hugo Which appears as\nBuilt with by Relearn and Hugo\nCustomising icons Font Awesome provides many ways to modify the icon\n Change colour (by default the icon will inherit the parent colour) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\n","description":"","tags":null,"title":"Icons and logos","uri":"/cont/icons/"},{"content":"Changelog 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance for collecting of meta info #157 2.9.0 (2021-11-19) Fixes [bug][breaking] relref: fix inconsistent behaviour #156 [bug] search: make dropdown stick to search field when scrolling #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add missing right border for inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibling pages reliably #152 [bug] menu: bring active item in sight for large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset to initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always load javascript to avoid break if code fences are used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS in multilang setup if search is disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally available via config.toml #133 [feature] mermaid: only load javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configurable #2 Fixes [bug] mermaid: assert that window.mermaid is actually mermaid #136 [bug] menu: remove usage of Hugos UniqueID #131 [bug] theme: reduce margin for children shortcode #130 [bug] theme: left-align h3 in chapters #129 [bug] theme: align copy link to 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 for malicioius image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] syntax highlight: provide default colors for unknown languages #113 Fixes [bug] security: fix XSS for 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 translation #109 [feature][change] theme: simplify stylesheet for color variants #107 [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative content in header #101 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: add default setting for 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 is used #105 [bug] theme: fix sticky header to remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translation #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translation to avoid crash on rendering #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage of 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 pages from sitemap and SEO indexing #85 Fixes [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary to 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: disable search in hidden pages #76 [feature] search: improve readablility of index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site content #81 [bug] menu: always hide hidden sub pages #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styling #65 [feature] theme: improve readability #64 [feature] menu: show hidden pages if accessed directly #60 [feature][change] theme: treat pages without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates for pre/post menu entries #56 [feature] theme: make chapter archetype more readable #55 [feature] children: add parameter for container style #53 [feature] theme: make content a template #50 [feature] menu: control menu expansion with alwaysopen parameter #49 [feature] include: new shortcode to include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highligher: switch to standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sorting ignores ordersectionsby #63 [bug][change] children: default sorting ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61 [bug] theme: remove superflous singular taxonomy from taxonomy title #46 [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog in exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare for new hugo theme registration #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose options in config.toml #4 Fixes [bug] mermaid: config option for CDN url not used #12 [bug] mermaid: only highlight text in HTML elements #10 [bug] mermaid: support pan \u0026 zoom for graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on load may bomb chart #5 Maintenance [task] mermaid: update to 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare for hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ","description":"","tags":null,"title":"History","uri":"/basics/history/"},{"content":"The Relearn theme is fully compatible with Hugo multilingual mode.\nIt provides:\n Translation strings for default values (English, Arabic, Dutch, Piratized English, German, Hindi, Indonesian, Japanese, Piratized English, Portuguese, Russian, Simplified Chinese, Spanish, Turkish). Feel free to contribute! Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config.toml file.\nFor example with current English and Piratized English website.\n# English is the 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, for each new page, append the id of the language to the file.\n Single file my-page.md is split in two files: in English: my-page.md in Piratized English: my-page.pir.md Single file _index.md is split in two files: in English: _index.md in Piratized English: _index.pir.md InfoBe aware that only translated pages are displayed in menu. It’s not replaced with default language content.\n TipUse slug Front Matter parameter to translate urls too.\n Overwrite translation strings Translations strings are used for common default values used in the theme (Edit this page button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.\nTo override these values, create a new file in your local i18n folder i18n/\u003cidlanguage\u003e.toml and inspire yourself from the theme themes/hugo-theme-relearn/i18n/en.toml\nDisable language switching Switching the language in the browser is a great feature, but for some reasons you may want to disable it.\nJust set disableLanguageSwitchingButton=true in your config.toml\n[params] # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = true ","description":"","tags":null,"title":"Multilingual and i18n","uri":"/cont/i18n/"},{"content":"This is a demo child page.\nSubpages of this page page 3-1 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 3","uri":"/shortcodes/children/children-3/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\n","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 4 (hidden)","uri":"/shortcodes/children/children-4/"},{"content":"The Relearn theme supports one default taxonomy of Hugo: the tag feature.\nConfiguration Just add tags to any page:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior The tags are displayed at the top of the page, in their insertion order.\nEach tag is a link to a Taxonomy page displaying all the articles with the given tag.\nList all the tags In the config.toml file you can add a shortcut to display all the tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ","description":"","tags":["documentation","tutorial"],"title":"Tags","uri":"/cont/tags/"},{"content":"","description":"","tags":null,"title":"1","uri":"/yours/1/"},{"content":"","description":"","tags":null,"title":"10","uri":"/yours/10/"},{"content":"","description":"","tags":null,"title":"11","uri":"/yours/11.de/"},{"content":"","description":"","tags":null,"title":"12","uri":"/yours/12.de/"},{"content":"","description":"","tags":null,"title":"13","uri":"/yours/13.de/"},{"content":"","description":"","tags":null,"title":"14","uri":"/yours/14.de/"},{"content":"","description":"","tags":null,"title":"15","uri":"/yours/15.de/"},{"content":"","description":"","tags":null,"title":"16","uri":"/yours/16.de/"},{"content":"","description":"","tags":null,"title":"17","uri":"/yours/17.de/"},{"content":"","description":"","tags":null,"title":"18","uri":"/yours/18.de/"},{"content":"","description":"","tags":null,"title":"19","uri":"/yours/19.de/"},{"content":"","description":"","tags":null,"title":"2","uri":"/yours/2/"},{"content":"","description":"","tags":null,"title":"20","uri":"/yours/20.de/"},{"content":"","description":"","tags":null,"title":"21","uri":"/yours/21.de/"},{"content":"","description":"","tags":null,"title":"22","uri":"/yours/22.de/"},{"content":"","description":"","tags":null,"title":"23","uri":"/yours/23.de/"},{"content":"","description":"","tags":null,"title":"24","uri":"/yours/24.de/"},{"content":"","description":"","tags":null,"title":"25","uri":"/yours/25.de/"},{"content":"","description":"","tags":null,"title":"26","uri":"/yours/26.de/"},{"content":"","description":"","tags":null,"title":"27","uri":"/yours/27.de/"},{"content":"","description":"","tags":null,"title":"28","uri":"/yours/28.de/"},{"content":"","description":"","tags":null,"title":"29","uri":"/yours/29.de/"},{"content":"","description":"","tags":null,"title":"3","uri":"/yours/3/"},{"content":"","description":"","tags":null,"title":"30","uri":"/yours/30.de/"},{"content":"","description":"","tags":null,"title":"4","uri":"/yours/4/"},{"content":"","description":"","tags":null,"title":"5","uri":"/yours/5/"},{"content":"","description":"","tags":null,"title":"6","uri":"/yours/6/"},{"content":"","description":"","tags":null,"title":"7","uri":"/yours/7/"},{"content":"","description":"","tags":null,"title":"8","uri":"/yours/8/"},{"content":"","description":"","tags":null,"title":"9","uri":"/yours/9/"},{"content":"The Attachments shortcode displays a list of files attached to a page.\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 The shortcurt lists files found in a specific folder. Currently, it support two implementations for pages\n If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with .files.\n content _index.md page.files attachment.pdf page.md If your page is a folder, attachements must be placed in a nested ‘files’ folder.\n content _index.md page index.md files attachment.pdf Be aware that if you use a multilingual website, you will need to have as many folders as languages.\nThat’s all!\nParameters Parameter Default Description title “Attachments” List’s title sort “asc” Sorting the output in ascending or descending order style \"\" Choose between orange, grey, blue and green for nice style pattern “.*” A regular expressions, used to filter the attachments by file name. The pattern parameter value must be regular expressions. For example:\n To match a file suffix of ‘jpg’, use *.jpg (not *.jpg). To match file names ending in ‘jpg’ or ‘png’, use .*(jpg|png) Examples List of attachments ending in 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":"The Attachments shortcode displays a list of files attached to a page","tags":null,"title":"Attachments","uri":"/shortcodes/attachments/"},{"content":"A button is a just a clickable button with optional icon.\n{{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" %}}Get Hugo with icon{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" icon-position=\"right\" %}}Get Hugo with icon right{{% /button %}} Get Hugo Get Hugo with icon Get Hugo with icon right ","description":"Nice buttons on your page","tags":null,"title":"Button","uri":"/shortcodes/button/"},{"content":"","description":"","tags":null,"title":"Categories","uri":"/categories/"},{"content":"Use the children shortcode to list the child pages of a page and the further descendants (children’s children). By default, the shortcode displays links to the child pages.\nUsage Parameter Default Description page current Specify the page name (section name) to display children for containerstyle “ul” Choose the style used to group all children. It could be any HTML tag name style “li” Choose the style used to display each descendant. It could be any HTML tag name showhidden “false” When true, child pages hidden from the menu will be displayed description “false” Allows you to include a short text under each page in the list. When no description exists for the page, children shortcode takes the first 70 words of your content. Read more info about summaries on gohugo.io depth 1 Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. Tips: set 999 to get all descendants sort ordersectionsby Sort children by weight, to sort on menu order - title, to sort alphabetically on menu label. If not set it is sorted by the ordersectionsby setting of the site and the pages frontmatter Demo {{% children %}} page X page 1 page 2 page 3 {{% children description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\n {{% children depth=\"999\" showhidden=\"true\" %}} page X page 1 page 1-1 page 1-1-1 (hidden) page 1-1-1-1 page 1-1-1-1-1 (hidden) page 1-1-1-1-1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 page 4 (hidden) {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 1-1 This is a demo child page\npage 1-1-2 This is a demo child page\npage 1-1-3 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\npage 3-1 This is a plain page test nested in a parent\n {{% children containerstyle=\"div\" style=\"div\" depth=\"999\" %}} page X page 1 page 1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 ","description":"List the child pages of a page","tags":null,"title":"Children","uri":"/shortcodes/children/"},{"content":"","description":"","tags":null,"title":"children","uri":"/tags/children/"},{"content":"Contributors Special thanks to everyone who has contributed to this project.\nMany thanks to @matcornic for his work on the Learn theme.\nPackages and libraries Mermaid - generation of diagram and flowchart from text in a similar manner as Markdown font awesome - the iconic font and CSS framework jQuery - The Write Less, Do More, JavaScript Library jquery-svg-zoom-pan - enable pan and zoom in Mermaid graphs lunr - Lunr enables you to provide a great search experience without the need for external, server-side, search services… clipboard.js - copy text to clipboard modernizr - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don’t support Tooling gren - Releasenotes generator Hugo - Static site generator Netlify - Continuous deployement and hosting of this documentation Wercker - Continous testing ","description":"","tags":null,"title":"Credits","uri":"/credits/"},{"content":"","description":"","tags":null,"title":"documentation","uri":"/tags/documentation/"},{"content":"The Expand shortcode displays an expandable/collapsible section of text on your page.\nUsage {{% expand [ \u003cstring\u003e [ \"true\" | \"false\" ] ] %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is \"Expand me...\".\nThe second optional parameter controls if the block is initially shown as expanded (\"true\") or collapsed (\"false\"). The default ist \"false\".\nExamples I'll tell you a secret... …maybe the next time you’ll open this expander!\n All defaults Expand me... Yes, you did it!\n Show markup {{% expand %}} Yes, you did it! {{% /expand %}} Initially expanded Expand me... No need to press you!\n Show markup {{% expand \"Expand me...\" \"true\" %}} No need to press you! {{% /expand %}} Arbitrary text Show me endless possibilities Some expandable text.\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides expand etc. ...and even source code the possiblities are endless\n Show markup {{% expand \"Show me endless possibilities\" %}} Some expandable text. You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - other shortcodes besides `expand` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /expand %}} ","description":"Displays an expandable/collapsible section of text on your page","tags":null,"title":"Expand","uri":"/shortcodes/expand/"},{"content":"","description":"","tags":null,"title":"hidden","uri":"/tags/hidden/"},{"content":"The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.\nUsage {{% include \u003cstring\u003e [ \"true\" | \"false\" ] %}} The first required parameter is the path to the file to be included.\nIf the file’s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (\"true\")- which is the default - or be hidden.\nExamples Arbitray content You can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides include etc. ...and even source code the possiblities are endless\n Show markup {{% include \"shortcodes/INCLUDE_ME.md\" %}} ","description":"Displays content from other Markdown files","tags":null,"title":"Include","uri":"/shortcodes/include/"},{"content":"Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.\nUsage Just insert your Mermaid code in the mermaid shortcode like this:\n{{\u003c mermaid [ align=(\"left\"|\"right\"|\"center\"|\"justify\") ] \u003e}} classDiagram Person *-- Dog {{\u003c /mermaid \u003e}} You can set an optional align attribute which defaults to \"center\".\nIf you don’t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.highlight setting (see below):\n```mermaid classDiagram Person *-- Dog ``` The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you 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 markup {{\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 are you? loop Healthcheck John-John: Fight against hypochondria end Note right of John: Rational thoughts prevail... John--Alice: Great! John-Bob: How about you? Bob--John: Jolly good! Show markup {{\u003c mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts \u003cbr/\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about you? Bob--\u003eJohn: Jolly good! {{\u003c /mermaid \u003e}} GANTT gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d Show markup {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d {{\u003c /mermaid \u003e}} Class classDiagram Class01 C2 : Where am i? Class09 --* C3 Class09 --| Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 C2: Cool label Show markup {{\u003c mermaid \u003e}} classDiagram Class01 \u003c|-- AveryLongClass : Cool Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --\u003e C2 : Where 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 markup ```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 ``` Configuration Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your config.toml or override these settings sidewise thru your pages frontmatter.\nThis JSON object is forwarded into Mermaid’s mermaid.initialize() function.\nSee Mermaid documentation for all allowed settings.\nAlso, if you want to use mermaid codefences, you have to turn off guessSyntax for the markup.highlight setting.\nExample [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [markup] [markup.highlight] guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore or pages frontmatter\n+++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ ","description":"Generation of diagram and flowchart from text in a similar manner as Markdown","tags":null,"title":"Mermaid","uri":"/shortcodes/mermaid/"},{"content":"","description":"","tags":null,"title":"non-hidden","uri":"/tags/non-hidden/"},{"content":"The notice shortcode shows four types of disclaimers to help you structure your page.\nUsage {{% notice ( note | info | tip | warning ) [ \u003cstring\u003e ] %}} Some markup {{% /notice %}} The first parameter is required and indicates the type of notice.\nThe second parameter is optional. If provided, it will be used as the title of the notice. If not provided, then the type of notice will be used as the title. For example, the title of a warning notice will be “Warning”.\nExamples Note NoteA notice disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice note %}} A **notice** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Info InfoAn information disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice info %}} An **information** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Tip TipA tip disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice tip %}} A **tip** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Warning WarningA warning disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice warning %}} A **warning** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Notice with Custom Title You can customize the title of the notice by passing it as a second parameter.\nPay Attention to this Note!The title is now the parameter that was provided.\n Show markup {{% notice note \"Pay Attention to this Note!\" %}} The title is now the parameter that was provided. {{% /notice %}} ","description":"Disclaimers to help you structure your page","tags":null,"title":"Notice","uri":"/shortcodes/notice/"},{"content":"This is a demo child page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1 (hidden) page 1-1-2 page 1-1-3 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1","uri":"/shortcodes/children/children-1/children-1-1/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1 ","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 1-1-1 (hidden)","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/"},{"content":"This is a non-hidden demo child page of a hidden parent page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1-1-1 (hidden) ","description":"This is a non-hidden demo child page of a hidden parent page","tags":["children","hidden"],"title":"page 1-1-1-1","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1-1-1 ","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 1-1-1-1-1 (hidden)","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/"},{"content":"This is a non-hidden demo child page of a hidden parent page.\n","description":"This is a non-hidden demo child page of a hidden parent page","tags":["children","hidden"],"title":"page 1-1-1-1-1-1","uri":"/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 is a plain demo child page.\nSubpages of this page page 1-1-2-1 page 1-1-2-2 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2-1","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2-2","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-3","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-3/"},{"content":"This is a plain demo child page.\n","description":"This is a plain page test nested in a parent","tags":["children","non-hidden"],"title":"page 3-1","uri":"/shortcodes/children/children-3/test3/"},{"content":"Hugo Relearn Theme The Relearn theme is a theme for Hugo, a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.\nInfoThe theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.\n Main features TipSee what’s new within the latest update.\n Automatic Search Multilingual mode Unlimited menu levels Automatic next/prev buttons to navigate through menu entries Image resizing, shadow… Attachments files List child pages Mermaid diagram (flowchart, sequence, gantt) Customizable look and feel and theme variants Buttons Tip/Note/Info/Warning boxes Expand Tabs File inclusion Getting support To get support, feel free to open a new discussion topic or issue in the official repository on GitHub.\nBecome a contributor Feel free to update this documentation by just clicking the Edit this page link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.\nYou are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the official repository via GitHub. Please visit the contribution guidelines first.\nLicense This theme is licensed under the MIT License.\nCredits This theme would not be possible without the work of many others. See the credits for a detailed list.\n","description":"","tags":null,"title":"Relearn Theme for Hugo","uri":"/"},{"content":"BITS by Dr. Lutz Gollan ","description":"","tags":null,"title":"Showcase","uri":"/showcase/"},{"content":"The siteparam shortcode is used to help you print values of site params.\nUsage {{% siteparam \u003cstring\u003e %}} The first required parameter is the name of the site param to be displayed.\nExamples For instance, in this current site, the editURL variable is used in config.toml\n[params] editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" Use the siteparam shortcode to display its value.\n`editURL` Value : {{% siteparam \"editURL\" %}} is displayed as\neditURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n","description":"Get value of site params variables in your page","tags":null,"title":"Site param","uri":"/shortcodes/siteparam/"},{"content":"Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in 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 with the same tabs that belong to the same group sychronize their selection:\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 WarningWhen using tab views with different content sets, make sure to use a common groupId for equal sets but distinct groupId for different sets. The groupId defaults to 'default'. Take this into account across the whole site! The tab selection is restored automatically based on the groupId and if it cannot find a tab item because it came from the 'default' group on a different page then all tabs will be empty at first.\n ","description":"Synchronize selection of content in different tabbed views","tags":null,"title":"Tabbed views","uri":"/shortcodes/tabs/"},{"content":"","description":"","tags":null,"title":"Tags","uri":"/tags/"},{"content":"Placeholder…\n","description":"","tags":null,"title":"The one and only hidden child","uri":"/yours/children-1/"},{"content":"","description":"","tags":null,"title":"tutorial","uri":"/tags/tutorial/"}] \ No newline at end of file +[{"content":"Chapter 1 Basics Discover what this Hugo theme is all about and the core-concepts behind it.\n","description":"","tags":null,"title":"Basics","uri":"/basics/"},{"content":"This is a plain demo child page.\n","description":"This is a plain page test, and the beginning of a YAML multiline description...\n","tags":null,"title":"page X","uri":"/shortcodes/children/test/"},{"content":"Chapter 2 Content Find out how to create and organize your content quickly and intuitively.\n","description":"","tags":null,"title":"Content","uri":"/cont/"},{"content":"This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.\nBreaking: A change that requires action by you after upgrading to assure the site is still functional.\nChange: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.\nNew: Marks new behavior you might find interesting or comes configurable.\n 2.9.0 Breaking: This release removes the themes implementation of ref/relref in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.\nIn a standard complient form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\n Type Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configuration Leaf bundle basics/configuration/index.md basics/configuration Page basics/configuration.md basics/configuration If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the 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\": page not found In this case, you must apply one of two options:\n Copy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.\n Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all *.md files. This is the recommended choice.\n Type Search Replace by Branch bundle (ref\\s+\"[^\"]*)/_index\\.md\" $1\" Leaf bundle (ref\\s+\"[^\"]*)/index\\.md\" $1\" Page (ref\\s+\"[^\"]*)\\.md\" $1\" 2.8.0 Change: Although never officially documented, this release removes the font Novacento/Novecento from the release. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.\n New: The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\n New: You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.\n 2.7.0 New: Optional second parameter for notice shortcode to set title in box header. 2.6.0 New: Your site can now be served from a subfolder if you set baseURL and canonifyURLs=true in your config.toml. See the documentation for a detailed example. 2.5.0 Change: Add new colors --MAIN-CODE-color and --MAIN-CODE-BG-color for syntax highlightning fallback in your stylesheet in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style. 2.4.0 Change: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The documentation was adjusted accordingly.\n New: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.\n New: You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\n New: New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\n New: Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n 2.2.0 New: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your config.toml. 2.1.0 Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in exampleSite), they will now be ignored by the search.\n New: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.\n New: If a search term is found in an expand shortcode, the expand will be opened.\n New: The menu will scroll the active item into view on load.\n 2.0.0 Change: Syntaxhighlightning was switched to built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as describedd on in the Hugo documentation\n Change: In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color.\n Change: --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets.\n Change: Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\n Change: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\n Change: A page without a title will be treated as hidden=true.\n New: You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\n New: New partials for defining pre/post content for menu items and the content. See documentation for further reading.\n New: Shortcode children with new parameter containerstyle.\n New: New shortcode include to include arbitrary file content into a page.\n 1.2.0 New: Shortcode expand with new parameter to open on page load. 1.1.0 New: Mermaid config options can be set in config.toml. ","description":"","tags":null,"title":"What's new","uri":"/basics/migration/"},{"content":"Chapter 3 Shortcodes Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.\nBut this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.\nTo avoid this limitations, Hugo created shortcodes. A shortcode is a simple snippet inside a page.\nThe Relearn theme provides multiple shortcodes on top of existing ones.\nAttachments The Attachments shortcode displays a list of files attached to a page\nButton Nice buttons on your page\nChildren List the child pages of a page\nExpand Displays an expandable/collapsible section of text on your page\nInclude Displays content from other Markdown files\nMermaid Generation of diagram and flowchart from text in a similar manner as Markdown\nNotice Disclaimers to help you structure your page\nSite param Get value of site params variables in your page\nTabbed views Synchronize selection of content in different tabbed views\n ","description":"","tags":null,"title":"Shortcodes","uri":"/shortcodes/"},{"content":"Chapter 4 This could be yours Start your success story. Now!\n","description":"","tags":null,"title":"This could be yours","uri":"/yours/"},{"content":"In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.\nFolders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.\ncontent ├── 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 Note_index.md is required in each folder, it’s your “folder home page”\n Types The Relearn theme defines two types of pages. Default and Chapter. Both can be used at any level of the documentation, the only difference being layout display.\nA Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it. You can define any HTML as prefix for the menu. In the example below, it’s just a number but that could be an icon.\n+++ chapter = true pre = \"\u003cb\u003e1. \u003c/b\u003e\" title = \"Basics\" weight = 5 +++ ### Chapter 1 # Basics Discover what this Hugo theme is all about and the core-concepts behind it. To tell the Relearn theme to consider a page as a chapter, set chapter=true in the Front Matter of the page.\nA Default page is any other content page.\n+++ title = \"Installation\" weight = 15 +++ The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e The Relearn theme provides archetypes to help you create this kind of pages.\nFront Matter configuration Each Hugo page has to define a Front Matter in toml, yaml or json. This site will use toml in all cases.\nThe Relearn theme uses the following parameters on top of Hugo ones :\n+++ # Table of contents (toc) is enabled by default. Set this parameter to true to disable it. # Note: Toc is always disabled for chapter pages disableToc = false # If set, this will be used for the page's menu entry (instead of the `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules for the expand state of a page's menu entry alwaysopen = true # If set, this will explicitly override common rules for the sorting order of a page's submenu entries ordersectionsby = \"title\" # The title of the page in menu will be prefixed by this HTML content pre = \"\" # The title of the page in menu will be postfixed by this HTML content post = \"\" # Set the page as a chapter, changing the way it's displayed chapter = false # Hide a menu entry by setting this to true hidden = false # Display name of this page modifier. If set, it will be displayed in the footer. LastModifierDisplayName = \"\" # Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer LastModifierEmail = \"\" +++ Add icon to a menu entry In the page frontmatter, add a pre param to insert any HTML code before the menu label. The example below uses the GitHub icon.\n+++ title = \"GitHub repo\" pre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering sibling menu/page entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ title = \"My page\" weight = 5 +++ Using a custom title for menu entries By default, the Relearn theme will use a page’s title attribute for the menu item (or linkTitle if defined).\nBut a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the menuTitle parameter for that purpose:\nFor example (for a page named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++ Override expand state rules for menu entries You can change how the theme expands menu entries on the side of the content with the alwaysopen setting on a per page basis. If alwaysopen=false for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.\nThe theme generates the menu based on the following rules:\n all parent entries of the active page including their siblings are shown regardless of any settings immediate children entries of the active page are shown regardless of any settings if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursivley all remaining entries are not shown You can see this feature in action on the example page for children shortcode and its children pages.\nYour Page To configure your page, you basically have three choices:\n Create an _index.md document in content folder and fill the file with Markdown content Create an index.html file in the static folder and fill the file with HTML content Configure your server to automatically redirect home page to one your documentation page ","description":"","tags":null,"title":"Pages organization","uri":"/cont/pages/"},{"content":"Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes.\nIt is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.\nChapter To create a Chapter page, run the following commands\nhugo new --kind chapter \u003cname\u003e/_index.md It will create a page with 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 To create a default page, run either one of the following commands either\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md It will create a page with predefined Front-Matter:\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ Lorem Ipsum. ","description":"","tags":null,"title":"Archetypes","uri":"/cont/archetypes/"},{"content":"This is a demo child page.\nSubpages of this page page 1-1 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1","uri":"/shortcodes/children/children-1/"},{"content":"Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.\nJust download latest version of Hugo binary for your OS (Windows, Linux, Mac) : it’s that simple.\n","description":"","tags":null,"title":"Requirements","uri":"/basics/requirements/"},{"content":"The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e Install the theme Install the Relearn theme by following this documentation\nThis theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, you can download the theme as .zip file and extract it in the themes directory\nBasic configuration When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (config.toml) and set the theme as the default. You can also add the [outputs] section to enable the search functionality.\n# Change the default theme to be use when building the site with Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Create your first chapter page Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.\n### Chapter 1 # Basics Discover what this Hugo theme is all about and the core concepts behind it. renders as\nThe Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command\nhugo new --kind chapter basics/_index.md By opening the given file, you should see the property chapter=true on top, meaning this page is a chapter.\nBy default all chapters and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata.\nCreate your first content pages Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nLaunching the website locally Launch by using the following command:\nhugo serve Go to http://localhost:1313\nYou should notice three things:\n You have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files. The home page explains how to customize it by following the instructions. When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes. Neat! Build the website When your site is ready to deploy, run the following command:\nhugo A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.\nNoteThis website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages\n ","description":"","tags":null,"title":"Installation","uri":"/basics/installation/"},{"content":"Let’s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.\nMarkdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.\nSome of the key benefits are:\n Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown. Produces valid XHTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this:\n The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. John Gruber\n Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nInfo Bookmark this page and the official Commonmark reference for easy future reference!\n Headings Headings from h1 through h6 are constructed with a # for each level:\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Renders to:\nh1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading 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 compatible\n\u003c!-- This is a comment --\u003e Comment below should NOT be seen:\nHorizontal Rules The HTML \u003chr\u003e element is for creating a “thematic break” between paragraph-level elements. In Markdown, you can create a \u003chr\u003e with --- - three consecutive dashes\nrenders to:\n Paragraphs Any text not starting with a special sign is written as normal, plain text and will be wrapped within \u003cp\u003e\u003c/p\u003e tags in the 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 to 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 emphasizing a snippet of text with a heavier font-weight.\nThe following snippet of text is rendered as bold text.\n**rendered as bold text** renders to:\nrendered as bold text\nand this HTML\n\u003cstrong\u003erendered as bold text\u003c/strong\u003e Italics For emphasizing a snippet of text with italics.\nThe following snippet of text is rendered as italicized text.\n_rendered as italicized text_ renders to:\nrendered as italicized text\nand this HTML:\n\u003cem\u003erendered as italicized text\u003c/em\u003e Strikethrough In GFM (GitHub flavored Markdown) you can do strikethroughs.\n~~Strike through this text.~~ Which renders to:\nStrike through this text.\nHTML:\n\u003cdel\u003eStrike through this text.\u003c/del\u003e Blockquotes For quoting blocks of content from another source within your document.\nAdd \u003e before any text you want to quote.\n\u003e **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. Renders to:\n Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.\n and this HTML:\n\u003cblockquote\u003e \u003cp\u003e\u003cstrong\u003eFusion Drive\u003c/strong\u003e combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.\u003c/p\u003e \u003c/blockquote\u003e Blockquotes can also be nested:\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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 to:\n Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\n Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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 of items in which the order of the items does not explicitly matter.\nYou may use any of the following symbols to denote bullets for each list item:\n* valid bullet - valid bullet + valid bullet For example\n+ Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in 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 And this HTML\n\u003cul\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipiscing elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis in 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 of items in which the order of items does explicitly matter.\n1. Lorem ipsum dolor sit amet 4. Consectetur adipiscing elit 2. Integer molestie lorem at massa 8. Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem And this HTML:\n\u003col\u003e \u003cli\u003eLorem ipsum dolor sit amet\u003c/li\u003e \u003cli\u003eConsectetur adipiscing elit\u003c/li\u003e \u003cli\u003eInteger molestie lorem at massa\u003c/li\u003e \u003cli\u003eFacilisis in 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 TipIf you just use 1. for each number, Markdown will automatically number each item. For example:\n 1. Lorem ipsum dolor sit amet 1. Consectetur adipiscing elit 1. Integer molestie lorem at massa 1. Facilisis in 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 to:\n Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in 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 of code with `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` should be wrapped as **code**. Renders to:\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 of code by at least two spaces, as in:\n// Some comments line 1 of code line 2 of code line 3 of code Renders to:\n// Some comments line 1 of code line 2 of code line 3 of code HTML:\n\u003cpre\u003e \u003ccode\u003e // Some comments line 1 of code line 2 of code line 3 of code \u003c/code\u003e \u003c/pre\u003e Block code “fences” Use “fences” ``` to block in multiple lines of code.\n``` Sample text here... ``` HTML:\n\u003cpre\u003e \u003ccode\u003eSample text here...\u003c/code\u003e \u003c/pre\u003e Syntax highlighting GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code “fence”, ```js, and syntax highlighting will automatically be applied in the rendered HTML.\nSee Code Highlighting for additional documentation.\nFor example, to apply syntax highlighting to JavaScript code:\n```js grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Renders to:\ngrunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.\n| Option | Description | | ------ | ----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Renders to:\n Option Description data path to data files to supply the data that will be passed into templates. engine engine to be used for processing templates. Handlebars is the default. ext extension to be used for dest files. And this HTML:\n\u003ctable\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 to data files to supply the data that will be passed into templates.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eengine\u003c/td\u003e \u003ctd\u003eengine to be used for processing templates. Handlebars is the default.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eext\u003c/td\u003e \u003ctd\u003eextension to be used for dest files.\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e Right aligned text Adding a colon on the right side of the dashes below any heading will right align text for that column.\n| Option | Description | | ------:| -----------:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Option Description data path to data files to supply the data that will be passed into templates. engine engine to be used for processing templates. Handlebars is the default. ext extension to be used for dest files. Two tables adjacent Option Description ext extension to be used for dest files. Option Description ext extension to be used for dest files. Links Basic link [Assemble](http://assemble.io) Renders to (hover over the link, there is 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 to (hover over the 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 enable you to jump to the specified anchor point on the same page. For example, each of these chapters:\n# Table of Contents * [Chapter 1](#chapter-1) * [Chapter 2](#chapter-2) * [Chapter 3](#chapter-3) will jump to these sections:\n## Chapter 1 \u003ca id=\"chapter-1\"\u003e\u003c/a\u003e Content for chapter one. ## Chapter 2 \u003ca id=\"chapter-2\"\u003e\u003c/a\u003e Content for chapter one. ## Chapter 3 \u003ca id=\"chapter-3\"\u003e\u003c/a\u003e Content for chapter one. NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.\nImages Images have a similar syntax to links but include a preceding exclamation point.\n![Minion](https://octodex.github.com/images/minion.png) or\n![Alt text](https://octodex.github.com/images/stormtroopocat.jpg \"The Stormtroopocat\") Like links, Images also have a footnote style syntax\nAlternative usage : note images ![Alt text][id] With a reference later in the document defining the URL location:\n[id]: https://octodex.github.com/images/dojocat.jpg \"The Dojocat\" Further image formatting The Hugo Markdown parser supports additional non-standard functionality.\nResizing image Add HTTP parameters width and/or height to the link image to resize the image. Values are CSS values (default is auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20pc) ![Minion](https://octodex.github.com/images/minion.png?height=50px) ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=300px) Add CSS classes Add a HTTP classes parameter to the link image to add CSS classes. shadowand border are available but you could define other ones.\n![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) Lightbox Add a HTTP featherlight parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining featherlight to false.\n![Minion](https://octodex.github.com/images/minion.png?featherlight=false) ","description":"","tags":null,"title":"Markdown syntax","uri":"/cont/markdown/"},{"content":"The Relearn theme uses Hugo’s built-in syntax highlighting for code.\nMarkdown syntax Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders to:\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Hugo comes with a remarkable list of supported languages.\nRecommended configuration You can choose a color theme from the list of supported themes and add it in your config.toml\n[markup] [markup.highlight] style = \"base16-snazzy\" # choose a color theme or create your own guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore ","description":"","tags":null,"title":"Code highlighting","uri":"/cont/syntaxhighlight/"},{"content":"Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) in the # menu; if no setting is given, the first menu level is set to false, all others to true; # this can be overridden in the pages frontmatter alwaysopen = true # Prefix URL to edit current page. Will display an \"Edit this page\" button on top right hand corner of every page. # Useful to give opportunity to people to create merge request for your doc. # See the config.toml file from this documentation site to have an example. editURL = \"\" # Author of the site, will be used in meta information author = \"\" # Description of the site, will be used in meta information description = \"\" # Shows a checkmark for visited pages on the menu showVisitedLinks = false # Disable search function. It will hide search bar disableSearch = false # Disable search in hidden pages, otherwise they will be shown in search box disableSearchHiddenPages = false # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden disableTagHiddenPages = false # Javascript and CSS cache are automatically busted when new version of site is generated. # Set this to true to disable this behavior (some proxies don't handle well this optimization) disableAssetsBusting = false # Set this to true to disable copy-to-clipboard button for inline code. disableInlineCopyToClipBoard = false # A title for shortcuts in menu is set by default. Set this to true to disable it. disableShortcutsTitle = false # If set to false, a Home button will appear below the search bar on the menu. # It is redirecting to the landing page of the current language if specified. (Default is \"/\") disableLandingPageButton = true # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs in the header and only show the current page title disableBreadcrumb = true # If set to true, hide table of contents menu in the header of all pages disableToc = false # If set to true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic) disableMermaid = false # Specifies the remote location of the Mermaid js customMermaidURL = \"https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js\" # Initialization parameter for Mermaid, see Mermaid documentation mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # Hide Next and Previous page buttons normally displayed full height beside content disableNextPrev = true # Order sections in menu by \"weight\" or \"title\". Default to \"weight\"; # this can be overridden in the pages frontmatter ordersectionsby = \"weight\" # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\". themeVariant = \"\" # Provide a list of custom css files to load relative from the `static/` folder in the site root. custom_css = [\"css/foo.css\", \"css/bar.css\"] # Change the title separator. Default to \"::\". titleSeparator = \"-\" A word on running your site in a subfolder The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nActivate search If not already present, add the follow lines in the same config.toml file.\n[outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.\n Hugo generate lunrjs index.json at the root of public folder. When you build the site with hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem\n Mermaid The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.\n Example:\nMermaid is globally disabled. By default it won’t be loaded by any page. On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).\n You also can disable Mermaid for specific pages while globally enabled.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:\n[Languages] [Languages.en] ... landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Languages.pir] ... landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ... If those params are not configured for a specific language, they will get their default values:\nlandingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" The home button is going to look like this:\n","description":"","tags":null,"title":"Configuration","uri":"/basics/configuration/"},{"content":"This is a demo child page with no description.\nSo its content is used as description.\n","description":"","tags":["children","non-hidden"],"title":"page 2","uri":"/shortcodes/children/children-2/"},{"content":"The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\n content: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content. header: the header of the content page (contains the breadcrumbs). Not meant to be overwritten custom-header: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file footer: the footer of the content page (contains the arrows). Not meant to be overwritten custom-footer: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file favicon: the favicon logo: the logo, on top left hand corner. meta: HTML meta tags, if you want to change default behavior menu: left menu. Not meant to be overwritten menu-pre: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account. menu-post: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account. menu-footer: footer of the the left menu search: search box toc: table of contents Change the logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNoteThe size of the logo will adapt automatically\n Change the favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change default colors The Relearn theme let you choose between some predefined color scheme variants, but feel free to add one yourself!\nStandard variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"\" Red variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"red\" Blue variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"blue\" Green variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\". themeVariant = \"green\" ‘Mine‘ variant First, create a new CSS file in your local static/css folder prefixed by theme (e.g. with mine theme static/css/theme-mine.css). Copy the following content and modify colors in CSS variables.\n:root { --MAIN-TEXT-color: #323232; /* Color of text by default */ --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */ --MAIN-LINK-color: #1C90F3; /* Color of links */ --MAIN-LINK-HOVER-color: #167ad0; /* Color of hovered links */ --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */ --MAIN-CODE-color: #e2e4e5; /* fallback color for code background */ --MAIN-CODE-BG-color: #282a36; /* fallback color for code text */ --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */ --MENU-HEADER-BG-color: #1C90F3; /* Background color of menu header */ --MENU-HEADER-BORDER-color: #33a1ff; /*Color of 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 icons color */ --MENU-SECTIONS-ACTIVE-BG-color: #20272b; /* Background color of the active section and its children */ --MENU-SECTIONS-BG-color: #252c31; /* Background color of other sections */ --MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */ --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */ --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */ --MENU-SECTION-HR-color: #20272b; /* Color of \u003chr\u003e separator in menu */ } Then, set the themeVariant value with the name of your custom theme file. That’s it!\n[params] # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\". themeVariant = \"mine\" ","description":"","tags":null,"title":"Customization","uri":"/basics/customization/"},{"content":"You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the 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 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 are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n[Shortcuts-Title] other = \"\u003cYour value\u003e\" Read more about hugo menu and hugo i18n translation strings\nConfiguration for Multilingual mode When using a multilingual website, you can set different menus for each language. In the config.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the 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 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 and hugo multilingual menus\n","description":"","tags":null,"title":"Menu extra shortcuts","uri":"/cont/menushortcuts/"},{"content":"The Relearn theme for Hugo loads the Font Awesome library, allowing you to easily display any icon or logo available in the Font Awesome free collection.\nFinding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the HTML reference and paste into the Markdown content.\nThe HTML to include the heart icon is:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Including in markdown Paste the \u003ci\u003e HTML into markup and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and Hugo Which appears as\nBuilt with by Relearn and Hugo\nCustomising icons Font Awesome provides many ways to modify the icon\n Change colour (by default the icon will inherit the parent colour) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\n","description":"","tags":null,"title":"Icons and logos","uri":"/cont/icons/"},{"content":"Changelog 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance for collecting of meta info #157 2.9.0 (2021-11-19) Fixes [bug][breaking] relref: fix inconsistent behaviour #156 [bug] search: make dropdown stick to search field when scrolling #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add missing right border for inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibling pages reliably #152 [bug] menu: bring active item in sight for large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset to initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always load javascript to avoid break if code fences are used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS in multilang setup if search is disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally available via config.toml #133 [feature] mermaid: only load javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configurable #2 Fixes [bug] mermaid: assert that window.mermaid is actually mermaid #136 [bug] menu: remove usage of Hugos UniqueID #131 [bug] theme: reduce margin for children shortcode #130 [bug] theme: left-align h3 in chapters #129 [bug] theme: align copy link to 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 for malicioius image URLs #117 2.5.0 (2021-10-08) Enhancements [feature][change] syntax highlight: provide default colors for unknown languages #113 Fixes [bug] security: fix XSS for 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 translation #109 [feature][change] theme: simplify stylesheet for color variants #107 [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative content in header #101 [feature] menu: frontmatter option to change sort predicate #98 [feature] menu: add default setting for 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 is used #105 [bug] theme: fix sticky header to remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translation #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translation to avoid crash on rendering #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage of 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 pages from sitemap and SEO indexing #85 Fixes [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary to 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: disable search in hidden pages #76 [feature] search: improve readablility of index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site content #81 [bug] menu: always hide hidden sub pages #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styling #65 [feature] theme: improve readability #64 [feature] menu: show hidden pages if accessed directly #60 [feature][change] theme: treat pages without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates for pre/post menu entries #56 [feature] theme: make chapter archetype more readable #55 [feature] children: add parameter for container style #53 [feature] theme: make content a template #50 [feature] menu: control menu expansion with alwaysopen parameter #49 [feature] include: new shortcode to include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highligher: switch to standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sorting ignores ordersectionsby #63 [bug][change] children: default sorting ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61 [bug] theme: remove superflous singular taxonomy from taxonomy title #46 [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog in exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes and attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add option to open on page load #25 [feature] expand: rework styling #24 [feature] attachments: sort output #23 [feature] notice: make restyling of notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors to common standards #18 [feature] notice: use distinct icons for notice box type #17 Fixes [bug] attachments: support i18n for attachment size #21 [bug] notice: support i18n for box labels #16 [bug] notice: support multiple blocks in one box #15 Maintenance [task] dependency: upgrade jquery to 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare for new hugo theme registration #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose options in config.toml #4 Fixes [bug] mermaid: config option for CDN url not used #12 [bug] mermaid: only highlight text in HTML elements #10 [bug] mermaid: support pan \u0026 zoom for graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on load may bomb chart #5 Maintenance [task] mermaid: update to 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare for hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ","description":"","tags":null,"title":"History","uri":"/basics/history/"},{"content":"The Relearn theme is fully compatible with Hugo multilingual mode.\nIt provides:\n Translation strings for default values (English, Arabic, Dutch, Piratized English, German, Hindi, Indonesian, Japanese, Piratized English, Portuguese, Russian, Simplified Chinese, Spanish, Turkish). Feel free to contribute! Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config.toml file.\nFor example with current English and Piratized English website.\n# English is the 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, for each new page, append the id of the language to the file.\n Single file my-page.md is split in two files: in English: my-page.md in Piratized English: my-page.pir.md Single file _index.md is split in two files: in English: _index.md in Piratized English: _index.pir.md InfoBe aware that only translated pages are displayed in menu. It’s not replaced with default language content.\n TipUse slug Front Matter parameter to translate urls too.\n Overwrite translation strings Translations strings are used for common default values used in the theme (Edit this page button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.\nTo override these values, create a new file in your local i18n folder i18n/\u003cidlanguage\u003e.toml and inspire yourself from the theme themes/hugo-theme-relearn/i18n/en.toml\nDisable language switching Switching the language in the browser is a great feature, but for some reasons you may want to disable it.\nJust set disableLanguageSwitchingButton=true in your config.toml\n[params] # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = true ","description":"","tags":null,"title":"Multilingual and i18n","uri":"/cont/i18n/"},{"content":"This is a demo child page.\nSubpages of this page page 3-1 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 3","uri":"/shortcodes/children/children-3/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\n","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 4 (hidden)","uri":"/shortcodes/children/children-4/"},{"content":"The Relearn theme supports one default taxonomy of Hugo: the tag feature.\nConfiguration Just add tags to any page:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior The tags are displayed at the top of the page, in their insertion order.\nEach tag is a link to a Taxonomy page displaying all the articles with the given tag.\nList all the tags In the config.toml file you can add a shortcut to display all the tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ","description":"","tags":["documentation","tutorial"],"title":"Tags","uri":"/cont/tags/"},{"content":"","description":"","tags":null,"title":"1","uri":"/yours/1/"},{"content":"","description":"","tags":null,"title":"10","uri":"/yours/10/"},{"content":"","description":"","tags":null,"title":"11","uri":"/yours/11.de/"},{"content":"","description":"","tags":null,"title":"12","uri":"/yours/12.de/"},{"content":"","description":"","tags":null,"title":"13","uri":"/yours/13.de/"},{"content":"","description":"","tags":null,"title":"14","uri":"/yours/14.de/"},{"content":"","description":"","tags":null,"title":"15","uri":"/yours/15.de/"},{"content":"","description":"","tags":null,"title":"16","uri":"/yours/16.de/"},{"content":"","description":"","tags":null,"title":"17","uri":"/yours/17.de/"},{"content":"","description":"","tags":null,"title":"18","uri":"/yours/18.de/"},{"content":"","description":"","tags":null,"title":"19","uri":"/yours/19.de/"},{"content":"","description":"","tags":null,"title":"2","uri":"/yours/2/"},{"content":"","description":"","tags":null,"title":"20","uri":"/yours/20.de/"},{"content":"","description":"","tags":null,"title":"21","uri":"/yours/21.de/"},{"content":"","description":"","tags":null,"title":"22","uri":"/yours/22.de/"},{"content":"","description":"","tags":null,"title":"23","uri":"/yours/23.de/"},{"content":"","description":"","tags":null,"title":"24","uri":"/yours/24.de/"},{"content":"","description":"","tags":null,"title":"25","uri":"/yours/25.de/"},{"content":"","description":"","tags":null,"title":"26","uri":"/yours/26.de/"},{"content":"","description":"","tags":null,"title":"27","uri":"/yours/27.de/"},{"content":"","description":"","tags":null,"title":"28","uri":"/yours/28.de/"},{"content":"","description":"","tags":null,"title":"29","uri":"/yours/29.de/"},{"content":"","description":"","tags":null,"title":"3","uri":"/yours/3/"},{"content":"","description":"","tags":null,"title":"30","uri":"/yours/30.de/"},{"content":"","description":"","tags":null,"title":"4","uri":"/yours/4/"},{"content":"","description":"","tags":null,"title":"5","uri":"/yours/5/"},{"content":"","description":"","tags":null,"title":"6","uri":"/yours/6/"},{"content":"","description":"","tags":null,"title":"7","uri":"/yours/7/"},{"content":"","description":"","tags":null,"title":"8","uri":"/yours/8/"},{"content":"","description":"","tags":null,"title":"9","uri":"/yours/9/"},{"content":"The Attachments shortcode displays a list of files attached to a page.\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 The shortcurt lists files found in a specific folder. Currently, it support two implementations for pages\n If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with .files.\n content _index.md page.files attachment.pdf page.md If your page is a folder, attachements must be placed in a nested ‘files’ folder.\n content _index.md page index.md files attachment.pdf Be aware that if you use a multilingual website, you will need to have as many folders as languages.\nThat’s all!\nParameters Parameter Default Description title “Attachments” List’s title sort “asc” Sorting the output in ascending or descending order style \"\" Choose between orange, grey, blue and green for nice style pattern “.*” A regular expressions, used to filter the attachments by file name. The pattern parameter value must be regular expressions. For example:\n To match a file suffix of ‘jpg’, use *.jpg (not *.jpg). To match file names ending in ‘jpg’ or ‘png’, use .*(jpg|png) Examples List of attachments ending in 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":"The Attachments shortcode displays a list of files attached to a page","tags":null,"title":"Attachments","uri":"/shortcodes/attachments/"},{"content":"A button is a just a clickable button with optional icon.\n{{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" %}}Get Hugo with icon{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" icon-position=\"right\" %}}Get Hugo with icon right{{% /button %}} Get Hugo Get Hugo with icon Get Hugo with icon right ","description":"Nice buttons on your page","tags":null,"title":"Button","uri":"/shortcodes/button/"},{"content":"","description":"","tags":null,"title":"Categories","uri":"/categories/"},{"content":"Use the children shortcode to list the child pages of a page and the further descendants (children’s children). By default, the shortcode displays links to the child pages.\nUsage Parameter Default Description page current Specify the page name (section name) to display children for containerstyle “ul” Choose the style used to group all children. It could be any HTML tag name style “li” Choose the style used to display each descendant. It could be any HTML tag name showhidden “false” When true, child pages hidden from the menu will be displayed description “false” Allows you to include a short text under each page in the list. When no description exists for the page, children shortcode takes the first 70 words of your content. Read more info about summaries on gohugo.io depth 1 Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. Tips: set 999 to get all descendants sort ordersectionsby Sort children by weight, to sort on menu order - title, to sort alphabetically on menu label. If not set it is sorted by the ordersectionsby setting of the site and the pages frontmatter Demo {{% children %}} page X page 1 page 2 page 3 {{% children description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\n {{% children depth=\"999\" showhidden=\"true\" %}} page X page 1 page 1-1 page 1-1-1 (hidden) page 1-1-1-1 page 1-1-1-1-1 (hidden) page 1-1-1-1-1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 page 4 (hidden) {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 1-1 This is a demo child page\npage 1-1-2 This is a demo child page\npage 1-1-3 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\npage 3-1 This is a plain page test nested in a parent\n {{% children containerstyle=\"div\" style=\"div\" depth=\"999\" %}} page X page 1 page 1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 ","description":"List the child pages of a page","tags":null,"title":"Children","uri":"/shortcodes/children/"},{"content":"","description":"","tags":null,"title":"children","uri":"/tags/children/"},{"content":"Contributors Special thanks to everyone who has contributed to this project.\nMany thanks to @matcornic for his work on the Learn theme.\nPackages and libraries Mermaid - generation of diagram and flowchart from text in a similar manner as Markdown font awesome - the iconic font and CSS framework jQuery - The Write Less, Do More, JavaScript Library jquery-svg-zoom-pan - enable pan and zoom in Mermaid graphs lunr - Lunr enables you to provide a great search experience without the need for external, server-side, search services… clipboard.js - copy text to clipboard modernizr - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don’t support Tooling gren - Releasenotes generator Hugo - Static site generator Netlify - Continuous deployement and hosting of this documentation Wercker - Continous testing ","description":"","tags":null,"title":"Credits","uri":"/credits/"},{"content":"","description":"","tags":null,"title":"documentation","uri":"/tags/documentation/"},{"content":"The Expand shortcode displays an expandable/collapsible section of text on your page.\nUsage {{% expand [ \u003cstring\u003e [ \"true\" | \"false\" ] ] %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is \"Expand me...\".\nThe second optional parameter controls if the block is initially shown as expanded (\"true\") or collapsed (\"false\"). The default ist \"false\".\nExamples I'll tell you a secret... …maybe the next time you’ll open this expander!\n All defaults Expand me... Yes, you did it!\n Show markup {{% expand %}} Yes, you did it! {{% /expand %}} Initially expanded Expand me... No need to press you!\n Show markup {{% expand \"Expand me...\" \"true\" %}} No need to press you! {{% /expand %}} Arbitrary text Show me endless possibilities Some expandable text.\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides expand etc. ...and even source code the possiblities are endless\n Show markup {{% expand \"Show me endless possibilities\" %}} Some expandable text. You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - other shortcodes besides `expand` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /expand %}} ","description":"Displays an expandable/collapsible section of text on your page","tags":null,"title":"Expand","uri":"/shortcodes/expand/"},{"content":"","description":"","tags":null,"title":"hidden","uri":"/tags/hidden/"},{"content":"The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.\nUsage {{% include \u003cstring\u003e [ \"true\" | \"false\" ] %}} The first required parameter is the path to the file to be included.\nIf the file’s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (\"true\")- which is the default - or be hidden.\nExamples Arbitray content You can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides include etc. ...and even source code the possiblities are endless\n Show markup {{% include \"shortcodes/INCLUDE_ME.md\" %}} ","description":"Displays content from other Markdown files","tags":null,"title":"Include","uri":"/shortcodes/include/"},{"content":"Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.\nUsage Just insert your Mermaid code in the mermaid shortcode like this:\n{{\u003c mermaid [ align=(\"left\"|\"right\"|\"center\"|\"justify\") ] \u003e}} classDiagram Person *-- Dog {{\u003c /mermaid \u003e}} You can set an optional align attribute which defaults to \"center\".\nIf you don’t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.highlight setting (see below):\n```mermaid classDiagram Person *-- Dog ``` The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you 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 markup {{\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 are you? loop Healthcheck John-John: Fight against hypochondria end Note right of John: Rational thoughts prevail... John--Alice: Great! John-Bob: How about you? Bob--John: Jolly good! Show markup {{\u003c mermaid \u003e}} sequenceDiagram participant Alice participant Bob Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts \u003cbr/\u003eprevail... John--\u003eAlice: Great! John-\u003eBob: How about you? Bob--\u003eJohn: Jolly good! {{\u003c /mermaid \u003e}} GANTT gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d Show markup {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d {{\u003c /mermaid \u003e}} Class classDiagram Class01 C2 : Where am i? Class09 --* C3 Class09 --| Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 C2: Cool label Show markup {{\u003c mermaid \u003e}} classDiagram Class01 \u003c|-- AveryLongClass : Cool Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --\u003e C2 : Where 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 markup ```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 ``` Configuration Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your config.toml or override these settings sidewise thru your pages frontmatter.\nThis JSON object is forwarded into Mermaid’s mermaid.initialize() function.\nSee Mermaid documentation for all allowed settings.\nAlso, if you want to use mermaid codefences, you have to turn off guessSyntax for the markup.highlight setting.\nExample [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" [markup] [markup.highlight] guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore or pages frontmatter\n+++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" +++ ","description":"Generation of diagram and flowchart from text in a similar manner as Markdown","tags":null,"title":"Mermaid","uri":"/shortcodes/mermaid/"},{"content":"","description":"","tags":null,"title":"non-hidden","uri":"/tags/non-hidden/"},{"content":"The notice shortcode shows four types of disclaimers to help you structure your page.\nUsage {{% notice ( note | info | tip | warning ) [ \u003cstring\u003e ] %}} Some markup {{% /notice %}} The first parameter is required and indicates the type of notice.\nThe second parameter is optional. If provided, it will be used as the title of the notice. If not provided, then the type of notice will be used as the title. For example, the title of a warning notice will be “Warning”.\nExamples Note NoteA notice disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice note %}} A **notice** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Info InfoAn information disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice info %}} An **information** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Tip TipA tip disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice tip %}} A **tip** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Warning WarningA warning disclaimer\nYou can add:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links other shortcodes besides notice etc. ...and even source code the possiblities are endless\n Show markup {{% notice warning %}} A **warning** disclaimer You can add: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - other shortcodes besides `notice` - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless {{% /notice %}} Notice with Custom Title You can customize the title of the notice by passing it as a second parameter.\nPay Attention to this Note!The title is now the parameter that was provided.\n Show markup {{% notice note \"Pay Attention to this Note!\" %}} The title is now the parameter that was provided. {{% /notice %}} ","description":"Disclaimers to help you structure your page","tags":null,"title":"Notice","uri":"/shortcodes/notice/"},{"content":"This is a demo child page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1 (hidden) page 1-1-2 page 1-1-3 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1","uri":"/shortcodes/children/children-1/children-1-1/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1 ","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 1-1-1 (hidden)","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/"},{"content":"This is a non-hidden demo child page of a hidden parent page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1-1-1 (hidden) ","description":"This is a non-hidden demo child page of a hidden parent page","tags":["children","hidden"],"title":"page 1-1-1-1","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/"},{"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1-1-1 ","description":"This is a hidden demo child page","tags":["children","hidden"],"title":"page 1-1-1-1-1 (hidden)","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/"},{"content":"This is a non-hidden demo child page of a hidden parent page.\n","description":"This is a non-hidden demo child page of a hidden parent page","tags":["children","hidden"],"title":"page 1-1-1-1-1-1","uri":"/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 is a plain demo child page.\nSubpages of this page page 1-1-2-1 page 1-1-2-2 ","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2-1","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-2-2","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/"},{"content":"This is a plain demo child page.\n","description":"This is a demo child page","tags":["children","non-hidden"],"title":"page 1-1-3","uri":"/shortcodes/children/children-1/children-1-1/children-1-1-3/"},{"content":"This is a plain demo child page.\n","description":"This is a plain page test nested in a parent","tags":["children","non-hidden"],"title":"page 3-1","uri":"/shortcodes/children/children-3/test3/"},{"content":"Hugo Relearn Theme The Relearn theme is a theme for Hugo, a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.\nInfoThe theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.\n Main features TipSee what’s new within the latest update.\n Automatic Search Multilingual mode Unlimited menu levels Automatic next/prev buttons to navigate through menu entries Image resizing, shadow… Attachments files List child pages Mermaid diagram (flowchart, sequence, gantt) Customizable look and feel and theme variants Buttons Tip/Note/Info/Warning boxes Expand Tabs File inclusion Getting support To get support, feel free to open a new discussion topic or issue in the official repository on GitHub.\nBecome a contributor Feel free to update this documentation by just clicking the Edit this page link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.\nYou are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the official repository via GitHub. Please visit the contribution guidelines first.\nLicense This theme is licensed under the MIT License.\nCredits This theme would not be possible without the work of many others. See the credits for a detailed list.\n","description":"","tags":null,"title":"Relearn Theme for Hugo","uri":"/"},{"content":"BITS by Dr. Lutz Gollan ","description":"","tags":null,"title":"Showcase","uri":"/showcase/"},{"content":"The siteparam shortcode is used to help you print values of site params.\nUsage {{% siteparam \u003cstring\u003e %}} The first required parameter is the name of the site param to be displayed.\nExamples For instance, in this current site, the editURL variable is used in config.toml\n[params] editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" Use the siteparam shortcode to display its value.\n`editURL` Value : {{% siteparam \"editURL\" %}} is displayed as\neditURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n","description":"Get value of site params variables in your page","tags":null,"title":"Site param","uri":"/shortcodes/siteparam/"},{"content":"Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in 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 with the same tabs that belong to the same group sychronize their selection:\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 WarningWhen using tab views with different content sets, make sure to use a common groupId for equal sets but distinct groupId for different sets. The groupId defaults to 'default'. Take this into account across the whole site! The tab selection is restored automatically based on the groupId and if it cannot find a tab item because it came from the 'default' group on a different page then all tabs will be empty at first.\n ","description":"Synchronize selection of content in different tabbed views","tags":null,"title":"Tabbed views","uri":"/shortcodes/tabs/"},{"content":"","description":"","tags":null,"title":"Tags","uri":"/tags/"},{"content":"Placeholder…\n","description":"","tags":null,"title":"The one and only hidden child","uri":"/yours/children-1/"},{"content":"","description":"","tags":null,"title":"tutorial","uri":"/tags/tutorial/"}] \ No newline at end of file diff --git a/pir/404.html b/pir/404.html index edeb4de1f4..a78cbde870 100644 --- a/pir/404.html +++ b/pir/404.html @@ -3,18 +3,19 @@ + - + 404 Page not found :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - + + + + + + + + diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index a08a8dfa60..3ccc814100 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -3,21 +3,22 @@ + - + Configurrrat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -229,13 +230,13 @@ On plank “Architecture” ye need a class diagram. Ye can set th' Merr

    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:

    -
    [Lanugages]
-[Lanugages.en]
+
    [Languages]
+[Languages.en]
 ...
 landingPageURL = "/"
 landingPageName = "<i class='fas fa-home'></i> Home"
 ...
-[Lanugages.pir]
+[Languages.pir]
 ...
 landingPageURL = "/pir/"
 landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
@@ -258,14 +259,14 @@ landingPageName = "<i class='fas fa-home
 
    
 
    
 
    
-
-
-
-
-
-
-
+
+
+
+
+
+
+
 
-
+
 
 
\ No newline at end of file
diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html
index 085fd06a47..22badc5fec 100644
--- a/pir/basics/customization/index.html
+++ b/pir/basics/customization/index.html
@@ -3,21 +3,22 @@
 
 
 
+
 
 
 
-
+
 Customizat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -34,9 +35,9 @@ Relearn
 
 
 
    
-
-
-
+
+
+
      @@ -245,14 +246,14 @@ Ye could use an img HTML tag an' reference an image created under t
      - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index 0d535b343e..2087d96724 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -3,21 +3,22 @@ + - + Historrry :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
    - - - + + +
    @@ -414,14 +415,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/basics/index.html b/pir/basics/index.html index 977ffe1ff8..7fae5ebb6e 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -3,21 +3,22 @@ + - + Basics :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index 85f2e3a3ef..e8f488fb83 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -3,21 +3,22 @@ + - + Installat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -207,14 +208,14 @@ hugo new basics/second-content/_index.md
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index 3d60efdca0..39205488cb 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -3,21 +3,22 @@ + - + Migrrrat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -345,14 +346,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index c5aa4336a0..1ddff772a5 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -3,21 +3,22 @@ + - + Requirrrements :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/categories/index.html b/pir/categories/index.html index aef74dd9b8..403845312c 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -3,21 +3,22 @@ + - + Categories :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -149,14 +150,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index 8aaf379abe..5cbe7dbb00 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -3,20 +3,21 @@ + - + Arrrchetypes :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Lorem Ipsum.
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index 1d382913ee..76b73740eb 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -3,21 +3,22 @@ + - + Multilingual an' i18n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -211,14 +212,14 @@ languageName = "Arrr! Pirrrates"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/icons/index.html b/pir/cont/icons/index.html index 60fbb756f1..3b6dbfa2d2 100644 --- a/pir/cont/icons/index.html +++ b/pir/cont/icons/index.html @@ -3,20 +3,21 @@ + - + Ay'cons an' logos :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -175,14 +176,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/index.html b/pir/cont/index.html index 3210eb1647..a8803d0773 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -3,21 +3,22 @@ + - + Rambl'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -153,14 +154,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index c4bb2fb4b5..a1e9b3276e 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -3,20 +3,21 @@ + - + Marrrkdown rules :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -628,14 +629,14 @@ grunt.initConfig({
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/menushortcuts/index.html b/pir/cont/menushortcuts/index.html index 4624d10649..74d82ab90f 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -3,20 +3,21 @@ + - + Menu extrrra shorrrtcuts :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -263,14 +264,14 @@ other = "<Your value>"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index bfa154d023..648b658ced 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -3,21 +3,22 @@ + - + Planks orrrganizat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -283,14 +284,14 @@ menuTitle = "Linux"
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/syntaxhighlight/index.html b/pir/cont/syntaxhighlight/index.html index 430e59d087..2cd5123332 100644 --- a/pir/cont/syntaxhighlight/index.html +++ b/pir/cont/syntaxhighlight/index.html @@ -3,20 +3,21 @@ + - + Code highlight'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -195,14 +196,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/cont/tags/index.html b/pir/cont/tags/index.html index c961a9b0f8..71e652781e 100644 --- a/pir/cont/tags/index.html +++ b/pir/cont/tags/index.html @@ -3,20 +3,21 @@ + - + Tags :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -177,14 +178,14 @@ weight = 30
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/credits/index.html b/pir/credits/index.html index 0abf0f5a84..c2faab5f4c 100644 --- a/pir/credits/index.html +++ b/pir/credits/index.html @@ -3,20 +3,21 @@ + - + Crrredits :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -167,14 +168,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/index.html b/pir/index.html index 75d31a7d59..e3caa443f1 100644 --- a/pir/index.html +++ b/pir/index.html @@ -3,21 +3,22 @@ + - + Relearrrn Theme fer Cap'n Hugo :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/index.json b/pir/index.json index a21f48e727..d7317d9fbd 100644 --- a/pir/index.json +++ b/pir/index.json @@ -1 +1 @@ -[{"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![Minion](https://octodex.github.com/images/minion.png) or\n![Alt text](https://octodex.github.com/images/stormtroopocat.jpg \"The Stormtroopocat\") Like links, Images also have a footnote style rules\nAlternative usage : note images ![Alt text][id] Wit' a reference later 'n th' document defin'n th' URL locat'n:\n[id]: https://octodex.github.com/images/dojocat.jpg \"The Dojocat\" Further image formatt'n Th' Cap'n Hugo Marrrkdown parser supports additional non-standard functionality.\nResiz'n image Add HTTP parameters width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20pc) ![Minion](https://octodex.github.com/images/minion.png?height=50px) ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=300px) Add CSS classes Add a HTTP classes parameter t' th' link image t' add CSS classes. shadowan' border be avail'ble but ye could define other ones.\n![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) Lightbox Add a HTTP featherlight parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n featherlight t' false.\n![Minion](https://octodex.github.com/images/minion.png?featherlight=false) ","description":"","tags":null,"title":"Marrrkdown rules","uri":"/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.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 rambl'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 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.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 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][change] 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][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make 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][change] code highligher: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superflous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ","description":"","tags":null,"title":"Historrry","uri":"/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":"","description":"","tags":null,"title":"1","uri":"/pir/yours/1/"},{"content":"","description":"","tags":null,"title":"11","uri":"/pir/yours/10/"},{"content":"","description":"","tags":null,"title":"2","uri":"/pir/yours/2/"},{"content":"","description":"","tags":null,"title":"3","uri":"/pir/yours/3/"},{"content":"","description":"","tags":null,"title":"4","uri":"/pir/yours/4/"},{"content":"","description":"","tags":null,"title":"5","uri":"/pir/yours/5/"},{"content":"","description":"","tags":null,"title":"6","uri":"/pir/yours/6/"},{"content":"","description":"","tags":null,"title":"7","uri":"/pir/yours/7/"},{"content":"","description":"","tags":null,"title":"8","uri":"/pir/yours/8/"},{"content":"","description":"","tags":null,"title":"9","uri":"/pir/yours/9/"},{"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/"}] \ No newline at end of file +[{"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![Minion](https://octodex.github.com/images/minion.png) or\n![Alt text](https://octodex.github.com/images/stormtroopocat.jpg \"The Stormtroopocat\") Like links, Images also have a footnote style rules\nAlternative usage : note images ![Alt text][id] Wit' a reference later 'n th' document defin'n th' URL locat'n:\n[id]: https://octodex.github.com/images/dojocat.jpg \"The Dojocat\" Further image formatt'n Th' Cap'n Hugo Marrrkdown parser supports additional non-standard functionality.\nResiz'n image Add HTTP parameters width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20pc) ![Minion](https://octodex.github.com/images/minion.png?height=50px) ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=300px) Add CSS classes Add a HTTP classes parameter t' th' link image t' add CSS classes. shadowan' border be avail'ble but ye could define other ones.\n![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) Lightbox Add a HTTP featherlight parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n featherlight t' false.\n![Minion](https://octodex.github.com/images/minion.png?featherlight=false) ","description":"","tags":null,"title":"Marrrkdown rules","uri":"/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.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 rambl'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 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[Languages] [Languages.en] ... landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Languages.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.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 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][change] 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][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make 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][change] code highligher: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superflous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ","description":"","tags":null,"title":"Historrry","uri":"/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":"","description":"","tags":null,"title":"1","uri":"/pir/yours/1/"},{"content":"","description":"","tags":null,"title":"11","uri":"/pir/yours/10/"},{"content":"","description":"","tags":null,"title":"2","uri":"/pir/yours/2/"},{"content":"","description":"","tags":null,"title":"3","uri":"/pir/yours/3/"},{"content":"","description":"","tags":null,"title":"4","uri":"/pir/yours/4/"},{"content":"","description":"","tags":null,"title":"5","uri":"/pir/yours/5/"},{"content":"","description":"","tags":null,"title":"6","uri":"/pir/yours/6/"},{"content":"","description":"","tags":null,"title":"7","uri":"/pir/yours/7/"},{"content":"","description":"","tags":null,"title":"8","uri":"/pir/yours/8/"},{"content":"","description":"","tags":null,"title":"9","uri":"/pir/yours/9/"},{"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/"}] \ No newline at end of file diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index 0902b752fc..6e2af091ff 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -3,20 +3,21 @@ + - + Attachments :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -322,14 +323,14 @@ Currently, it support two implementat'ns fer planks

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index c252c739c1..c39c5a4f67 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -3,20 +3,21 @@ + - + Button :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -172,14 +173,14 @@ Get Cap'n Hugo wit' ay'con right
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index 50f4715c52..e1d0bd1a11 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-1-1-1-1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -171,14 +172,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 943664b512..3fabdd4f7f 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-1-1-1 (hidden) :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -174,14 +175,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index 3ccd46b152..e3a130f33c 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-1-1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -171,14 +172,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index 011c3138ae..a968a70056 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-1 (hidden) :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -170,14 +171,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index d5ac6f971b..8c80003c6e 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-2-1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index 8ad734126f..158ec291be 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-2-2 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html index a11fd05986..b04b46947b 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-2 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -169,14 +170,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index 32b17f8cc9..287ecf2dda 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1-3 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -164,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/children-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/index.html index 7d65a32d35..d9342e41aa 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1-1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -169,14 +170,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-1/index.html b/pir/shortcodes/children/children-1/index.html index eacbbe3a3a..c31489d82e 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -3,21 +3,22 @@ + - + Plank 1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-2/index.html b/pir/shortcodes/children/children-2/index.html index c84aa12230..31c12c82b8 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -3,21 +3,22 @@ + - + Plank 2 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -163,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 30056feaa3..d9092a3f0d 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -3,21 +3,22 @@ + - + Plank 3 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-3/test3/index.html b/pir/shortcodes/children/children-3/test3/index.html index c64a39984c..bb5f732b64 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -3,20 +3,21 @@ + - + Plank 3-1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -162,14 +163,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index 079592eb61..b08d6126d1 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -3,21 +3,22 @@ + - + Plank 4 (hidden) :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -163,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index 66e862f943..1931858ecd 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -3,21 +3,22 @@ + - + Children :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -282,14 +283,14 @@ So its rambl'n be used as descript'n.

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index a88044de53..07e9d7d66f 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -3,20 +3,21 @@ + - + Plank X :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -157,14 +158,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index 88cb7480ad..afedfda9d6 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -3,20 +3,21 @@ + - + Expand :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -273,14 +274,14 @@ Ye can add:
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/include/index.html b/pir/shortcodes/include/index.html index fb1607eb18..925beecdb6 100644 --- a/pir/shortcodes/include/index.html +++ b/pir/shortcodes/include/index.html @@ -3,20 +3,21 @@ + - + Include :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Show marrrkup
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/index.html b/pir/shortcodes/index.html index 1e5d657ad1..cb96f32d71 100644 --- a/pir/shortcodes/index.html +++ b/pir/shortcodes/index.html @@ -3,21 +3,22 @@ + - + Shorrrtcodes :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -176,14 +177,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/mermaid/index.html b/pir/shortcodes/mermaid/index.html index 89d2c0f5b1..f32ced3d5c 100644 --- a/pir/shortcodes/mermaid/index.html +++ b/pir/shortcodes/mermaid/index.html @@ -3,20 +3,21 @@ + - + Merrrmaid :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -367,14 +368,14 @@ mermaidInitialize = "{ \"theme\": \"da
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/notice/index.html b/pir/shortcodes/notice/index.html index c45ab26928..e6e915b49f 100644 --- a/pir/shortcodes/notice/index.html +++ b/pir/shortcodes/notice/index.html @@ -3,20 +3,21 @@ + - + Notice :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -361,14 +362,14 @@ Th' title be now th' parameter that was provided.
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index dbf8038681..04203ea907 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -3,20 +3,21 @@ + - + Ship param :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -167,14 +168,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/shortcodes/tabs/index.html b/pir/shortcodes/tabs/index.html index 6ea7b69349..e9ae8adf4e 100644 --- a/pir/shortcodes/tabs/index.html +++ b/pir/shortcodes/tabs/index.html @@ -3,20 +3,21 @@ + - + Tabbed views :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -269,14 +270,14 @@ from th' 'default' group on a different plank then all tabs will be
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/showcase/index.html b/pir/showcase/index.html index fad35634e0..9e6b0c0934 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -3,20 +3,21 @@ + - + Showcase :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -149,14 +150,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index acfcd904b8..340dbe6a25 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -3,21 +3,22 @@ + - + children :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -164,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index ebe05c4466..c102b12d18 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -3,21 +3,22 @@ + - + documentat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -151,14 +152,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/hidden/index.html b/pir/tags/hidden/index.html index a168720f63..64ce3691b2 100644 --- a/pir/tags/hidden/index.html +++ b/pir/tags/hidden/index.html @@ -3,21 +3,22 @@ + - + hidden :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -155,14 +156,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/index.html b/pir/tags/index.html index 32efdbe8bb..d3db94faed 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -3,21 +3,22 @@ + - + Tags :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -154,14 +155,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index b6c798a8d2..130c681bfb 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -3,21 +3,22 @@ + - + non-hidden :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -159,14 +160,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index 57d4111fe2..87fd2583ae 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -3,21 +3,22 @@ + - + tutorrrial :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -151,14 +152,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/1/index.html b/pir/yours/1/index.html index a5ef559bab..9d41c02435 100644 --- a/pir/yours/1/index.html +++ b/pir/yours/1/index.html @@ -3,20 +3,21 @@ + - + 1 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/10/index.html b/pir/yours/10/index.html index a610e0ec20..3557b2bcf9 100644 --- a/pir/yours/10/index.html +++ b/pir/yours/10/index.html @@ -3,20 +3,21 @@ + - + 11 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/2/index.html b/pir/yours/2/index.html index 298349346e..0f66fe6f09 100644 --- a/pir/yours/2/index.html +++ b/pir/yours/2/index.html @@ -3,20 +3,21 @@ + - + 2 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/3/index.html b/pir/yours/3/index.html index 0d370b33a2..0e7f9d1e42 100644 --- a/pir/yours/3/index.html +++ b/pir/yours/3/index.html @@ -3,20 +3,21 @@ + - + 3 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/4/index.html b/pir/yours/4/index.html index 472d46b1a2..5ff1dc1ebe 100644 --- a/pir/yours/4/index.html +++ b/pir/yours/4/index.html @@ -3,20 +3,21 @@ + - + 4 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/5/index.html b/pir/yours/5/index.html index 9e4e47b2b3..0f75abe5fa 100644 --- a/pir/yours/5/index.html +++ b/pir/yours/5/index.html @@ -3,20 +3,21 @@ + - + 5 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/6/index.html b/pir/yours/6/index.html index 22c7a56853..5d4bd9c9bb 100644 --- a/pir/yours/6/index.html +++ b/pir/yours/6/index.html @@ -3,20 +3,21 @@ + - + 6 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/7/index.html b/pir/yours/7/index.html index 1a58ec002d..b32c185be6 100644 --- a/pir/yours/7/index.html +++ b/pir/yours/7/index.html @@ -3,20 +3,21 @@ + - + 7 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/8/index.html b/pir/yours/8/index.html index 60deffaf8e..6fc5a03b5a 100644 --- a/pir/yours/8/index.html +++ b/pir/yours/8/index.html @@ -3,20 +3,21 @@ + - + 8 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -166,14 +167,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/9/index.html b/pir/yours/9/index.html index a7ca9e8b1f..a81c9461d1 100644 --- a/pir/yours/9/index.html +++ b/pir/yours/9/index.html @@ -3,20 +3,21 @@ + - + 9 :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/children-1/index.html b/pir/yours/children-1/index.html index 1fc19f522e..d2e29f0e1c 100644 --- a/pir/yours/children-1/index.html +++ b/pir/yours/children-1/index.html @@ -3,21 +3,22 @@ + - + Th' one an' only hidden child :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -168,14 +169,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/pir/yours/index.html b/pir/yours/index.html index 9721b18572..dce663d16e 100644 --- a/pir/yours/index.html +++ b/pir/yours/index.html @@ -3,21 +3,22 @@ + - + This could be yers :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -164,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index c2230a3b08..6abf2a47c5 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -3,20 +3,21 @@ + - + Attachments :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -325,14 +326,14 @@ Currently, it support two implementations for pages

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index 7ed4eb67fd..5a54c4ecd6 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -3,20 +3,21 @@ + - + Button :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -172,14 +173,14 @@ Get Hugo with icon right
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index 0d23f45a8b..6e4385e4f3 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1-1-1-1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -171,14 +172,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 87cdc93bfb..b2aed2e8d3 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1-1-1-1 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -178,14 +179,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index 967fdadd8c..336f4aed85 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1-1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -175,14 +176,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index 890d717e9a..9a7631ed61 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1-1 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -174,14 +175,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index 3fb9a7d513..d13f1988d6 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1-2-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index e506450b96..84a4ef0cfd 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -3,21 +3,22 @@ + - + page 1-1-2-2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -165,14 +166,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html index 3bdc1c52f7..d8cc761518 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html @@ -3,21 +3,22 @@ + - + page 1-1-2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -173,14 +174,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index 1b2f5df7d7..ed5b40ab6d 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -3,21 +3,22 @@ + - + page 1-1-3 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -164,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index cb243a2298..51496cc5a7 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -3,21 +3,22 @@ + - + page 1-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -173,14 +174,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index af372a29c9..2bb506413a 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -3,21 +3,22 @@ + - + page 1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -170,14 +171,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index ccc912db24..c89d96d0e8 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -3,21 +3,22 @@ + - + page 2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -163,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index 1992ac050f..07245e263c 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -3,21 +3,22 @@ + - + page 3 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -170,14 +171,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-3/test3/index.html b/shortcodes/children/children-3/test3/index.html index e187a8384b..b0e3712f5a 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -3,20 +3,21 @@ + - + page 3-1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -162,14 +163,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index 0989137f12..d12107cea6 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -3,21 +3,22 @@ + - + page 4 (hidden) :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -163,14 +164,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index 201d6826d9..054ca09867 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -3,21 +3,22 @@ + - + Children :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -287,14 +288,14 @@ So its content is used as description.

    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index 9ce63e82c6..ad4367242c 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -3,21 +3,22 @@ + - + page X :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -158,14 +159,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index 94c1351a89..1a968f1769 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -3,20 +3,21 @@ + - + Expand :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -284,14 +285,14 @@ You can add:
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/include/index.html b/shortcodes/include/index.html index e4aa9ae92e..d3e0838c7f 100644 --- a/shortcodes/include/index.html +++ b/shortcodes/include/index.html @@ -3,20 +3,21 @@ + - + Include :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -195,14 +196,14 @@ Show markup
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/include_me/index.html b/shortcodes/include_me/index.html index cba4387452..a1bb1b5df0 100644 --- a/shortcodes/include_me/index.html +++ b/shortcodes/include_me/index.html @@ -3,21 +3,22 @@ + - + :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -170,14 +171,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/index.html b/shortcodes/index.html index b4147b3f59..f47758328f 100644 --- a/shortcodes/index.html +++ b/shortcodes/index.html @@ -3,21 +3,22 @@ + - + Shortcodes :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -176,14 +177,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/mermaid/index.html b/shortcodes/mermaid/index.html index d4b901a754..f00ed55a73 100644 --- a/shortcodes/mermaid/index.html +++ b/shortcodes/mermaid/index.html @@ -3,20 +3,21 @@ + - + Mermaid :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -385,14 +386,14 @@ mermaidInitialize = "{ \"theme\": \"da
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/notice/index.html b/shortcodes/notice/index.html index 30a4a03b17..4832751286 100644 --- a/shortcodes/notice/index.html +++ b/shortcodes/notice/index.html @@ -3,20 +3,21 @@ + - + Notice :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -374,14 +375,14 @@ The title is now the parameter that was provided.
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/siteparam/index.html b/shortcodes/siteparam/index.html index 5938b00a01..e4a4f1f7d5 100644 --- a/shortcodes/siteparam/index.html +++ b/shortcodes/siteparam/index.html @@ -3,20 +3,21 @@ + - + Site param :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -172,14 +173,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/shortcodes/tabs/index.html b/shortcodes/tabs/index.html index 55a5640ff3..6e9ad8372e 100644 --- a/shortcodes/tabs/index.html +++ b/shortcodes/tabs/index.html @@ -3,20 +3,21 @@ + - + Tabbed views :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -274,14 +275,14 @@ from the 'default' group on a different page then all tabs will be
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/showcase/index.html b/showcase/index.html index c807c7a68b..b86309a068 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -3,20 +3,21 @@ + - + Showcase :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -149,14 +150,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/children/index.html b/tags/children/index.html index 21b025ad51..24ecc77424 100644 --- a/tags/children/index.html +++ b/tags/children/index.html @@ -3,21 +3,22 @@ + - + children :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -164,14 +165,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/documentation/index.html b/tags/documentation/index.html index 612587dd27..8c720f4607 100644 --- a/tags/documentation/index.html +++ b/tags/documentation/index.html @@ -3,21 +3,22 @@ + - + documentation :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -151,14 +152,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/hidden/index.html b/tags/hidden/index.html index 4e30d3f0d5..3c3ac5679d 100644 --- a/tags/hidden/index.html +++ b/tags/hidden/index.html @@ -3,21 +3,22 @@ + - + hidden :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -155,14 +156,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 78c24ef81a..1c5a832c18 100644 --- a/tags/index.html +++ b/tags/index.html @@ -3,21 +3,22 @@ + - + Tags :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -154,14 +155,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/non-hidden/index.html b/tags/non-hidden/index.html index 96af483b67..ffad0d46d6 100644 --- a/tags/non-hidden/index.html +++ b/tags/non-hidden/index.html @@ -3,21 +3,22 @@ + - + non-hidden :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -159,14 +160,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/tags/tutorial/index.html b/tags/tutorial/index.html index 4d6b67e935..59e3d9e5bb 100644 --- a/tags/tutorial/index.html +++ b/tags/tutorial/index.html @@ -3,21 +3,22 @@ + - + tutorial :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -151,14 +152,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/1/index.html b/yours/1/index.html index 905468e420..de77056003 100644 --- a/yours/1/index.html +++ b/yours/1/index.html @@ -3,20 +3,21 @@ + - + 1 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/10/index.html b/yours/10/index.html index b69d99f594..1eadf7605d 100644 --- a/yours/10/index.html +++ b/yours/10/index.html @@ -3,20 +3,21 @@ + - + 10 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/11.de/index.html b/yours/11.de/index.html index b6b1ca70a8..fd4ad2339f 100644 --- a/yours/11.de/index.html +++ b/yours/11.de/index.html @@ -3,20 +3,21 @@ + - + 11 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/12.de/index.html b/yours/12.de/index.html index a51fbccd86..7c3d07710b 100644 --- a/yours/12.de/index.html +++ b/yours/12.de/index.html @@ -3,20 +3,21 @@ + - + 12 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/13.de/index.html b/yours/13.de/index.html index 0ca5e5ad87..b6489348e2 100644 --- a/yours/13.de/index.html +++ b/yours/13.de/index.html @@ -3,20 +3,21 @@ + - + 13 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/14.de/index.html b/yours/14.de/index.html index 27733ae579..b207696974 100644 --- a/yours/14.de/index.html +++ b/yours/14.de/index.html @@ -3,20 +3,21 @@ + - + 14 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/15.de/index.html b/yours/15.de/index.html index 4f42356196..abf700748d 100644 --- a/yours/15.de/index.html +++ b/yours/15.de/index.html @@ -3,20 +3,21 @@ + - + 15 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/16.de/index.html b/yours/16.de/index.html index 6ce7c6027d..e6ff1567c1 100644 --- a/yours/16.de/index.html +++ b/yours/16.de/index.html @@ -3,20 +3,21 @@ + - + 16 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/17.de/index.html b/yours/17.de/index.html index a703a93d6d..5c97ddfbc4 100644 --- a/yours/17.de/index.html +++ b/yours/17.de/index.html @@ -3,20 +3,21 @@ + - + 17 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/18.de/index.html b/yours/18.de/index.html index fa7f917715..fbecdce07e 100644 --- a/yours/18.de/index.html +++ b/yours/18.de/index.html @@ -3,20 +3,21 @@ + - + 18 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/19.de/index.html b/yours/19.de/index.html index 5628c8c634..0bc93a7198 100644 --- a/yours/19.de/index.html +++ b/yours/19.de/index.html @@ -3,20 +3,21 @@ + - + 19 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/2/index.html b/yours/2/index.html index 39ab543f34..83fbe8f7a3 100644 --- a/yours/2/index.html +++ b/yours/2/index.html @@ -3,20 +3,21 @@ + - + 2 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/20.de/index.html b/yours/20.de/index.html index 527f4a4af3..cb9d3abdf5 100644 --- a/yours/20.de/index.html +++ b/yours/20.de/index.html @@ -3,20 +3,21 @@ + - + 20 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/21.de/index.html b/yours/21.de/index.html index 21a3d45586..ea34cfb075 100644 --- a/yours/21.de/index.html +++ b/yours/21.de/index.html @@ -3,20 +3,21 @@ + - + 21 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/22.de/index.html b/yours/22.de/index.html index 2a665a8b3f..e0c5911dd1 100644 --- a/yours/22.de/index.html +++ b/yours/22.de/index.html @@ -3,20 +3,21 @@ + - + 22 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/23.de/index.html b/yours/23.de/index.html index 1cb5605ce1..cbf1065fce 100644 --- a/yours/23.de/index.html +++ b/yours/23.de/index.html @@ -3,20 +3,21 @@ + - + 23 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/24.de/index.html b/yours/24.de/index.html index 4365db779b..716c0f1f0e 100644 --- a/yours/24.de/index.html +++ b/yours/24.de/index.html @@ -3,20 +3,21 @@ + - + 24 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/25.de/index.html b/yours/25.de/index.html index 41d28463dc..c4e35f8d0e 100644 --- a/yours/25.de/index.html +++ b/yours/25.de/index.html @@ -3,20 +3,21 @@ + - + 25 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/26.de/index.html b/yours/26.de/index.html index d7ebdfde10..b6881c4896 100644 --- a/yours/26.de/index.html +++ b/yours/26.de/index.html @@ -3,20 +3,21 @@ + - + 26 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/27.de/index.html b/yours/27.de/index.html index 0f974f05d6..b1f78440ca 100644 --- a/yours/27.de/index.html +++ b/yours/27.de/index.html @@ -3,20 +3,21 @@ + - + 27 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/28.de/index.html b/yours/28.de/index.html index cbb9d8222e..1f0709a635 100644 --- a/yours/28.de/index.html +++ b/yours/28.de/index.html @@ -3,20 +3,21 @@ + - + 28 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/29.de/index.html b/yours/29.de/index.html index 381d700e8c..d98bc86443 100644 --- a/yours/29.de/index.html +++ b/yours/29.de/index.html @@ -3,20 +3,21 @@ + - + 29 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/3/index.html b/yours/3/index.html index 3637134bca..a0795d35bb 100644 --- a/yours/3/index.html +++ b/yours/3/index.html @@ -3,20 +3,21 @@ + - + 3 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/30.de/index.html b/yours/30.de/index.html index af29c398d0..43151e36ac 100644 --- a/yours/30.de/index.html +++ b/yours/30.de/index.html @@ -3,20 +3,21 @@ + - + 30 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/4/index.html b/yours/4/index.html index df598e966a..27e1fc7793 100644 --- a/yours/4/index.html +++ b/yours/4/index.html @@ -3,20 +3,21 @@ + - + 4 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/5/index.html b/yours/5/index.html index d391908f29..a7eeb6c281 100644 --- a/yours/5/index.html +++ b/yours/5/index.html @@ -3,20 +3,21 @@ + - + 5 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/6/index.html b/yours/6/index.html index 39a33b8840..9ab9b4302b 100644 --- a/yours/6/index.html +++ b/yours/6/index.html @@ -3,20 +3,21 @@ + - + 6 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/7/index.html b/yours/7/index.html index 4f03221498..cfd18f1f6e 100644 --- a/yours/7/index.html +++ b/yours/7/index.html @@ -3,20 +3,21 @@ + - + 7 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/8/index.html b/yours/8/index.html index 1d82c97e93..41111c5ee5 100644 --- a/yours/8/index.html +++ b/yours/8/index.html @@ -3,20 +3,21 @@ + - + 8 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -186,14 +187,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/9/index.html b/yours/9/index.html index 0203f03b88..ad719037df 100644 --- a/yours/9/index.html +++ b/yours/9/index.html @@ -3,20 +3,21 @@ + - + 9 :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -33,9 +34,9 @@ Relearn
- - - + + +
    @@ -185,14 +186,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/children-1/index.html b/yours/children-1/index.html index c282a20754..a08fade43f 100644 --- a/yours/children-1/index.html +++ b/yours/children-1/index.html @@ -3,21 +3,22 @@ + - + The one and only hidden child :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -188,14 +189,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file diff --git a/yours/index.html b/yours/index.html index 9623af9799..8019d05874 100644 --- a/yours/index.html +++ b/yours/index.html @@ -3,21 +3,22 @@ + - + This could be yours :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + @@ -34,9 +35,9 @@ Relearn
- - - + + +
    @@ -184,14 +185,14 @@ Relearn
    - - - - - - - + + + + + + + - + \ No newline at end of file