diff --git a/404.html b/404.html index a55a13b933..16fc748661 100644 --- a/404.html +++ b/404.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ 404 Page not found :: Hugo Relearn Theme - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/branding/index.print.html b/basics/branding/index.print.html index fe1043121c..f27c9fb316 100644 --- a/basics/branding/index.print.html +++ b/basics/branding/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/branding/index.xml b/basics/branding/index.xml index 41f6e7b418..e185385ca6 100644 --- a/basics/branding/index.xml +++ b/basics/branding/index.xml @@ -1,9 +1,9 @@ - Branding on Hugo Relearn Theme + Branding :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html - Recent content in Branding on Hugo Relearn Theme + The Relearn theme provides configuration options to change your site’s colors, favicon and logo. Hugo en diff --git a/basics/configuration/index.html b/basics/configuration/index.html index 5f2f3faee4..48b6697b97 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/configuration/index.print.html b/basics/configuration/index.print.html index 749bb57389..910ede4221 100644 --- a/basics/configuration/index.print.html +++ b/basics/configuration/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/index.xml b/basics/configuration/index.xml index 7ebdf5c1bf..547a629c44 100644 --- a/basics/configuration/index.xml +++ b/basics/configuration/index.xml @@ -1,9 +1,9 @@ - Configuration on Hugo Relearn Theme + Configuration :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html - Recent content in Configuration on Hugo Relearn Theme + On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo. Hugo en diff --git a/basics/customization/index.html b/basics/customization/index.html index 2dc7fa59d4..1e79d755a3 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/customization/index.print.html b/basics/customization/index.print.html index 06d76d93a5..5be271e85b 100644 --- a/basics/customization/index.print.html +++ b/basics/customization/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/customization/index.xml b/basics/customization/index.xml index 35f1d4f81b..5708776d6d 100644 --- a/basics/customization/index.xml +++ b/basics/customization/index.xml @@ -1,9 +1,9 @@ - Customization on Hugo Relearn Theme + Customization :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/customization/index.html - Recent content in Customization on Hugo Relearn Theme + Usage scenarios The theme is usable in different scenarios, requiring the following mandatory settings in your hugo. Hugo en diff --git a/basics/generator/index.html b/basics/generator/index.html index c941e88630..74e58279f7 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.print.html b/basics/generator/index.print.html index 761175b34a..b86c2812ec 100644 --- a/basics/generator/index.print.html +++ b/basics/generator/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.xml b/basics/generator/index.xml index 7a99ab893b..e9a478e963 100644 --- a/basics/generator/index.xml +++ b/basics/generator/index.xml @@ -1,9 +1,9 @@ - Stylesheet generator on Hugo Relearn Theme + Stylesheet generator :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/generator/index.html - Recent content in Stylesheet generator on Hugo Relearn Theme + This interactive tool may help you to generate your own color variant stylesheet. Hugo en diff --git a/basics/history/index.html b/basics/history/index.html index d2336042e0..0656dae06d 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -5,21 +5,21 @@ - + - + - + - + History :: Hugo Relearn Theme @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/history/index.print.html b/basics/history/index.print.html index d05b35f0cf..f0dd6e34d5 100644 --- a/basics/history/index.print.html +++ b/basics/history/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + History :: Hugo Relearn Theme @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/history/index.xml b/basics/history/index.xml index 052bbc0d83..cde7ac1227 100644 --- a/basics/history/index.xml +++ b/basics/history/index.xml @@ -1,9 +1,9 @@ - History on Hugo Relearn Theme + History :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html - Recent content in History on Hugo Relearn Theme + Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use . Hugo en diff --git a/basics/index.html b/basics/index.html index 6c14a72751..ad2dd1aaa2 100644 --- a/basics/index.html +++ b/basics/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/index.print.html b/basics/index.print.html index 35db1c0256..efbb589ce2 100644 --- a/basics/index.print.html +++ b/basics/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/index.xml b/basics/index.xml index 7c074a4ca2..f2ae2f057d 100644 --- a/basics/index.xml +++ b/basics/index.xml @@ -1,9 +1,9 @@ - Basics on Hugo Relearn Theme + Basics :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/index.html - Recent content in Basics on Hugo Relearn Theme + Discover what this Hugo theme is all about and the core-concepts behind it. Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html - This document shows you what’s new in the latest release and flags it with one of the following badges. + This document shows you what’s new in the latest release and flags it with one of the following badges. Requirements @@ -33,14 +33,14 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html - On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo. + On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo. Branding https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html - The Relearn theme provides configuration options to change your site’s colors, favicon and logo. + The Relearn theme provides configuration options to change your site’s colors, favicon and logo. Customization @@ -68,7 +68,7 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html - Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use . + Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use . \ No newline at end of file diff --git a/basics/installation/index.html b/basics/installation/index.html index 8d29620c13..0e1608737f 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/installation/index.print.html b/basics/installation/index.print.html index 99c475195c..b4ac082888 100644 --- a/basics/installation/index.print.html +++ b/basics/installation/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/installation/index.xml b/basics/installation/index.xml index 422d18733f..47d2c2f2d5 100644 --- a/basics/installation/index.xml +++ b/basics/installation/index.xml @@ -1,9 +1,9 @@ - Installation on Hugo Relearn Theme + Installation :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/installation/index.html - Recent content in Installation on Hugo Relearn Theme + The following steps are here to help you initialize your new website. Hugo en diff --git a/basics/migration/index.html b/basics/migration/index.html index 623eb791ec..966a7d77eb 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -5,21 +5,21 @@ - + - + - + - + What's New :: Hugo Relearn Theme @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/migration/index.print.html b/basics/migration/index.print.html index ba2a08aa3f..738b995c28 100644 --- a/basics/migration/index.print.html +++ b/basics/migration/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + What's New :: Hugo Relearn Theme @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/migration/index.xml b/basics/migration/index.xml index 2d55f984f1..0adc1aae9e 100644 --- a/basics/migration/index.xml +++ b/basics/migration/index.xml @@ -1,9 +1,9 @@ - What's New on Hugo Relearn Theme + What's New :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html - Recent content in What's New on Hugo Relearn Theme + This document shows you what’s new in the latest release and flags it with one of the following badges. Hugo en diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 2c380200c3..6fee519f4d 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/requirements/index.print.html b/basics/requirements/index.print.html index 6d95a7bab4..872576cb40 100644 --- a/basics/requirements/index.print.html +++ b/basics/requirements/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/requirements/index.xml b/basics/requirements/index.xml index 7011277e36..0ee4054d69 100644 --- a/basics/requirements/index.xml +++ b/basics/requirements/index.xml @@ -1,9 +1,9 @@ - Requirements on Hugo Relearn Theme + Requirements :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/requirements/index.html - Recent content in Requirements on Hugo Relearn Theme + Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements. Hugo en diff --git a/basics/topbar/index.html b/basics/topbar/index.html index dfce30b5ea..fa9d491d2d 100644 --- a/basics/topbar/index.html +++ b/basics/topbar/index.html @@ -32,18 +32,18 @@ Nevertheless, your requirements may differ from this configuration."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/topbar/index.print.html b/basics/topbar/index.print.html index dff874a71a..c0e235dd97 100644 --- a/basics/topbar/index.print.html +++ b/basics/topbar/index.print.html @@ -32,19 +32,19 @@ Nevertheless, your requirements may differ from this configuration."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/topbar/index.xml b/basics/topbar/index.xml index 71ec150775..669b144183 100644 --- a/basics/topbar/index.xml +++ b/basics/topbar/index.xml @@ -1,9 +1,9 @@ - Topbar Modification on Hugo Relearn Theme + Topbar Modification :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/basics/topbar/index.html - Recent content in Topbar Modification on Hugo Relearn Theme + The theme comes with a reasonably configured topbar. Nevertheless, your requirements may differ from this configuration. Hugo en diff --git a/categories/basic/index.html b/categories/basic/index.html index 30c414a7ff..24da0f9608 100644 --- a/categories/basic/index.html +++ b/categories/basic/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/basic/index.xml b/categories/basic/index.xml index 81c0caba5b..16f961e993 100644 --- a/categories/basic/index.xml +++ b/categories/basic/index.xml @@ -1,9 +1,9 @@ - Basic on Hugo Relearn Theme + Basic :: Category :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/basic/index.html - Recent content in Basic on Hugo Relearn Theme + Hugo en diff --git a/categories/content/index.html b/categories/content/index.html index f3fca4b84b..4c15a10808 100644 --- a/categories/content/index.html +++ b/categories/content/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/content/index.xml b/categories/content/index.xml index 41494d61ed..b375af68f1 100644 --- a/categories/content/index.xml +++ b/categories/content/index.xml @@ -1,9 +1,9 @@ - Content on Hugo Relearn Theme + Content :: Category :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/content/index.html - Recent content in Content on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html - The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. + The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. \ No newline at end of file diff --git a/categories/custom/index.html b/categories/custom/index.html index af7c5f7efe..4ff90dc936 100644 --- a/categories/custom/index.html +++ b/categories/custom/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.xml b/categories/custom/index.xml index 6b7dbf0ce4..5e313b76c8 100644 --- a/categories/custom/index.xml +++ b/categories/custom/index.xml @@ -1,9 +1,9 @@ - Custom on Hugo Relearn Theme + Custom :: Category :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/custom/index.html - Recent content in Custom on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html - The Relearn theme provides configuration options to change your site’s colors, favicon and logo. + The Relearn theme provides configuration options to change your site’s colors, favicon and logo. \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index 2c611662ee..caf8677858 100644 --- a/categories/index.html +++ b/categories/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/index.xml b/categories/index.xml index 5797311b44..43015901e5 100644 --- a/categories/index.xml +++ b/categories/index.xml @@ -1,42 +1,42 @@ - Categories on Hugo Relearn Theme + Categories :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/index.html - Recent content in Categories on Hugo Relearn Theme + Hugo en - Basic + Category :: Basic https://mcshelby.github.io/hugo-theme-relearn/categories/basic/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/categories/basic/index.html - Content + Category :: Content https://mcshelby.github.io/hugo-theme-relearn/categories/content/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/categories/content/index.html - Custom + Category :: Custom https://mcshelby.github.io/hugo-theme-relearn/categories/custom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/categories/custom/index.html - Taxonomy + Category :: Taxonomy https://mcshelby.github.io/hugo-theme-relearn/categories/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/categories/taxonomy/index.html - Theming + Category :: Theming https://mcshelby.github.io/hugo-theme-relearn/categories/theming/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/categories/theming/index.html diff --git a/categories/taxonomy/index.html b/categories/taxonomy/index.html index 1e46c0c4e2..a0a60ef3a3 100644 --- a/categories/taxonomy/index.html +++ b/categories/taxonomy/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/taxonomy/index.xml b/categories/taxonomy/index.xml index 2f56dbb435..f65cfda16e 100644 --- a/categories/taxonomy/index.xml +++ b/categories/taxonomy/index.xml @@ -1,9 +1,9 @@ - Taxonomy on Hugo Relearn Theme + Taxonomy :: Category :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/taxonomy/index.html - Recent content in Taxonomy on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html - The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. + The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. \ No newline at end of file diff --git a/categories/theming/index.html b/categories/theming/index.html index 4d8c2f40ba..66062301d3 100644 --- a/categories/theming/index.html +++ b/categories/theming/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.xml b/categories/theming/index.xml index 57089e2dd5..e849cb8e07 100644 --- a/categories/theming/index.xml +++ b/categories/theming/index.xml @@ -1,9 +1,9 @@ - Theming on Hugo Relearn Theme + Theming :: Category :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/categories/theming/index.html - Recent content in Theming on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/branding/index.html - The Relearn theme provides configuration options to change your site’s colors, favicon and logo. + The Relearn theme provides configuration options to change your site’s colors, favicon and logo. Stylesheet generator diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index 23aa77f0f9..1e8f636896 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.print.html b/cont/archetypes/index.print.html index 309a7e8107..84a29d476c 100644 --- a/cont/archetypes/index.print.html +++ b/cont/archetypes/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/archetypes/index.xml b/cont/archetypes/index.xml index b732f8d1cf..e58fafcbc1 100644 --- a/cont/archetypes/index.xml +++ b/cont/archetypes/index.xml @@ -1,9 +1,9 @@ - Archetypes on Hugo Relearn Theme + Archetypes :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/archetypes/index.html - Recent content in Archetypes on Hugo Relearn Theme + Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. Hugo en diff --git a/cont/frontmatter/index.html b/cont/frontmatter/index.html index 67f6ca0cf8..18850fcc76 100644 --- a/cont/frontmatter/index.html +++ b/cont/frontmatter/index.html @@ -32,18 +32,18 @@ All Frontmatter Options The values reflect example options."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/frontmatter/index.print.html b/cont/frontmatter/index.print.html index 03ede75597..09cf299377 100644 --- a/cont/frontmatter/index.print.html +++ b/cont/frontmatter/index.print.html @@ -32,19 +32,19 @@ All Frontmatter Options The values reflect example options."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/frontmatter/index.xml b/cont/frontmatter/index.xml index 0b44fa6280..9ef717fec3 100644 --- a/cont/frontmatter/index.xml +++ b/cont/frontmatter/index.xml @@ -1,9 +1,9 @@ - Frontmatter on Hugo Relearn Theme + Frontmatter :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html - Recent content in Frontmatter on Hugo Relearn Theme + Each Hugo page has to define a frontmatter. All Frontmatter Options The values reflect example options. Hugo en diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 59760ab02d..8fbd7f2bf4 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/i18n/index.print.html b/cont/i18n/index.print.html index 3621c712d4..83cd194a25 100644 --- a/cont/i18n/index.print.html +++ b/cont/i18n/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/i18n/index.xml b/cont/i18n/index.xml index abd57b9b3a..349dff9c93 100644 --- a/cont/i18n/index.xml +++ b/cont/i18n/index.xml @@ -1,9 +1,9 @@ - Multilingual and i18n on Hugo Relearn Theme + Multilingual and i18n :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/i18n/index.html - Recent content in Multilingual and i18n on Hugo Relearn Theme + The Relearn theme is fully compatible with Hugo multilingual mode. Hugo en diff --git a/cont/imageeffects/index.html b/cont/imageeffects/index.html index c5561a5f6c..09c9a17464 100644 --- a/cont/imageeffects/index.html +++ b/cont/imageeffects/index.html @@ -20,7 +20,7 @@ Name Description border Draws a light thin border around the image lazy Lets the Name Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page."> - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/imageeffects/index.print.html b/cont/imageeffects/index.print.html index 0835e5140b..46830b2ce5 100644 --- a/cont/imageeffects/index.print.html +++ b/cont/imageeffects/index.print.html @@ -20,7 +20,7 @@ Name Description border Draws a light thin border around the image lazy Lets the Name Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page."> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/imageeffects/index.xml b/cont/imageeffects/index.xml index e0da987943..6117594cff 100644 --- a/cont/imageeffects/index.xml +++ b/cont/imageeffects/index.xml @@ -1,9 +1,9 @@ - Image Effects on Hugo Relearn Theme + Image Effects :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/imageeffects/index.html - Recent content in Image Effects on Hugo Relearn Theme + The theme supports non-standard image effects. Name Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page. Hugo en diff --git a/cont/index.html b/cont/index.html index 38c5030188..87a0a8e66d 100644 --- a/cont/index.html +++ b/cont/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/index.print.html b/cont/index.print.html index 0dc0aa180b..2169174010 100644 --- a/cont/index.print.html +++ b/cont/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/index.xml b/cont/index.xml index 75fdd58114..eb6ec3d59e 100644 --- a/cont/index.xml +++ b/cont/index.xml @@ -1,9 +1,9 @@ - Content on Hugo Relearn Theme + Content :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/index.html - Recent content in Content on Hugo Relearn Theme + Find out how to create and organize your content quickly and intuitively. Hugo en @@ -33,7 +33,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html - 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. + 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. Image Effects @@ -61,7 +61,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html - The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. + The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. \ No newline at end of file diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 1ff6d60d15..c95856c676 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/markdown/index.print.html b/cont/markdown/index.print.html index 7a28a708e0..11feb2a2b5 100644 --- a/cont/markdown/index.print.html +++ b/cont/markdown/index.print.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/markdown/index.xml b/cont/markdown/index.xml index 41fb5d69c8..226cf7f4c5 100644 --- a/cont/markdown/index.xml +++ b/cont/markdown/index.xml @@ -1,9 +1,9 @@ - Markdown Syntax on Hugo Relearn Theme + Markdown Syntax :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html - Recent content in Markdown Syntax on Hugo Relearn Theme + 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. Hugo en diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index 6e58c93396..6064abe191 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/menushortcuts/index.print.html b/cont/menushortcuts/index.print.html index 05e32a8e2b..121a92a133 100644 --- a/cont/menushortcuts/index.print.html +++ b/cont/menushortcuts/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/menushortcuts/index.xml b/cont/menushortcuts/index.xml index a696728455..ab48b1a864 100644 --- a/cont/menushortcuts/index.xml +++ b/cont/menushortcuts/index.xml @@ -1,9 +1,9 @@ - Menu extra shortcuts on Hugo Relearn Theme + Menu extra shortcuts :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/menushortcuts/index.html - Recent content in Menu extra shortcuts on Hugo Relearn Theme + You can define additional menu entries or shortcuts in the navigation menu without any link to content. Hugo en diff --git a/cont/pages/index.html b/cont/pages/index.html index e971888596..5961258471 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/pages/index.print.html b/cont/pages/index.print.html index 859e18dd15..31e537e76d 100644 --- a/cont/pages/index.print.html +++ b/cont/pages/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/index.xml b/cont/pages/index.xml index 1e5fc53be0..64f975e2c5 100644 --- a/cont/pages/index.xml +++ b/cont/pages/index.xml @@ -1,9 +1,9 @@ - Pages organization on Hugo Relearn Theme + Pages organization :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/pages/index.html - Recent content in Pages organization on Hugo Relearn Theme + In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site. Hugo en diff --git a/cont/taxonomy/index.html b/cont/taxonomy/index.html index 9210c4b16d..4da03e532a 100644 --- a/cont/taxonomy/index.html +++ b/cont/taxonomy/index.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/taxonomy/index.print.html b/cont/taxonomy/index.print.html index 0daa45bdfb..2a4fe65715 100644 --- a/cont/taxonomy/index.print.html +++ b/cont/taxonomy/index.print.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/taxonomy/index.xml b/cont/taxonomy/index.xml index 9e7ac78eb4..8757e6968b 100644 --- a/cont/taxonomy/index.xml +++ b/cont/taxonomy/index.xml @@ -1,9 +1,9 @@ - Taxonomy on Hugo Relearn Theme + Taxonomy :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html - Recent content in Taxonomy on Hugo Relearn Theme + The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. Hugo en diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 8c10ab52b5..9b85709125 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/contributing/index.print.html b/dev/contributing/index.print.html index 0cf13a57e9..c86eec742c 100644 --- a/dev/contributing/index.print.html +++ b/dev/contributing/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/contributing/index.xml b/dev/contributing/index.xml index 8e17839ba7..a42e6e40d3 100644 --- a/dev/contributing/index.xml +++ b/dev/contributing/index.xml @@ -1,9 +1,9 @@ - Contributing on Hugo Relearn Theme + Contributing :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/dev/contributing/index.html - Recent content in Contributing on Hugo Relearn Theme + What to know if you want to contribute Hugo en diff --git a/dev/index.html b/dev/index.html index 1bbf230479..07eb779872 100644 --- a/dev/index.html +++ b/dev/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/index.print.html b/dev/index.print.html index 83b27e2bfe..41a57554e7 100644 --- a/dev/index.print.html +++ b/dev/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/index.xml b/dev/index.xml index f9c12ec426..401701ebb8 100644 --- a/dev/index.xml +++ b/dev/index.xml @@ -1,9 +1,9 @@ - Development on Hugo Relearn Theme + Development :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/dev/index.html - Recent content in Development on Hugo Relearn Theme + This chapter contains information only needed for development and maintaining the theme. Hugo en @@ -12,21 +12,21 @@ https://mcshelby.github.io/hugo-theme-relearn/dev/contributing/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/dev/contributing/index.html - Code Quality A new release can happen at any time from the main branch of the GitHub project without further acknowledgment. + What to know if you want to contribute Maintaining https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html - Semver This project tries to follow the semver policy - although not followed 100% in the past. + What to know as a maintainer Screenshots https://mcshelby.github.io/hugo-theme-relearn/dev/screenshots/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/dev/screenshots/index.html - Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings + Recipe to create various documentation screenshots \ No newline at end of file diff --git a/dev/maintaining/index.html b/dev/maintaining/index.html index 817dd9bd24..79c5d8ff3e 100644 --- a/dev/maintaining/index.html +++ b/dev/maintaining/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/maintaining/index.print.html b/dev/maintaining/index.print.html index 0acb945daa..4717d9b011 100644 --- a/dev/maintaining/index.print.html +++ b/dev/maintaining/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/maintaining/index.xml b/dev/maintaining/index.xml index 3cfb5f1d6f..7dfce183c7 100644 --- a/dev/maintaining/index.xml +++ b/dev/maintaining/index.xml @@ -1,9 +1,9 @@ - Maintaining on Hugo Relearn Theme + Maintaining :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html - Recent content in Maintaining on Hugo Relearn Theme + What to know as a maintainer Hugo en diff --git a/dev/screenshots/index.html b/dev/screenshots/index.html index 823dcbc0e6..94a33a4796 100644 --- a/dev/screenshots/index.html +++ b/dev/screenshots/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/screenshots/index.print.html b/dev/screenshots/index.print.html index 9b354613e7..1f3367883b 100644 --- a/dev/screenshots/index.print.html +++ b/dev/screenshots/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/screenshots/index.xml b/dev/screenshots/index.xml index 6eba7048e1..8a14c5aab4 100644 --- a/dev/screenshots/index.xml +++ b/dev/screenshots/index.xml @@ -1,9 +1,9 @@ - Screenshots on Hugo Relearn Theme + Screenshots :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/dev/screenshots/index.html - Recent content in Screenshots on Hugo Relearn Theme + Recipe to create various documentation screenshots Hugo en diff --git a/index.html b/index.html index 3739b377cb..7b644570a6 100644 --- a/index.html +++ b/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/index.print.html b/index.print.html index 514b6f6ce8..1f6d4104f7 100644 --- a/index.print.html +++ b/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - + - - + + - + diff --git a/index.search.js b/index.search.js index 6dd47440f5..33a239cc38 100644 --- a/index.search.js +++ b/index.search.js @@ -1,16 +1,16 @@ var relearn_search_index = [ { "breadcrumb": "", - "content": "Discover what this Hugo theme is all about and the core-concepts behind it.\n", + "content": "Discover what this Hugo theme is all about and the core-concepts behind it.", "description": "Discover what this Hugo theme is all about and the core-concepts behind it.", - "tags": null, + "tags": [], "title": "Basics", "uri": "/hugo-theme-relearn/basics/index.html" }, { "breadcrumb": "Shortcodes \u003e Children", - "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", + "content": "This is a plain demo child page.", + "description": "This is a plain page test, and the beginning of a YAML multiline description...", "tags": [ "Children" ], @@ -19,17 +19,17 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "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”\nCreate your project 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 great documentation for beginners.\nHugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eThe Relearn theme provides archetypes to help you create this kind of pages.\n", + "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”\nCreate your project 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 great documentation for beginners.\nHugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eThe Relearn theme provides archetypes to help you create this kind of pages.", "description": "In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.", - "tags": null, + "tags": [], "title": "Pages organization", "uri": "/hugo-theme-relearn/cont/pages/index.html" }, { "breadcrumb": "", - "content": "Find out how to create and organize your content quickly and intuitively.\n", + "content": "Find out how to create and organize your content quickly and intuitively.", "description": "Find out how to create and organize your content quickly and intuitively.", - "tags": null, + "tags": [], "title": "Content", "uri": "/hugo-theme-relearn/cont/index.html" }, @@ -37,46 +37,46 @@ var relearn_search_index = [ "breadcrumb": "Content", "content": "Each Hugo page has to define a frontmatter.\nAll Frontmatter Options The values reflect example options. The defaults can be taken from the annotated example below.\n​ toml yaml json +++ LastModifierDisplayName = '' LastModifierEmail = '' alwaysopen = '' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' description = '' disableBreadcrumb = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableToc = false editURL = '' headingPost = '' headingPre = '' hidden = false highlightWrap = true images = ['images/hero.png'] mathJaxInitialize = '{}' menuPost = '' menuPre = '' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' title = 'Example Page' [imageEffects] border = true lazy = true lightbox = true shadow = false +++ --- LastModifierDisplayName: \"\" LastModifierEmail: \"\" alwaysopen: \"\" collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" description: \"\" disableBreadcrumb: false disableMathJax: true disableMermaid: true disableNextPrev: false disableOpenapi: true disableToc: false editURL: \"\" headingPost: \"\" headingPre: \"\" hidden: false highlightWrap: true imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png mathJaxInitialize: '{}' menuPost: \"\" menuPre: \"\" mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true ordersectionsby: weight title: Example Page --- { \"LastModifierDisplayName\": \"\", \"LastModifierEmail\": \"\", \"alwaysopen\": \"\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"description\": \"\", \"disableBreadcrumb\": false, \"disableMathJax\": true, \"disableMermaid\": true, \"disableNextPrev\": false, \"disableOpenapi\": true, \"disableToc\": false, \"editURL\": \"\", \"headingPost\": \"\", \"headingPre\": \"\", \"hidden\": false, \"highlightWrap\": true, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"mathJaxInitialize\": \"{}\", \"menuPost\": \"\", \"menuPre\": \"\", \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"ordersectionsby\": \"weight\", \"title\": \"Example Page\" } Annotated Frontmatter Options ​ toml +++ # If an option value is said to be not set, you can achieve the same behavior # by giving it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes as well. # The social media image of your page. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # If not set, the set value of your site's hugo.toml is used. images = [ \"images/hero.png\" ] # The title of your page. # Default: not set # A page without a title is treated as a hidden page. title = \"Example Page\" # The description of your page. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # If not set, the set value of your site's hugo.toml is used for the html # meta tag, social media meta information for the opengraph protocol and # twitter cards. description = \"\" ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # If not set, the set value of your site's hugo.toml is used. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The value can contain the macro # `${FilePath}` which will be replaced by the file path of your displayed page. # If not set, the set value of your site's hugo.toml is used. If the global # parameter is given but you want to hide the button for the displayed page, # you can set the value to an empty string. If instead of hiding you want to have # an disabled button, you can set the value to a string containing just spaces. # This is useful if you want to give the opportunity for people to create merge # request for your content. editURL = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu appearance. # Prefix for the title in main menu. # Default: not set # The title of the page in the menu will be prefixed by this HTML content. menuPre = \"\" # Suffix for the title in main menu. # Default: not set # The title of the page in the menu will be suffixed by this HTML content. menuPost = \"\" # The order of main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adhering to # Hugo's default sort order). # If not set, the value of the parent menu entry is used. ordersectionsby = \"weight\" # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. If not set, the value of the parent menu entry is used. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = \"\" # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. # If not set, the set value of your site's hugo.toml is used. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value is true, the page is hidden from the menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Prefix for the title in the content area. # Default: not set # The title of the page heading will be prefixed by this HTML content. headingPre = \"\" # Suffix for the title in the content area. # Default: not set # The title of the page heading will be suffixed by this HTML content. headingPost = \"\" # Display name of the page's last editor. # Default: not set # If set, it will be displayed in the default footer. LastModifierDisplayName = \"\" # Email address of the page's last editor. # Default: not set # If set together with LastModifierDisplayName, it will be displayed in the # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # If not set, the set value of your site's hugo.toml is used or given as a # parameter to individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effect values default to the values of your site's hugo.toml and can be # overridden through URL parameter given to the image. See the documentation for # details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # If not set, the set value of your site's hugo.toml is used. mathJaxInitialize = \"{}\" # Only load MathJax if needed. # Default: true # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. disableMathJax = true # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # If not set, the set value of your site's hugo.toml is used or given as a # parameter to individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # If not set, the set value of your site's hugo.toml is used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only load Mermaid if needed. # Default: true # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. disableMermaid = true # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Only load OpenAPI if needed. # Default: true # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's hugo.toml is used. disableOpenapi = true # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # If not set, the set value of your site's hugo.toml is used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++ Some Detailed Examples Add Icon to a Menu Entry In the page frontmatter, add a menuPre param to insert any HTML code before the menu label. The example below uses the GitHub icon.\n​ toml yaml json +++ menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" title = 'GitHub repo' +++ --- menuPre: '\u003ci class=''fab fa-github''\u003e\u003c/i\u003e ' title: GitHub repo --- { \"menuPre\": \"\\u003ci class='fab fa-github'\\u003e\\u003c/i\\u003e \", \"title\": \"GitHub repo\" } 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​ toml yaml json +++ title = 'My page' weight = 5 +++ --- title: My page weight: 5 --- { \"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.\nBut a page’s title has to be descriptive on its own while the menu is a hierarchy. Hugo adds the linkTitle parameter for that purpose:\nFor example (for a page named content/install/linux.md):\n​ toml yaml json +++ linkTitle = 'Linux' title = 'Install on Linux' +++ --- linkTitle: Linux title: Install on Linux --- { \"linkTitle\": \"Linux\", \"title\": \"Install on 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:\nall 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 recursively all remaining entries are not shown You can see this feature in action on the example page for children shortcode and its children pages.\nDisable Section Pages You may want to structure your pages in a hierarchical way but don’t want to generate pages for those sections? The theme got you covered.\nTo stay with the initial example: Suppose you want level-one appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.\nFor this, open content/level-one/_index.md and add the following frontmatter\n​ toml yaml json +++ collapsibleMenu = true [_build] render = 'never' +++ --- _build: render: never collapsibleMenu: true --- { \"_build\": { \"render\": \"never\" }, \"collapsibleMenu\": true } ", "description": "Each Hugo page has to define a frontmatter.\nAll Frontmatter Options The values reflect example options.", - "tags": null, + "tags": [], "title": "Frontmatter", "uri": "/hugo-theme-relearn/cont/frontmatter/index.html" }, { "breadcrumb": "Basics", - "content": "This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the history page.\n0.121.0 The minimum required Hugo version.\nBreaking A change that requires action by you after upgrading to assure the site is still functional.\nChange A change in default behavior that may requires action by you if you want to revert it.\nNew Marks new behavior you might find interesting or comes configurable.\n6.0.0.beta (XXXX-XX-XX) Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.\nThis was necessary to avoid permission errors on build if running in certain Unix configurations.\nIn addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.\nSay, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:\n--CODE-theme: monokai; Breaking The parameter description in your hugo.toml will now be ignored.\nWith the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.\nFor migration, move the description parameter of your hugo.toml into the frontmatter section of your home page.\nBreaking Search support for the json outputformat deprecated in 5.4.0 was removed.\nChange it to search for the homepage in your hugo.toml. See the docs for detailed configuration.\nBreaking The frontmatter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.\nYou may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.\nChange The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.\nPreviously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.\nNew The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Math is now usable without enclosing it in a shortcode or codefence by using Hugo’s passthrough configuration.\nNew Translation into Romanian.\n5.27.0 (2024-04-07) 0.121.0 This release requires a newer Hugo version.\nChange If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.\nChange The dependency loader was made more versatile.\nThe configuration in your hugo.toml does not require the location parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don’t need to change anything, yet.\nWith the new mechanism, your dependency loader now receives an additional location parameter instead that you can query to inject your dependencies in the desired location.\nBy that you can now call the dependency mechanism in your own overriden partials by giving it a distinct location parameter. In addition your injected files can now be spread to multiple locations which wasn’t previously possible.\nNew Additional styling was added for the native HTML elements \u003cmark\u003e and \u003ckbd\u003e. To use them you must allow the usage of HTML in your hugo.toml. The Markdown documentation was enhanced for this.\nNew You now can scroll forward and backward through all headings of a page by using ALT 🡑 and ALT 🡓. This also works for the PRINT output format.\nNew The breadcrumbs used in the topbar, search results and the taxonomy term lists are now using the pages frontmatter linktitle instead of title if set.\n5.26.0 (2024-03-18) New The lazy loading of images is now configurable by using the new lazy image effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.\nNew It is now possible to adjust the max width of the main area, eg. in case you want to use the full page width for your content.\nNew Images and Codefences are now respecting Hugo’s Markdown attributes.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for block diagrams.\nNew This release fixes a long outstanding bug where the page wasn’t repositioning correctly when going forward or backward in your browser history.\n5.25.0 (2024-02-29) Change This release deprecates the attachments shortcode in favor of the new the resources shortcode.\nIf you are using Hugo below 0.123.0, you don’t need to change anything as the old shortcode still works (but may generate warnings).\nAnyways, users are strongly advised to migrate as the attachments shortcode will not receive support anymore. Migration instructions are listed on the attachments shortcode page.\nChange If you run Hugo with GitInfo configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the content-footer.html partial.\n5.24.0 (2024-02-28) 0.112.4 This release requires a newer Hugo version.\nChange The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.\nChange The frontmatter option menuTitle is now deprecated in favor for Hugo’s own linkTitle. You don’t need to change anything as the old menuTitle option is still supported.\nChange The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlighting in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.\nNew If the theme can not resolve a link to a page or image, you can now generate warnings or errors during build by setting link.errorlevel or image.errorlevel to either warning or error in your hugo.toml respectively. By default this condition is silently ignored and the link is written as-is.\nPlease note that a page link will generate false negatives if uglyURLs=true and it references an ordinary page before 0.123.0.\nPlease note that an image link will generate false negatives if the file resides in your static directory.\nNew You now can configure additional options for every theme variant in your hugo.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\nNew New partial for defining the heading. See documentation for further reading.\nNew Support for Hugo’s built-in figure shortcode.\nNew On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.\nNew In additiion to the existing menu width customization, it is now also possible to set the width of the menu flyout for small screen sizes with the --MENU-WIDTH-S CSS property.\nNew Improvements for accessibility when tabbing through the page for images, links and tab handles.\nNew The editURL config parameter is now overwritable in your pages frontmatter. In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable ${FilePath} in your URL by the pages file path. You don’t need to change anything in your existing configuration as the old way without the replacement variable still works.\nNew The themes config and frontmatter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.\nNew Restored compatibility with Hugo versions 0.121.0 or higher for the highlight shortcode. This does not change the minimum required Hugo version.\nNew Restored compatibility with Hugo versions 0.123.0 or higher for theme specific output formats and handling of taxonomy and term titles. This does not change the minimum required Hugo version.\n5.23.0 (2023-11-03) Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.\nChange your previous setting from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Hugo { \"params\": { \"author\": \"Hugo\" } } to\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your hugo.toml by adding disableTermBreadcrumbs=true.\nNew Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.\nNew It is now possible to print custom taxonomies anywhere in your page. See the docs.\nNew It is now possible to adjust the menu width for your whole site. See the docs.\nNew This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.\nNew This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).\nNew The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.\nNew This release adds portable Markdown links.\nPreviously it was not possible to use pure Markdown links in a configuration independent way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.\nYou could work around this by using the relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results in non-portable Markdown.\nNow it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independent of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.\nThe following types of linking are supported:\nlink description [generator](en/basics/generator) absolute from your project root (multilang) [generator](/en/basics/generator) absolute from your project root (multilang) [generator](basics/generator) absolute from your current language root [generator](/basics/generator) absolute from your current language root [generator](./../generator) relative from the current page [generator](../generator) relative from the current page 5.22.0 (2023-10-02) Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.\nIf you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.\nChange You can now have structural sections in the hierarchical menu without generating a page for it.\nThis can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.\nThis feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.\nIn this case it is advised to remove the title from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.\nNew It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s frontmatter.\nNew If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.\nNew It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.\nNew The output of the dedicated search page now displays the result’s breadcrumb.\nNew Table rows now change their background color on every even row.\nNew Translation into Swahili. This language is not supported for search.\n5.21.0 (2023-09-18) Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial.\nNew This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.\nNew The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1.\n5.20.0 (2023-08-26) Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.\nWith this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light by switching the syntaxhighlighting inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.\nAdditionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.\nIf you dislike this change, you can revert this in your theme variants CSS by adding\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.\nThose borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor existing variants nothing has changed visually.\nNew The default values for the image effects are now configurable for your whole site via hugo.toml or for each page through frontmatter.\nNew This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.\nNew Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version.\n5.19.0 (2023-08-12) New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using codefences and makes it much easier to write nicer code samples.\nNew The theme has added two new color variants zen-light and zen-dark. Check it out!\nNew The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.\nNew The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).\nNew Translation into Hungarian.\n5.18.0 (2023-07-27) Change The theme adds additional warnings for deprecated or now unsupported features.\nChange There are visual improvements in displaying text links in your content as well as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.\nNew Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.\nNew The siteparam shortcode is now capable in displaying nested params as well as supporting text formatting.\n5.17.0 (2023-06-22) Change The default behavior for the copy-to-clipboard feature for code blocks has changed.\nThe copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.\nIf you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your hugo.toml.\nNew Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.\nNew The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.\nIn addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.\n5.16.0 (2023-06-10) Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.\nDEPRECATION warnings mark features that still work but may be removed in the future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange The 404 error page was revamped. Hopefully you will not see this very often.\nNew The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.\nThe visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.\nAdditionally the name parameter was renamed to title but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.\nNew The theme now optionally supports separate favicons for light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.\nThe attachments shortcode has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo \u003c 0.112.0 for now.\nIt is planned to refactor the attchments shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.\nChange The tabs shortcode has changed behavior if you haven’t set the groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.\nNew The already known tabshas a new friend the tab shortcode to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.\nAdditionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.\nNew Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page.\n5.14.0 (2023-05-20) New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.\nHugo’s default taxonmies tags and categories are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your hugo.toml.\nNew To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.\nThis came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.\nSo how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?\nHide tags above title: Overwrite content-header.html with an empty file. Show tags between title and content: Overwrite heading-post.html and add {{ partial \"tags.html\" . }} to it. Show tags below content: Overwrite content-footer.html and add {{ partial \"tags.html\" . }} to it. New The new parameter breadcrumbSeparator is now available in your hugo.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.\n5.13.0 (2023-05-17) Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.\nAdditionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI.\n5.12.0 (2023-05-04) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Support for the great VSCode Front Matter extension which provides on-premise CMS capabilties to Hugo.\nThe theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the pirate translation. This feature is not available in Internet Explorer 11.\nNew The scrollbars are now colored according to their variant color scheme to better fit into the visuals.\n5.11.0 (2023-02-07) Change The theme removed the popular jQuery library from its distribution.\nIn case you made changes to the theme that are depending on this library you can place a copy of jQuery into your static/js directory and load it from your own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.\nThe default setting of on, in effect since 1.1.0, changed back to off as there was interference with scrolling on mobile and big pages.\nChange The theme is now capable to visually adapt to your OS’s light/dark mode setting.\nThis is also the new default setting if you haven’t configured themeVariant in your hugo.toml.\nAdditionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.\nThis is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nChange The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.\nThis also changed the lightbox effects parameter from featherlight=false to lightbox=false. Nevertheless you don’t need to change anything as the old name will be used as a fallback.\nChange In the effort to comply with WCAG standards, the implementation of the expand shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Translation into Czech. This language is not supported for search.\nNew GitHub releases are also now tagged for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) release making it easier for you to pin the theme to a certain version.\n5.10.0 (2023-01-25) New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.\nAdditionally the --ACCENT-color brand color introduced in version 5.8.0 is now supported with these shortcodes.\n5.9.0 (2022-12-23) Breaking With this version it is now possible to not only have sections on the first menu level but also pages.\nIt was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu as well.\nTo get rid of this undesired behavior you have two choices:\nMake the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store the page file for below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md). Don’t give this page a title as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change The required folder name for the attachments shortcode was changed for leaf bundles.\nPreviously, the attachments for leaf bundles in non-multilang setups were required to be in a files subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a index.files directory. Although the old files directory is now deprecated, if both directories are present, only the old files directory will be used for compatibility.\nChange Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.\nYou can revert back to the old behavior by defining externalLinkTarget=\"_self\" in the params section of your hugo.toml.\nNew The theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.\nNew The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.\nNew The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.\nNew A new color --ACCENT-color was introduced which is used for highlighting search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old yellow color is still used as default.\n5.7.0 (2022-11-29) Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead.\nNew The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.\nNew The search now supports the Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.\nTo activate this feature, you need to configure it in your hugo.toml as a new outputformat searchpage for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.\nYou can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.\nNew Keyboard handling for the TOC and search was improved.\nPressing CTRL+ALT+t now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the TAB key.\nThe search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus the cursor inside of the search box so you can immediately start your search by typing.\nNew You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.\nTo configure this in your hugo.toml make sure to set Hugo’s disableHugoGeneratorInject=true and also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.\nNew Creation of your project gets a little bit faster with this release.\nThis addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).\n5.5.0 (2022-11-06) Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.\nFor that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.\nIf you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML img URLs manually to the respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change With the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.\nPlease note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your hugo.toml from json to search. The now deprecated json outputformat still works as before, so there is no need to reconfigure your installation if it is only served from http:// or https://.\nChange The button shortcode has a new parameter target to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.\nNew The math shortcode and mermaid shortcode now also support the align parameter if codefence syntax is used.\nNew Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.\nNew Translation into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11).\nNew Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.\nNew Printing for the swagger shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true in your hugo.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Hugo version.\nChange Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.\nYou can revert this behavior by overwriting the print output format setting in your hugo.tomlto:\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalinkable = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalinkable: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } } 5.0.0 (2022-07-05) Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.\nYour existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:\nfor your home page, add the frontmatter parameter archetype = \"home\" and remove the leading heading\nfor all files containing the deprecated frontmatter parameter chapter = true, replace it with archetype = \"chapter\" and remove the leading headings\nChange The frontmatter options pre / post were renamed to menuPre / menuPost. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.\nNew Adding new partials heading-pre.html / heading-post.html and according frontmatter options headingPre / headingPost to modify the way your page`s main heading gets styled.\nNew The new shortcode math is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.\n4.2.0 (2022-06-23) Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.\nIf you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.\nChange Previously, if the tabs shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.\nChange The landingPageURL was removed from hugo.toml. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s homepage. If you want to support a different link, overwrite the logo.html partial.\nNew All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.\n4.1.0 (2022-06-12) New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page. 4.0.0 (2022-06-05) Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.\nBreaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove --MAIN-ANCHOR-color instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from --MAIN-LINK-color and --MAIN-ANCHOR-HOVER-color respectively.\nNew All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.\nThis applies to expand, include, notice and siteparam.\nNew The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.\nNew New colors --PRIMARY-color and --SECONDARY-color were added to provide easier modification of your custom style. Shortcodes with a color style can now have primary or secondary as additional values.\nThese two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.\nNew Translation into Polish. This language is not supported for search.\nNew The documentation for all shortcodes were revised.\n3.4.0 (2022-04-03) Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript.\nNew If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.\nNew You can activate print support in your hugo.toml to add the capability to print whole chapters or even the complete site.\nNew Translation into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.\nNew The new shortcode swagger is available to include a UI for REST OpenAPI specifications. See the documentation for available features. This feature will not work with Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Hugo version.\nChange In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.\nThe option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set disableMermaid=false in your frontmatter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.\nNew Additional color variant variable --MERMAID-theme to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.\n3.1.0 (2022-03-15) New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons. 3.0.0 (2022-02-22) Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.\nThis change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and Clear history functionality).\nBreaking We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.\nThis change will only affect your installation if you’ve not set the themeVariant parameter in your hugo.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your hugo.toml.\nNote, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove --MENU-SEARCH-BOX-ICONS-color and introduced --MENU-SEARCH-color instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color to --MENU-SEARCH-BORDER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew With this release you are now capable to define your own dark mode variants.\nTo make this possible, we have introduced a lot more color variables you can use in your color variants. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.\nTo see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.\nNew To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.\nNew You can now configure multiple color variants in your hugo.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.\n2.9.0 (2021-11-19) Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.\nIn a standard compliant 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:\nType 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 Hugo’s 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 Hugo’s implementation.\nIn the best case your usage of the old implementation is already standard compliant 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 foundIn this case, you must apply one of two options:\nStart up a text editor with regular expression support for search and replace. Search for (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" and replace it by $1$2\" in all *.md files. This is the recommended choice.\nCopy 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.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes the font Novacento/Novecento. 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.\nNew 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.\nNew You can hide the table of contents menu for the whole site by setting the disableToc option in your hugo.toml. For an example see the example configuration.\n2.7.0 (2021-10-24) New Optional second parameter for notice shortcode to set title in box header. 2.6.0 (2021-10-21) New Your site can now be served from a subfolder if you set baseURL in your hugo.toml. See the documentation for a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style. 2.4.0 (2021-10-07) 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.\nNew Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your hugo.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your hugo.toml. Please see further documentation for possible values and default behavior.\nNew New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\nNew Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Hugo version.\nNew Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.\n2.2.0 (2021-09-09) 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 hugo.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Hugo version.\nChange In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search.\nNew Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your hugo.toml.\nNew If a search term is found in an expand shortcode, the expand will be opened.\nNew The menu will scroll the active item into view on load.\n2.0.0 (2021-08-28) Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation\nChange In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.\nChange 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.\nChange If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\nChange A page without a title will be treated as hidden=true.\nNew You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\nNew New partials for defining pre/post content for menu items and the content. See documentation for further reading.\nNew Shortcode children with new parameter containerstyle.\nNew New shortcode include to include arbitrary file content into a page.\n1.2.0 (2021-07-26) New Shortcode expand with new parameter to open on page load. 1.1.0 (2021-07-02) Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet.\nNew Mermaid config options can be set in hugo.toml.\n1.0.0 (2021-07-01) 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01.\nNew Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.\n", - "description": "This document shows you what\u0026rsquo;s new in the latest release and flags it with one of the following badges.", - "tags": null, + "content": "This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the history page.\n0.121.0 The minimum required Hugo version.\nBreaking A change that requires action by you after upgrading to assure the site is still functional.\nChange A change in default behavior that may requires action by you if you want to revert it.\nNew Marks new behavior you might find interesting or comes configurable.\n6.0.0.beta (XXXX-XX-XX) Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.\nThis was necessary to avoid permission errors on build if running in certain Unix configurations.\nIn addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.\nSay, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:\n--CODE-theme: monokai; Breaking The parameter description in your hugo.toml will now be ignored.\nWith the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.\nFor migration, move the description parameter of your hugo.toml into the frontmatter section of your home page.\nBreaking Search support for the json outputformat deprecated in 5.4.0 was removed.\nChange it to search for the homepage in your hugo.toml. See the docs for detailed configuration.\nBreaking The frontmatter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.\nYou may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.\nChange The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.\nPreviously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.\nNew The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.\nNew Math is now usable without enclosing it in a shortcode or codefence by using Hugo’s passthrough configuration.\nNew Translation into Romanian.\n5.27.0 (2024-04-07) 0.121.0 This release requires a newer Hugo version.\nChange If the theme is configured to generate warnings or errors during build by setting image.errorlevel to either warning or error in your hugo.toml, it will now also generate output if a link fragment is not found in the target page.\nChange The dependency loader was made more versatile.\nThe configuration in your hugo.toml does not require the location parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don’t need to change anything, yet.\nWith the new mechanism, your dependency loader now receives an additional location parameter instead that you can query to inject your dependencies in the desired location.\nBy that you can now call the dependency mechanism in your own overriden partials by giving it a distinct location parameter. In addition your injected files can now be spread to multiple locations which wasn’t previously possible.\nNew Additional styling was added for the native HTML elements \u003cmark\u003e and \u003ckbd\u003e. To use them you must allow the usage of HTML in your hugo.toml. The Markdown documentation was enhanced for this.\nNew You now can scroll forward and backward through all headings of a page by using ALT 🡑 and ALT 🡓. This also works for the PRINT output format.\nNew The breadcrumbs used in the topbar, search results and the taxonomy term lists are now using the pages frontmatter linktitle instead of title if set.\n5.26.0 (2024-03-18) New The lazy loading of images is now configurable by using the new lazy image effect. The default value hasn’t changed in comparison to older versions, you don’t need to change anything.\nNew It is now possible to adjust the max width of the main area, eg. in case you want to use the full page width for your content.\nNew Images and Codefences are now respecting Hugo’s Markdown attributes.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for block diagrams.\nNew This release fixes a long outstanding bug where the page wasn’t repositioning correctly when going forward or backward in your browser history.\n5.25.0 (2024-02-29) Change This release deprecates the attachments shortcode in favor of the new the resources shortcode.\nIf you are using Hugo below 0.123.0, you don’t need to change anything as the old shortcode still works (but may generate warnings).\nAnyways, users are strongly advised to migrate as the attachments shortcode will not receive support anymore. Migration instructions are listed on the attachments shortcode page.\nChange If you run Hugo with GitInfo configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the content-footer.html partial.\n5.24.0 (2024-02-28) 0.112.4 This release requires a newer Hugo version.\nChange The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.\nChange The frontmatter option menuTitle is now deprecated in favor for Hugo’s own linkTitle. You don’t need to change anything as the old menuTitle option is still supported.\nChange The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlighting in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.\nNew If the theme can not resolve a link to a page or image, you can now generate warnings or errors during build by setting link.errorlevel or image.errorlevel to either warning or error in your hugo.toml respectively. By default this condition is silently ignored and the link is written as-is.\nPlease note that a page link will generate false negatives if uglyURLs=true and it references an ordinary page before 0.123.0.\nPlease note that an image link will generate false negatives if the file resides in your static directory.\nNew You now can configure additional options for every theme variant in your hugo.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\nNew New partial for defining the heading. See documentation for further reading.\nNew Support for Hugo’s built-in figure shortcode.\nNew On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.\nNew In additiion to the existing menu width customization, it is now also possible to set the width of the menu flyout for small screen sizes with the --MENU-WIDTH-S CSS property.\nNew Improvements for accessibility when tabbing through the page for images, links and tab handles.\nNew The editURL config parameter is now overwritable in your pages frontmatter. In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable ${FilePath} in your URL by the pages file path. You don’t need to change anything in your existing configuration as the old way without the replacement variable still works.\nNew The themes config and frontmatter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.\nNew Restored compatibility with Hugo versions 0.121.0 or higher for the highlight shortcode. This does not change the minimum required Hugo version.\nNew Restored compatibility with Hugo versions 0.123.0 or higher for theme specific output formats and handling of taxonomy and term titles. This does not change the minimum required Hugo version.\n5.23.0 (2023-11-03) Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.\nChange your previous setting from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Hugo { \"params\": { \"author\": \"Hugo\" } } to\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your hugo.toml by adding disableTermBreadcrumbs=true.\nNew Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.\nNew It is now possible to print custom taxonomies anywhere in your page. See the docs.\nNew It is now possible to adjust the menu width for your whole site. See the docs.\nNew This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.\nNew This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).\nNew The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.\nNew This release adds portable Markdown links.\nPreviously it was not possible to use pure Markdown links in a configuration independent way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.\nYou could work around this by using the relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results in non-portable Markdown.\nNow it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independent of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.\nThe following types of linking are supported:\nlink description [generator](en/basics/generator) absolute from your project root (multilang) [generator](/en/basics/generator) absolute from your project root (multilang) [generator](basics/generator) absolute from your current language root [generator](/basics/generator) absolute from your current language root [generator](./../generator) relative from the current page [generator](../generator) relative from the current page 5.22.0 (2023-10-02) Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.\nIf you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.\nChange You can now have structural sections in the hierarchical menu without generating a page for it.\nThis can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.\nThis feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.\nIn this case it is advised to remove the title from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.\nNew It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s frontmatter.\nNew If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.\nNew It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.\nNew The output of the dedicated search page now displays the result’s breadcrumb.\nNew Table rows now change their background color on every even row.\nNew Translation into Swahili. This language is not supported for search.\n5.21.0 (2023-09-18) Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial.\nNew This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.\nNew The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1.\n5.20.0 (2023-08-26) Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.\nWith this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light by switching the syntaxhighlighting inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.\nAdditionally, the syntaxhighlighting inside of openapi for printing was switched to a light scheme for all theme variants.\nIf you dislike this change, you can revert this in your theme variants CSS by adding\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.\nThose borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor existing variants nothing has changed visually.\nNew The default values for the image effects are now configurable for your whole site via hugo.toml or for each page through frontmatter.\nNew This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.\nNew Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version.\n5.19.0 (2023-08-12) New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using codefences and makes it much easier to write nicer code samples.\nNew The theme has added two new color variants zen-light and zen-dark. Check it out!\nNew The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.\nNew The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).\nNew Translation into Hungarian.\n5.18.0 (2023-07-27) Change The theme adds additional warnings for deprecated or now unsupported features.\nChange There are visual improvements in displaying text links in your content as well as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.\nNew Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.\nNew The siteparam shortcode is now capable in displaying nested params as well as supporting text formatting.\n5.17.0 (2023-06-22) Change The default behavior for the copy-to-clipboard feature for code blocks has changed.\nThe copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.\nIf you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your hugo.toml.\nNew Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.\nNew The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.\nIn addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.\n5.16.0 (2023-06-10) Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documentation.\nDEPRECATION warnings mark features that still work but may be removed in the future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange The 404 error page was revamped. Hopefully you will not see this very often.\nNew The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.\nThe visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.\nAdditionally the name parameter was renamed to title but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.\nNew The theme now optionally supports separate favicons for light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.\nThe attachments shortcode has compatibility issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo \u003c 0.112.0 for now.\nIt is planned to refactor the attchments shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.\nChange The tabs shortcode has changed behavior if you haven’t set the groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.\nNew The already known tabshas a new friend the tab shortcode to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.\nAdditionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.\nNew Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page.\n5.14.0 (2023-05-20) New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.\nHugo’s default taxonmies tags and categories are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your hugo.toml.\nNew To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.\nThis came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.\nSo how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?\nHide tags above title: Overwrite content-header.html with an empty file. Show tags between title and content: Overwrite heading-post.html and add {{ partial \"tags.html\" . }} to it. Show tags below content: Overwrite content-footer.html and add {{ partial \"tags.html\" . }} to it. New The new parameter breadcrumbSeparator is now available in your hugo.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.\n5.13.0 (2023-05-17) Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.\nAdditionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI.\n5.12.0 (2023-05-04) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Support for the great VSCode Front Matter extension which provides on-premise CMS capabilties to Hugo.\nThe theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the pirate translation. This feature is not available in Internet Explorer 11.\nNew The scrollbars are now colored according to their variant color scheme to better fit into the visuals.\n5.11.0 (2023-02-07) Change The theme removed the popular jQuery library from its distribution.\nIn case you made changes to the theme that are depending on this library you can place a copy of jQuery into your static/js directory and load it from your own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.\nThe default setting of on, in effect since 1.1.0, changed back to off as there was interference with scrolling on mobile and big pages.\nChange The theme is now capable to visually adapt to your OS’s light/dark mode setting.\nThis is also the new default setting if you haven’t configured themeVariant in your hugo.toml.\nAdditionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.\nThis is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nChange The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.\nThis also changed the lightbox effects parameter from featherlight=false to lightbox=false. Nevertheless you don’t need to change anything as the old name will be used as a fallback.\nChange In the effort to comply with WCAG standards, the implementation of the expand shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Translation into Czech. This language is not supported for search.\nNew GitHub releases are also now tagged for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) release making it easier for you to pin the theme to a certain version.\n5.10.0 (2023-01-25) New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.\nAdditionally the --ACCENT-color brand color introduced in version 5.8.0 is now supported with these shortcodes.\n5.9.0 (2022-12-23) Breaking With this version it is now possible to not only have sections on the first menu level but also pages.\nIt was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu as well.\nTo get rid of this undesired behavior you have two choices:\nMake the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store the page file for below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md). Don’t give this page a title as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change The required folder name for the attachments shortcode was changed for leaf bundles.\nPreviously, the attachments for leaf bundles in non-multilang setups were required to be in a files subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a index.files directory. Although the old files directory is now deprecated, if both directories are present, only the old files directory will be used for compatibility.\nChange Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.\nYou can revert back to the old behavior by defining externalLinkTarget=\"_self\" in the params section of your hugo.toml.\nNew The theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.\nNew The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.\nNew The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.\nNew A new color --ACCENT-color was introduced which is used for highlighting search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old yellow color is still used as default.\n5.7.0 (2022-11-29) Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead.\nNew The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.\nNew The search now supports the Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.\nTo activate this feature, you need to configure it in your hugo.toml as a new outputformat searchpage for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.\nYou can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.\nNew Keyboard handling for the TOC and search was improved.\nPressing CTRL+ALT+t now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the TAB key.\nThe search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus the cursor inside of the search box so you can immediately start your search by typing.\nNew You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.\nTo configure this in your hugo.toml make sure to set Hugo’s disableHugoGeneratorInject=true and also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.\nNew Creation of your project gets a little bit faster with this release.\nThis addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).\n5.5.0 (2022-11-06) Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.\nFor that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.\nIf you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML img URLs manually to the respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change With the proper settings in your hugo.toml your page is now servable from the local file system using file:// URLs.\nPlease note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your hugo.toml from json to search. The now deprecated json outputformat still works as before, so there is no need to reconfigure your installation if it is only served from http:// or https://.\nChange The button shortcode has a new parameter target to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.\nNew The math shortcode and mermaid shortcode now also support the align parameter if codefence syntax is used.\nNew Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.\nNew Translation into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11).\nNew Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.\nNew Printing for the swagger shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true in your hugo.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Hugo version.\nChange Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.\nYou can revert this behavior by overwriting the print output format setting in your hugo.tomlto:\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalinkable = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalinkable: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } } 5.0.0 (2022-07-05) Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.\nYour existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:\nfor your home page, add the frontmatter parameter archetype = \"home\" and remove the leading heading\nfor all files containing the deprecated frontmatter parameter chapter = true, replace it with archetype = \"chapter\" and remove the leading headings\nChange The frontmatter options pre / post were renamed to menuPre / menuPost. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.\nNew Adding new partials heading-pre.html / heading-post.html and according frontmatter options headingPre / headingPost to modify the way your page`s main heading gets styled.\nNew The new shortcode math is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.\n4.2.0 (2022-06-23) Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.\nIf you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.\nChange Previously, if the tabs shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.\nChange The landingPageURL was removed from hugo.toml. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s homepage. If you want to support a different link, overwrite the logo.html partial.\nNew All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.\n4.1.0 (2022-06-12) New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page. 4.0.0 (2022-06-05) Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.\nBreaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove --MAIN-ANCHOR-color instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from --MAIN-LINK-color and --MAIN-ANCHOR-HOVER-color respectively.\nNew All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.\nThis applies to expand, include, notice and siteparam.\nNew The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.\nNew New colors --PRIMARY-color and --SECONDARY-color were added to provide easier modification of your custom style. Shortcodes with a color style can now have primary or secondary as additional values.\nThese two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.\nNew Translation into Polish. This language is not supported for search.\nNew The documentation for all shortcodes were revised.\n3.4.0 (2022-04-03) Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript.\nNew If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your hugo.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.\nNew You can activate print support in your hugo.toml to add the capability to print whole chapters or even the complete site.\nNew Translation into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.\nNew The new shortcode swagger is available to include a UI for REST OpenAPI specifications. See the documentation for available features. This feature will not work with Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Hugo version.\nChange In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.\nThe option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set disableMermaid=false in your frontmatter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.\nNew Additional color variant variable --MERMAID-theme to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.\n3.1.0 (2022-03-15) New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons. 3.0.0 (2022-02-22) Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.\nThis change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and Clear history functionality).\nBreaking We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.\nThis change will only affect your installation if you’ve not set the themeVariant parameter in your hugo.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your hugo.toml.\nNote, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove --MENU-SEARCH-BOX-ICONS-color and introduced --MENU-SEARCH-color instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color to --MENU-SEARCH-BORDER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew With this release you are now capable to define your own dark mode variants.\nTo make this possible, we have introduced a lot more color variables you can use in your color variants. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.\nTo see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.\nNew To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.\nNew You can now configure multiple color variants in your hugo.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.\n2.9.0 (2021-11-19) Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.\nIn a standard compliant 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:\nType 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 Hugo’s 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 Hugo’s implementation.\nIn the best case your usage of the old implementation is already standard compliant 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 foundIn this case, you must apply one of two options:\nStart up a text editor with regular expression support for search and replace. Search for (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" and replace it by $1$2\" in all *.md files. This is the recommended choice.\nCopy 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.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes the font Novacento/Novecento. 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.\nNew 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.\nNew You can hide the table of contents menu for the whole site by setting the disableToc option in your hugo.toml. For an example see the example configuration.\n2.7.0 (2021-10-24) New Optional second parameter for notice shortcode to set title in box header. 2.6.0 (2021-10-21) New Your site can now be served from a subfolder if you set baseURL in your hugo.toml. See the documentation for a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style. 2.4.0 (2021-10-07) 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.\nNew Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your hugo.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your hugo.toml. Please see further documentation for possible values and default behavior.\nNew New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\nNew Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Hugo version.\nNew Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.\n2.2.0 (2021-09-09) 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 hugo.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Hugo version.\nChange In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search.\nNew Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your hugo.toml.\nNew If a search term is found in an expand shortcode, the expand will be opened.\nNew The menu will scroll the active item into view on load.\n2.0.0 (2021-08-28) Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation\nChange In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.\nChange 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.\nChange If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\nChange A page without a title will be treated as hidden=true.\nNew You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\nNew New partials for defining pre/post content for menu items and the content. See documentation for further reading.\nNew Shortcode children with new parameter containerstyle.\nNew New shortcode include to include arbitrary file content into a page.\n1.2.0 (2021-07-26) New Shortcode expand with new parameter to open on page load. 1.1.0 (2021-07-02) Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet.\nNew Mermaid config options can be set in hugo.toml.\n1.0.0 (2021-07-01) 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01.\nNew Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.", + "description": "This document shows you what’s new in the latest release and flags it with one of the following badges.", + "tags": [], "title": "What's New", "uri": "/hugo-theme-relearn/basics/migration/index.html" }, { "breadcrumb": "Content", - "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. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n​ _index.md +++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter A 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 below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n​ _index.md +++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 1 +++ Lorem Ipsum. The weight number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n​ *.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Self defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n​ \u003ckind\u003e.md +++ archetype = \"\u003ckind\u003e\" +++ Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your hugo.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.\n", + "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. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n​ _index.md +++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter A 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 below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n​ _index.md +++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 1 +++ Lorem Ipsum. The weight number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n​ *.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Self defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n​ \u003ckind\u003e.md +++ archetype = \"\u003ckind\u003e\" +++ Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your hugo.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.", "description": "Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set.", - "tags": null, + "tags": [], "title": "Archetypes", "uri": "/hugo-theme-relearn/cont/archetypes/index.html" }, { "breadcrumb": "", - "content": "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.\nBadgeMarker badges to display in your text\nButtonClickable buttons\nChildrenList the child pages of a page\nExpandExpandable/collapsible sections of text\nHighlightRender code with a syntax highlighter\nIconNice icons for your page\nIncludeDisplays content from other files\nMathBeautiful math and chemical formulae\nMermaidGenerate diagrams and flowcharts from text\nNoticeDisclaimers to help you structure your page\nOpenAPIUI for your OpenAPI / Swagger specifications\nResourcesList resources contained in a page bundle\nSiteParamGet value of site params\nTabShow content in a single tab\nTabsShow content in tabbed views\n", + "content": "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.\nBadgeMarker badges to display in your text\nButtonClickable buttons\nChildrenList the child pages of a page\nExpandExpandable/collapsible sections of text\nHighlightRender code with a syntax highlighter\nIconNice icons for your page\nIncludeDisplays content from other files\nMathBeautiful math and chemical formulae\nMermaidGenerate diagrams and flowcharts from text\nNoticeDisclaimers to help you structure your page\nOpenAPIUI for your OpenAPI / Swagger specifications\nResourcesList resources contained in a page bundle\nSiteParamGet value of site params\nTabShow content in a single tab\nTabsShow content in tabbed views", "description": "Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well.", - "tags": null, + "tags": [], "title": "Shortcodes", "uri": "/hugo-theme-relearn/shortcodes/index.html" }, { "breadcrumb": "", - "content": "This chapter contains information only needed for development and maintaining the theme.\nContributingWhat to know if you want to contribute\nMaintainingWhat to know as a maintainer\nScreenshotsRecipe to create various documentation screenshots\n", + "content": "This chapter contains information only needed for development and maintaining the theme.\nContributingWhat to know if you want to contribute\nMaintainingWhat to know as a maintainer\nScreenshotsRecipe to create various documentation screenshots", "description": "This chapter contains information only needed for development and maintaining the theme.", - "tags": null, + "tags": [], "title": "Development", "uri": "/hugo-theme-relearn/dev/index.html" }, { "breadcrumb": "Content", - "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:\nMarkdown 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 HTML 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:\nThe 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\nTip Bookmark this page for easy future reference!\nStandard and Extensions If not otherwise noted, the showed examples adhere to the Commonmark standard. In addition the theme supports the following extensions:\nGFM Extension on top of standard Markdown adhering to GitHub Flavored Markdown.\nPHP Extension on top of standard Markdown adhering to PHP Markdown.\nPants Extension by John Gruber adhering to SmartyPants.\nRelearn Extension specific to this theme.\nHTML If the usage of HTML is allowed in your hugo.toml the theme supports styling for further elements not accessible using Markdown alone.\nParagraphs In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.\nAny text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHeadings A good idea is to structure your content using headings and subheadings. HTML-headings from h1 through h6 are constructed with a # for each level.\nIn Hugo you usually don’t use h1 as this is generated by your theme and you should only have one such element in a document.\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Result h1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.\nI am rendered with **bold text** Result I am rendered with bold text\nItalics You can emphasize a snippet of text with italics by enclosing it with underscores _.\nI am rendered with _italicized text_ Result I am rendered with italicized text\nStrikethrough GFM You can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nMarked Text HTML You can mark text in the predefined accent color of your stylesheet.\n\u003cmark\u003eParts\u003c/mark\u003e of this text \u003cmark\u003eare marked!\u003c/mark\u003e Result Parts of this text are marked!\nSpecial Typesetting Text Substitution Pants You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.\nDouble quotes `\"` and single quotes `'` of enclosed text are replaced by **\"double curly quotes\"** and **'single curly quotes'**. Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities. Double arrows pointing left `\u003c\u003c` or right `\u003e\u003e` are replaced by arrow **\u003c\u003c** and **\u003e\u003e** entities. Three consecutive dots `...` are replaced by an ellipsis **...** entity. Result Double quotes \" and single quotes ' of enclosed text are replaced by “double curly quotes” and ‘single curly quotes’.\nDouble dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.\nDouble arrows pointing left \u003c\u003c or right \u003e\u003e are replaced by arrow « and » entities.\nThree consecutive dots ... are replaced by an ellipsis … entity.\nKeyboard Shortcuts HTML You can use the \u003ckbd\u003e element to style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e to end your shift early. Result Press STRG ALT DEL to end your shift early.\nSub and Super Script HTML You can also use the \u003csub\u003e and \u003csup\u003e elements. For more complex stuff or if your configuration does not allow HTML, you can use the math shortcode.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nLists Unordered You can write a list of items in which the order of the items does not explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nYou may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipiscing elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered You can create a list of items in which the order of items does explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nMarkdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipiscing elit 1. Integer molestie lorem at massa 7. Facilisis in pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur 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 Tasks GFM You can add task lists resulting in checked or unchecked non-clickable items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definitions PHP Definition lists are made of terms and definitions of these terms, much like in a dictionary.\nA definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.\nIf you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible\nApple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. : An American computer company. Orange : The fruit of an evergreen tree of the genus Citrus. You can make juice out of it. : A telecommunication company. You can't make juice out of it. Result Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. An American computer company. Orange The fruit of an evergreen tree of the genus Citrus. You can make juice out of it.\nA telecommunication company. You can’t make juice out of it.\nCode Inline Code Inline snippets of code can be wrapped with backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` is marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e is marked as code.\nIndented Code Block A simple code block can be generated by indenting several lines of code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 of code line 2 of code line 3 of code Result Be impressed by my advanced code:\n// Some comments line 1 of code line 2 of code line 3 of code Fenced Code Block If you want to gain more control of your code block you can enclose your code by at least three backticks ``` a so called fence.\nGFM You can also add a language specifier directly after the opening fence, ```js, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.\nSee Code Highlighting for additional documentation.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM You can create tables 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. | Result 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. Aligned Columns Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.\n| Option | Number | Description | |-------:|:------:|:------------| | data | 1 | path to data files to supply the data that will be passed into templates. | | engine | 2 | engine to be used for processing templates. Handlebars is the default. | | ext | 3 | extension to be used for dest files. | Result Option Number Description data 1 path to data files to supply the data that will be passed into templates. engine 2 engine to be used for processing templates. Handlebars is the default. ext 3 extension to be used for dest files. Blockquotes For quoting blocks of content from another source within your document add \u003e before any text you want to quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc 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. Result Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink GFM Absolute URLs will automatically be converted into a link.\nThis is a link to https://example.com. Result This is a link to https://example.com.\nBasic Link You can explicitly define links in case you want to use non-absolute URLs or want to give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink with Tooltip For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go to example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.\nUsually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.\nFootnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.\nThat's some text with a footnote[^1] [^1]: And that's the footnote. That's some more text with a footnote.[^someid] [^someid]: Anything of interest goes here. Blue light glows blue. Result That’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar syntax to links but include a preceding exclamation mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image with Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearn This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable through your hugo.toml or frontmatter parameter.\nResizing Add query parameter 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=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combination ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add the query parameter lightbox=false to the image link to disable the lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Note If you want to wrap an image in a link and lightbox=true is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", - "description": "Let\u0026rsquo;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.", + "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:\nMarkdown 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 HTML 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:\nThe 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\nTip Bookmark this page for easy future reference!\nStandard and Extensions If not otherwise noted, the showed examples adhere to the Commonmark standard. In addition the theme supports the following extensions:\nGFM Extension on top of standard Markdown adhering to GitHub Flavored Markdown.\nPHP Extension on top of standard Markdown adhering to PHP Markdown.\nPants Extension by John Gruber adhering to SmartyPants.\nRelearn Extension specific to this theme.\nHTML If the usage of HTML is allowed in your hugo.toml the theme supports styling for further elements not accessible using Markdown alone.\nParagraphs In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.\nAny text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHeadings A good idea is to structure your content using headings and subheadings. HTML-headings from h1 through h6 are constructed with a # for each level.\nIn Hugo you usually don’t use h1 as this is generated by your theme and you should only have one such element in a document.\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Result h1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.\nI am rendered with **bold text** Result I am rendered with bold text\nItalics You can emphasize a snippet of text with italics by enclosing it with underscores _.\nI am rendered with _italicized text_ Result I am rendered with italicized text\nStrikethrough GFM You can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nMarked Text HTML You can mark text in the predefined accent color of your stylesheet.\n\u003cmark\u003eParts\u003c/mark\u003e of this text \u003cmark\u003eare marked!\u003c/mark\u003e Result Parts of this text are marked!\nSpecial Typesetting Text Substitution Pants You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.\nDouble quotes `\"` and single quotes `'` of enclosed text are replaced by **\"double curly quotes\"** and **'single curly quotes'**. Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities. Double arrows pointing left `\u003c\u003c` or right `\u003e\u003e` are replaced by arrow **\u003c\u003c** and **\u003e\u003e** entities. Three consecutive dots `...` are replaced by an ellipsis **...** entity. Result Double quotes \" and single quotes ' of enclosed text are replaced by “double curly quotes” and ‘single curly quotes’.\nDouble dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.\nDouble arrows pointing left \u003c\u003c or right \u003e\u003e are replaced by arrow « and » entities.\nThree consecutive dots ... are replaced by an ellipsis … entity.\nKeyboard Shortcuts HTML You can use the \u003ckbd\u003e element to style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e to end your shift early. Result Press STRG ALT DEL to end your shift early.\nSub and Super Script HTML You can also use the \u003csub\u003e and \u003csup\u003e elements. For more complex stuff or if your configuration does not allow HTML, you can use the math shortcode.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nLists Unordered You can write a list of items in which the order of the items does not explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nYou may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipiscing elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered You can create a list of items in which the order of items does explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nMarkdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipiscing elit 1. Integer molestie lorem at massa 7. Facilisis in pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur 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 Tasks GFM You can add task lists resulting in checked or unchecked non-clickable items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definitions PHP Definition lists are made of terms and definitions of these terms, much like in a dictionary.\nA definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.\nIf you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible\nApple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. : An American computer company. Orange : The fruit of an evergreen tree of the genus Citrus. You can make juice out of it. : A telecommunication company. You can't make juice out of it. Result Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. An American computer company. Orange The fruit of an evergreen tree of the genus Citrus. You can make juice out of it.\nA telecommunication company. You can’t make juice out of it.\nCode Inline Code Inline snippets of code can be wrapped with backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` is marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e is marked as code.\nIndented Code Block A simple code block can be generated by indenting several lines of code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 of code line 2 of code line 3 of code Result Be impressed by my advanced code:\n// Some comments line 1 of code line 2 of code line 3 of code Fenced Code Block If you want to gain more control of your code block you can enclose your code by at least three backticks ``` a so called fence.\nGFM You can also add a language specifier directly after the opening fence, ```js, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.\nSee Code Highlighting for additional documentation.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM You can create tables 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. | Result 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. Aligned Columns Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.\n| Option | Number | Description | |-------:|:------:|:------------| | data | 1 | path to data files to supply the data that will be passed into templates. | | engine | 2 | engine to be used for processing templates. Handlebars is the default. | | ext | 3 | extension to be used for dest files. | Result Option Number Description data 1 path to data files to supply the data that will be passed into templates. engine 2 engine to be used for processing templates. Handlebars is the default. ext 3 extension to be used for dest files. Blockquotes For quoting blocks of content from another source within your document add \u003e before any text you want to quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc 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. Result Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink GFM Absolute URLs will automatically be converted into a link.\nThis is a link to https://example.com. Result This is a link to https://example.com.\nBasic Link You can explicitly define links in case you want to use non-absolute URLs or want to give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink with Tooltip For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go to example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.\nUsually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.\nFootnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.\nThat's some text with a footnote[^1] [^1]: And that's the footnote. That's some more text with a footnote.[^someid] [^someid]: Anything of interest goes here. Blue light glows blue. Result That’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar syntax to links but include a preceding exclamation mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image with Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearn This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable through your hugo.toml or frontmatter parameter.\nResizing Add query parameter 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=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combination ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add the query parameter lightbox=false to the image link to disable the lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Note If you want to wrap an image in a link and lightbox=true is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)", + "description": "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.", "tags": [ "Content" ], @@ -85,9 +85,9 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "The theme supports non-standard image effects.\nName Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.\nInstead, you can configure the defaults in your hugo.toml as well as overriding these default in the pages frontmatter.\nExplicitly set URL query parameter will override the defaults in effect for a page.\nWithout any settings in your hugo.toml this defaults to\nhugo. toml yaml json [params] [params.imageEffects] border = false lazy = true lightbox = true shadow = false params: imageEffects: border: false lazy: true lightbox: true shadow: false { \"params\": { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } } This can be overridden in a pages frontmatter by eg.\n​ toml yaml json +++ [imageEffects] border = true +++ --- imageEffects: border: true --- { \"imageEffects\": { \"border\": true } } Or by explicitly override settings by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) The settings applied to the above image would be\n​ toml yaml json bg-white = true border = true lazy = true lightbox = false shadow = false bg-white: true border: true lazy: true lightbox: false shadow: false { \"bg-white\": true, \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false } This ends up in the following HTML where the parameter are converted to CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" loading=\"lazy\" alt=\"Minion\" class=\"bg-white border lazy nolightbox noshadow\"\u003e Extending As you can see in the above example, the bg-white parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your hugo.toml or pages frontmatter.\nNote If no extended parameter like bg-white in the example is set on the URL, a class=\"nobg-white\" in the HTML will only be generated if a default value was set in the hugo.toml or pages frontmatter.\n", + "content": "The theme supports non-standard image effects.\nName Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.\nInstead, you can configure the defaults in your hugo.toml as well as overriding these default in the pages frontmatter.\nExplicitly set URL query parameter will override the defaults in effect for a page.\nWithout any settings in your hugo.toml this defaults to\nhugo. toml yaml json [params] [params.imageEffects] border = false lazy = true lightbox = true shadow = false params: imageEffects: border: false lazy: true lightbox: true shadow: false { \"params\": { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } } This can be overridden in a pages frontmatter by eg.\n​ toml yaml json +++ [imageEffects] border = true +++ --- imageEffects: border: true --- { \"imageEffects\": { \"border\": true } } Or by explicitly override settings by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) The settings applied to the above image would be\n​ toml yaml json bg-white = true border = true lazy = true lightbox = false shadow = false bg-white: true border: true lazy: true lightbox: false shadow: false { \"bg-white\": true, \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false } This ends up in the following HTML where the parameter are converted to CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" loading=\"lazy\" alt=\"Minion\" class=\"bg-white border lazy nolightbox noshadow\"\u003e Extending As you can see in the above example, the bg-white parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your hugo.toml or pages frontmatter.\nNote If no extended parameter like bg-white in the example is set on the URL, a class=\"nobg-white\" in the HTML will only be generated if a default value was set in the hugo.toml or pages frontmatter.", "description": "The theme supports non-standard image effects.\nName Description border Draws a light thin border around the image lazy Lets the image be lazy loaded lightbox The image will be clickable to show it enlarged shadow Draws a shadow around the image to make it appear hovered/glowing As described, you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.", - "tags": null, + "tags": [], "title": "Image Effects", "uri": "/hugo-theme-relearn/cont/imageeffects/index.html" }, @@ -95,7 +95,7 @@ var relearn_search_index = [ "breadcrumb": "Content", "content": "You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration hugo.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the current website:\nhugo. toml yaml json [menu] [[menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" url = 'showcase/' weight = 11 [[menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" url = 'https://gohugo.io/' weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = 'more/credits/' weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" url = 'tags/' weight = 40 menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases url: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits url: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags url: tags/ weight: 40 { \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"url\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Hugo Documentation\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Credits\", \"url\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas 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 overridden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n​ en.toml [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 hugo.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the current website:\nhugo. toml yaml json [languages] [languages.en] languageName = 'English' title = 'Hugo Relearn Theme' weight = 1 [languages.en.menu] [[languages.en.menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = 'showcase/' weight = 11 [[languages.en.menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" url = 'https://gohugo.io/' weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = 'more/credits/' weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = 'tags/' weight = 40 [languages.en.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" [languages.pir] languageName = 'Arrr! Pirrrates' title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 [languages.pir.menu] [[languages.pir.menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = 'showcase/' weight = 11 [[languages.pir.menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" url = 'https://gohugo.io/' weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = 'more/credits/' weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = 'tags/' weight = 40 [languages.pir.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" languages: en: languageName: English menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases pageRef: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits pageRef: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags pageRef: tags/ weight: 40 params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home title: Hugo Relearn Theme weight: 1 pir: languageName: Arrr! Pirrrates menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases pageRef: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Crrredits pageRef: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Arrr! Tags pageRef: tags/ weight: 40 params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Home title: Cap'n Hugo Relearrrn Theme weight: 1 { \"languages\": { \"en\": { \"languageName\": \"English\", \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"pageRef\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Hugo Documentation\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Credits\", \"pageRef\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"pageRef\": \"tags/\", \"weight\": 40 } ] }, \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" }, \"title\": \"Hugo Relearn Theme\", \"weight\": 1 }, \"pir\": { \"languageName\": \"Arrr! Pirrrates\", \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"pageRef\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Cap'n Hugo Documentat'n\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Crrredits\", \"pageRef\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Arrr! Tags\", \"pageRef\": \"tags/\", \"weight\": 40 } ] }, \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Arrr! Home\" }, \"title\": \"Cap'n Hugo Relearrrn Theme\", \"weight\": 1 } } } Read more about hugo menu and hugo multilingual menus\nShortcuts to pages inside of your project If you have shortcuts to pages inside of your project and you don’t want them to show up in page menu section, you have two choices:\nMake the page file for the shortcut a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md). Don’t give this page a title as this will cause it to be shown in the breadcrumbs - a thing you most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } ", "description": "You can define additional menu entries or shortcuts in the navigation menu without any link to content.", - "tags": null, + "tags": [], "title": "Menu extra shortcuts", "uri": "/hugo-theme-relearn/cont/menushortcuts/index.html" }, @@ -103,15 +103,17 @@ var relearn_search_index = [ "breadcrumb": "Content", "content": "The Relearn theme is fully compatible with Hugo multilingual mode.\nAvailable languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute! Full support for languages written right to left Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your hugo.toml file.\nFor example with current English and Piratized English website.\nNote Make sure your default language is defined as the first one in the [languages] array, as the theme needs to make assumptions on it\nhugo. toml yaml json defaultContentLanguage = 'en' [languages] [languages.en] languageName = 'English' title = 'Hugo Relearn Theme' weight = 1 [languages.pir] languageName = 'Arrr! Pirrrates' title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 defaultContentLanguage: en languages: en: languageName: English title: Hugo Relearn Theme weight: 1 pir: languageName: Arrr! Pirrrates title: Cap'n Hugo Relearrrn Theme weight: 2 { \"defaultContentLanguage\": \"en\", \"languages\": { \"en\": { \"languageName\": \"English\", \"title\": \"Hugo Relearn Theme\", \"weight\": 1 }, \"pir\": { \"languageName\": \"Arrr! Pirrrates\", \"title\": \"Cap'n Hugo Relearrrn Theme\", \"weight\": 2 } } } Then, for each new page, append the id of the language to the file.\nSingle 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 Info Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.\nTip Use slug frontmatter parameter to translate urls too.\nSearch In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.\nWarning Although the theme supports a wide variety of supported languages, the site’s search via the Lunr search library does not. You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:\nCzech Indonesian Polish Swahili Search with mixed language support In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your hugo.toml to broaden search.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] params: additionalContentLanguage: - en { \"params\": { \"additionalContentLanguage\": [ \"en\" ] } } As this is an array, you can add multiple additional languages.\nNote Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in zh-CN, you have to add just zh to this parameter.\nOverwrite translation strings Translations strings are used for common default values used in the theme (Edit 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 hugo.toml\nhugo. toml yaml json [params] disableLanguageSwitchingButton = true params: disableLanguageSwitchingButton: true { \"params\": { \"disableLanguageSwitchingButton\": true } } ", "description": "The Relearn theme is fully compatible with Hugo multilingual mode.", - "tags": null, + "tags": [], "title": "Multilingual and i18n", "uri": "/hugo-theme-relearn/cont/i18n/index.html" }, { "breadcrumb": "Content", "content": "The Relearn theme supports Hugo’s default taxonomies tag and category out of the box.\nConfiguration Just add tags and/or categories to any page. They can be given as a single string or an array of strings.\n​ toml yaml json +++ categories = ['taxonomy', 'content'] tags = 'tutorial' title = 'Taxonomy' +++ --- categories: - taxonomy - content tags: tutorial title: Taxonomy --- { \"categories\": [ \"taxonomy\", \"content\" ], \"tags\": \"tutorial\", \"title\": \"Taxonomy\" } Behavior The tags are displayed at the top of the page in alphabetical order.\nThe categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own content-footer.html partial.\nEach item is a link to a taxonomy page displaying all the articles with the given term.\nList all the tags In the hugo.toml file you can add a shortcut to display all the tags and categories\nhugo. toml yaml json [menu] [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" url = '/tags' [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = '/categories' menu: shortcuts: - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags url: /tags - name: \u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories url: /categories { \"menu\": { \"shortcuts\": [ { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"url\": \"/tags\" }, { \"name\": \"\\u003ci class='fa-fw fas fa-layer-group'\\u003e\\u003c/i\\u003e Categories\", \"url\": \"/categories\" } ] } } Customization If you define custom taxonomies and want to display a list of them somewhere on your page (often in the layouts/partials/content-footer.html) you can call a partial that does the job for you:\n{{ partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. taxonomy \u003cempty\u003e The plural name of the taxonomy to display as used in your frontmatter. class \u003cempty\u003e Additional CSS classes set on the outermost generated HTML element.\nIf set to tags you will get the visuals for displaying the tags taxonomy, otherwise it will be a simple list of links as for the categories taxonomy. style primary The style scheme used if class is tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used if class is tags. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon \u003cempty\u003e An optional Font Awesome icon name set to the left of the list. ", - "description": "The Relearn theme supports Hugo\u0026rsquo;s default taxonomies tag and category out of the box.", - "tags": "tutorial", + "description": "The Relearn theme supports Hugo’s default taxonomies tag and category out of the box.", + "tags": [ + "Tutorial" + ], "title": "Taxonomy", "uri": "/hugo-theme-relearn/cont/taxonomy/index.html" }, @@ -120,26 +122,26 @@ var relearn_search_index = [ "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" + "Children", + "Non-Hidden" ], "title": "page 1", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/index.html" }, { "breadcrumb": "Basics", - "content": "Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.\nJust download at least version 0.121.0 of the Hugo binary for your OS (Windows, Linux, Mac).\nIt’s a kind of magic\n", + "content": "Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.\nJust download at least version 0.121.0 of the Hugo binary for your OS (Windows, Linux, Mac).\nIt’s a kind of magic", "description": "Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.", - "tags": null, + "tags": [], "title": "Requirements", "uri": "/hugo-theme-relearn/basics/requirements/index.html" }, { "breadcrumb": "Basics", - "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.\nTip The following tutorial leads you through the steps of creating a first, minimal new site.\nYou don’t need to edit any files besides your hugo.toml and only need to execute the commands in the given order.\nCreate your Project Hugo provides the new command to create a new website:\nhugo new site my-new-siteAfter that change into the directory:\ncd my-new-siteEvery upcoming command will be executed from inside your new site’s root.\nInstall the Theme Downloading as Archive You can download the theme as .zip archive and extract its content into them themes/hugo-theme-relearn directory.\nAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Using Hugo’s Module System You can install the Relearn theme by following the standard documentation using Hugo’s module system:\nhugo mod init example.comAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Using Git Submodules If you plan to store your project in a git repository you can create one with:\ngit initNow add the theme as a submodule by:\ngit submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearnAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create your Home Page If you don’t create a home page, yet, the theme will generate a placeholder text with instructions on how to proceed.\nStart your journey by creating a home page:\nhugo new --kind home _index.mdThe newly created home page content/_index.md is empty and you obviously should add some meaningful content.\nCreate your First Chapter Page Chapters are meant to be top level pages that contain other child pages. They have a special layout style and often just contain the title and a brief abstract of the section.\nNow create your first chapter page with the following command:\nhugo new --kind chapter basics/_index.mdWhen opening the newly created file content/basics/_index.md, you should see the weight frontmatter with a number. This will be used to generate the subtitle of the chapter page, and should be set to a consecutive value starting at 1 for each chapter level.\nCreate your First Content Pages Then create content pages inside the previously created chapter. Here are three ways to create content in the chapter:\nhugo new basics/first-content/_index.md hugo new basics/second-content/index.md hugo new basics/third-content.mdFeel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nNote Please note that Hugo overrides the default archetype template coming with this theme when using hugo new site my-new-site. To actually see your page later, you have to remove the draft=true from the page’s frontmatter.\nTesting your Website Locally Launch your new web site by using the following command:\nhugo serveGo to http://localhost:1313 in your browser.\nYou should notice a few things:\nThe home page contains your provided text. You have the menu Basics in the sidebar. Clicking on it reveals three submenus with names equal to the title properties in the previously created content pages. While you are running hugo serve your page refreshes automatically when you change a content page. Neat! Build and Deploy your Website When your site is ready to be deployed, run the following command:\nhugoA public directory will be generated, containing all content and assets for your web site.\nIt now can be deployed to any web server by simply uploading its contents or you can check out one of Hugo’s many other deployment options.\nNote If you are storing your web site in git, commit all but the public directory.\n", + "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.\nTip The following tutorial leads you through the steps of creating a first, minimal new site.\nYou don’t need to edit any files besides your hugo.toml and only need to execute the commands in the given order.\nCreate your Project Hugo provides the new command to create a new website:\nhugo new site my-new-siteAfter that change into the directory:\ncd my-new-siteEvery upcoming command will be executed from inside your new site’s root.\nInstall the Theme Downloading as Archive You can download the theme as .zip archive and extract its content into them themes/hugo-theme-relearn directory.\nAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Using Hugo’s Module System You can install the Relearn theme by following the standard documentation using Hugo’s module system:\nhugo mod init example.comAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Using Git Submodules If you plan to store your project in a git repository you can create one with:\ngit initNow add the theme as a submodule by:\ngit submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearnAfterwards add this at the end of your hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create your Home Page If you don’t create a home page, yet, the theme will generate a placeholder text with instructions on how to proceed.\nStart your journey by creating a home page:\nhugo new --kind home _index.mdThe newly created home page content/_index.md is empty and you obviously should add some meaningful content.\nCreate your First Chapter Page Chapters are meant to be top level pages that contain other child pages. They have a special layout style and often just contain the title and a brief abstract of the section.\nNow create your first chapter page with the following command:\nhugo new --kind chapter basics/_index.mdWhen opening the newly created file content/basics/_index.md, you should see the weight frontmatter with a number. This will be used to generate the subtitle of the chapter page, and should be set to a consecutive value starting at 1 for each chapter level.\nCreate your First Content Pages Then create content pages inside the previously created chapter. Here are three ways to create content in the chapter:\nhugo new basics/first-content/_index.md hugo new basics/second-content/index.md hugo new basics/third-content.mdFeel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nNote Please note that Hugo overrides the default archetype template coming with this theme when using hugo new site my-new-site. To actually see your page later, you have to remove the draft=true from the page’s frontmatter.\nTesting your Website Locally Launch your new web site by using the following command:\nhugo serveGo to http://localhost:1313 in your browser.\nYou should notice a few things:\nThe home page contains your provided text. You have the menu Basics in the sidebar. Clicking on it reveals three submenus with names equal to the title properties in the previously created content pages. While you are running hugo serve your page refreshes automatically when you change a content page. Neat! Build and Deploy your Website When your site is ready to be deployed, run the following command:\nhugoA public directory will be generated, containing all content and assets for your web site.\nIt now can be deployed to any web server by simply uploading its contents or you can check out one of Hugo’s many other deployment options.\nNote If you are storing your web site in git, commit all but the public directory.", "description": "The following steps are here to help you initialize your new website.", "tags": [ - "documentation" + "Documentation" ], "title": "Installation", "uri": "/hugo-theme-relearn/basics/installation/index.html" @@ -147,29 +149,29 @@ var relearn_search_index = [ { "breadcrumb": "Basics", "content": "On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml.\nNote that some of these options are explained in detail in other sections of this documentation.\nAll config options The values reflect the options active in this documentation. The defaults can be taken from the annotated example below.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] alwaysopen = '' breadcrumbSeparator = '\u003e' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' disableAssetsBusting = false disableBreadcrumb = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' externalLinkTarget = '_self' highlightWrap = true images = ['images/hero.png'] mathJaxInitialize = '{}' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' showVisitedLinks = true titleSeparator = '::' [params.author] name = 'Sören Weber' [params.image] errorlevel = 'error' [params.imageEffects] border = true lazy = true lightbox = true shadow = false [params.include] errorlevel = 'error' [params.link] errorlevel = 'error' [params.social] facebook_admin = '' twitter = '' [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' [[params.themeVariant]] identifier = 'blue' [[params.themeVariant]] identifier = 'green' [[params.themeVariant]] identifier = 'red' params: additionalContentLanguage: - en alwaysopen: \"\" author: name: Sören Weber breadcrumbSeparator: '\u003e' collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" disableAssetsBusting: false disableBreadcrumb: false disableExplicitIndexURLs: false disableGeneratorVersion: false disableHoverBlockCopyToClipBoard: false disableInlineCopyToClipBoard: true disableLandingPageButton: true disableLanguageSwitchingButton: false disableMathJax: true disableMermaid: true disableNextPrev: false disableOpenapi: true disableRandomIds: false disableRootBreadcrumb: true disableSearch: false disableSearchHiddenPages: false disableSeoHiddenPages: true disableShortcutsTitle: false disableTagHiddenPages: false disableTermBreadcrumbs: false disableToc: false editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} externalLinkTarget: _self highlightWrap: true image: errorlevel: error imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: error link: errorlevel: error mathJaxInitialize: '{}' mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true ordersectionsby: weight showVisitedLinks: true social: facebook_admin: \"\" twitter: \"\" themeVariant: - auto: [] identifier: relearn-auto name: Relearn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn - identifier: blue - identifier: green - identifier: red titleSeparator: '::' { \"params\": { \"additionalContentLanguage\": [ \"en\" ], \"alwaysopen\": \"\", \"author\": { \"name\": \"Sören Weber\" }, \"breadcrumbSeparator\": \"\\u003e\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"disableAssetsBusting\": false, \"disableBreadcrumb\": false, \"disableExplicitIndexURLs\": false, \"disableGeneratorVersion\": false, \"disableHoverBlockCopyToClipBoard\": false, \"disableInlineCopyToClipBoard\": true, \"disableLandingPageButton\": true, \"disableLanguageSwitchingButton\": false, \"disableMathJax\": true, \"disableMermaid\": true, \"disableNextPrev\": false, \"disableOpenapi\": true, \"disableRandomIds\": false, \"disableRootBreadcrumb\": true, \"disableSearch\": false, \"disableSearchHiddenPages\": false, \"disableSeoHiddenPages\": true, \"disableShortcutsTitle\": false, \"disableTagHiddenPages\": false, \"disableTermBreadcrumbs\": false, \"disableToc\": false, \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\", \"externalLinkTarget\": \"_self\", \"highlightWrap\": true, \"image\": { \"errorlevel\": \"error\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"error\" }, \"link\": { \"errorlevel\": \"error\" }, \"mathJaxInitialize\": \"{}\", \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"ordersectionsby\": \"weight\", \"showVisitedLinks\": true, \"social\": { \"facebook_admin\": \"\", \"twitter\": \"\" }, \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" }, { \"identifier\": \"blue\" }, { \"identifier\": \"green\" }, { \"identifier\": \"red\" } ], \"titleSeparator\": \"::\" } } Annotated config options ​ hugo.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by giving it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes as well. # The author of your site. # Default: not set # This will be used in HTML meta tags, the opengraph protocol and twitter # cards. # You can also set `author.email` if you want to publish this information. author.name = \"Sören Weber\" # The social media image of your site. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # This can be overridden in the page's frontmatter. images = [ \"images/hero.png\" ] # Admin options for social media. # Default: not set # Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's # implementation. See the Hugo docs for possible values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Branding # These options set your overall visual appearance. # Used color variants. # Default: \"auto\" # This sets one or more color variants, available to your readers to choose # from. You can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array with options like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # The last form allows to set further options for each variant. # The `identifier` is mandatory. You can also set `name` which overrides the # value displayed in the variant selector. # If the array has more than one entry, a variant selector # is shown in the lower part of the menu. The first entry in the array is the # default variant, used for first time visitors. # The theme ships with the following variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addition you can use auto mode variants. See the # docs for a detailed explanation. # You can also define your own variants. See the docs how this works. Also, # the docs provide an interactive theme generator to help you with this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"retro-auto\", name = \"Retro Learn/Neon\", auto = [ \"learn\", \"neon\" ] }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These options are defining general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files and CSS-files get a unique ID on each rebuild. # This makes sure, the user always has the latest version and not some stale # copy of his browser cache. Anyways, it can be desireable to turn this # off in certain circumstances. For example if you have Hugo's dev server # running. Also some proxies dislike this optimization. disableAssetsBusting = false # Avoid generator meta tags. # Default: false # Set this to true if you want to disable generation for generator meta tags # of Hugo and the theme in your HTML head. In this case also don't forget to # set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a # meta tag into your home page anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situations the theme generates non stable unique ids to be used # in HTML fragment links. This can be undesirable for example when testing # the output for changes. If you disable the random id generation, the theme # may not function correctly anymore. disableRandomIds = false # Multilanguage content. # Default: not set # If your pages contain further languages besides the main one used, add all # those auxiliary languages here. This will create a search index with # support for all used languages of your site. # This is handy for example if you are writing in Spanish but have lots of # source code on your page which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See hugo.toml of the theme # The theme provides a mechanism to load further JavaScript and CSS # dependencies on demand only if they are needed. This comes in handy if you # want to add own shortcodes that depend on additional code to be loaded. # See the docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # This can be overridden in the page's frontmatter. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The value can contain the macro # `${FilePath}` which will be replaced by the file path of your displayed page. # If no `${FilePath}` is given in the value, the value is treated as if the # `${FilePath}` was appended at the end of the value. This can be overridden # in the pages frontmatter. This is useful if you want to give the opportunity # for people to create merge request for your content. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu appearance. # Hide the search box. # Default: false # If the search box is disabled, the search functionality is disabled too. # This will also cause the keyboard shortcut to be disabled and the dedicated # search page is not linked although it mighty be configured. disableSearch = false # Hide the Home entry. # Default: false # If shown, a Home button will appear below the search bar and the main menu. # It links to your the home page of the current language. disableLandingPageButton = true # The order of main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adhering to # Hugo's default sort order). This can be overridden in the pages frontmatter. ordersectionsby = \"weight\" # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. This can be overridden in the page's frontmatter. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = \"\" # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. # This can be overridden in the page's frontmatter. collapsibleMenu = true # Shows checkmarks for visited pages of the main menu. # Default: false # This also causes the display of the `Clear History` entry in the lower part # of the menu to remove all checkmarks. The checkmarks will also been removed # if you regenerate your site as the ids are not stable. showVisitedLinks = true # Hide heading above the shortcut menu. # Default: false # The title for the heading can be overwritten in your i18n files. See Hugo's # documentation how to do this. disableShortcutsTitle = false # Hide the language switcher. # Default: false # If you have more than one language configured, a language switcher is # displayed in the lower part of the menu. This option lets you explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide hidden pages from search. # Default: false # Hides hidden pages from the suggestions of the search box and the dedicated # search page. disableSearchHiddenPages = false # Hide hidden pages for web crawlers. # Default: false # Avoids hidden pages from showing up in the sitemap and on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden pages for taxonomies. # Default: false # Hides hidden pages from showing up on the taxonomy and terms pages. If this # reduces term counters to zero, an empty but not linked term page will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Title separator. # Default: \"::\" # Changes the title separator used when concatenating the page title with the # site title. This is consistently used throughout the theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes the breadcrumb separator used in the topbars breadcrumb area and for # search results and term pages. breadcrumbSeparator = \"\u003e\" # Hide the root breadcrumb. # Default: false # The root breadcrumb is usually the home page of your site. Because this is # always accessible by clicking on the logo, you may want to reduce clutter # by removing this from your breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term pages. # Default: false # If you have lots of taxonomy terms, the term pages may seem cluttered with # breadcrumbs to you, so this is the option to turn off breadcrumbs on term # pages. Only the page title will then be shown on the term pages. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Hide copy-to-clipboard for inline code. # Default: false # This removes the copy-to-clipboard button from your inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard for block code. # Default: false # The theme only shows the copy-to-clipboard button if you hover over the code # block. Set this to true to disable the hover effect and always show the # button. disableHoverBlockCopyToClipBoard = false # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # This can be overridden in the page's frontmatter or given as a parameter to # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These options configure how the include shortcode works. # What to do when path is not resolved. # Default: \"\" # You can control what should happen if a path can not be resolved to as # a resource or via the file system. If not set, no output will be written # for the unresolved path. If set to `warning` the same happens and an additional # warning is printed. If set to `error` an error message is printed and the build # is aborted. include.errorlevel = \"error\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # What to do when local image link is not resolved. # Default: \"\" # You can control what should happen if a local image can not be resolved to as # a resource. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that this can not resolve files inside of your `static` directory. image.errorlevel = \"error\" # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effects can be overridden in the page's frontmatter or through URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # What to do when local page link is not resolved. # Default: \"\" # You can control what should happen if a local link can not be resolved to a # page. If not set, the unresolved link is written as given into the resulting # output. If set to `warning` the same happens and an additional warning is # printed. If set to `error` an error message is printed and the build is # aborted. # Please note that with Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead to false # negatives. link.errorlevel = \"error\" # How to open external links. # Default: \"_blank\" # For external links you can define how they are opened in your browser. All # values for the HTML `target` attribute of the `a` element are allowed. The # default value opens external links in a separate browser tab. If you want # to open those links in the same tab, use \"_self\". externalLinkTarget = \"_self\" # Generate link URLs the Hugo way. # Default: false # If set to true, the theme behaves like a standard Hugo installation and # appends no index.html to prettyURLs. As a trade off, your build project will # not be servable from the file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # This can be overridden in the page's frontmatter. mathJaxInitialize = \"{}\" # Only load MathJax if needed. # Default: true # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMathJax = true # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # This can be overridden in the page's frontmatter or given as a parameter to # individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # This can be overridden in the page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only load Mermaid if needed. # Default: true # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMermaid = true # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Only load OpenAPI if needed. # Default: true # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableOpenapi = true # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", - "description": "On top of Hugo\u0026rsquo;s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.", + "description": "On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.", "tags": [ - "config" + "Config" ], "title": "Configuration", "uri": "/hugo-theme-relearn/basics/configuration/index.html" }, { "breadcrumb": "Shortcodes \u003e Children", - "content": "This is a demo child page with no description.\nSo its content is used as description.\n", + "content": "This is a demo child page with no description.\nSo its content is used as description.", "description": "This is a demo child page with no description.\nSo its content is used as description.", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 2", "uri": "/hugo-theme-relearn/shortcodes/children/children-2/index.html" }, { "breadcrumb": "Basics", - "content": "The Relearn theme provides configuration options to change your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed through so called color variants.\nA color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo.toml.\nThe Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The interactive variant generator may help you with this task.\nOnce configured in your hugo.toml, you can select them with the variant selector at the bottom of the menu.\nChange the Variant (Simple) Single Variant Set the themeVariant value to the name of your theme file. That’s it! Your site will be displayed in this variant only.\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Note Your theme variant file must reside in your site’s assets/css directory and the file name must start with theme- and end in .css. In the above example, the path of your theme file must be assets/css/theme-relearn-light.css.\nIf you want to make changes to a shipped color variant, create a copy in your site’s assets/css directory. Don’t edit the file in the theme’s directory!\nMultiple Variants You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Tip The theme provides an advanced configuration mode, combining the functionality for multiple variants with the below possibilities of adjusting to your OS settings and syntax highlighting and even more!\nAlthough all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.\nAdjust to OS Settings You can also cause the site to adjust to your OS settings for light/dark mode. Just set the themeVariant to auto to become an auto mode variant. That’s it.\nYou can use the auto value with the single or multiple variants option. If you are using multiple variants, you can drop auto at any position in the option’s array, but usually it makes sense to set it in the first position and make it the default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If you don’t configure anything else, the theme will default to use relearn-light for light mode and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant option if present.\nIn the above example, you would end with red for light mode and the default of relearn-dark for dark mode.\nIf you don’t like that behavior, you can explicitly set themeVariantAuto. The first entry in the array is the color variant for light mode, the second for dark mode.\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Change the Favicon If your favicon is a SVG, PNG or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png or favicon.ico respectively.\nIf you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.\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 layouts/partials/favicon.html in your site’s directory and write something like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change the Logo Create a new file in layouts/partials/logo.html of your site. 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!\nNote The size of the logo will adapt automatically.\nSyntax Highlighting If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation according to Hugo’s documentation and provide a syntax highlighting stylesheet file.\nYou can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to assets/css/chroma-\u003cNAME\u003e.css. To use it with your color variant you have to define --CODE-theme: \u003cNAME\u003e in the color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css and hugo.toml of the exampleSite.\nChange the Variant (Advanced) The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.\nLike with the multiple variants option, you are defining your theme variants in an array but now not by simple strings but in a table with suboptions.\nAgain, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } you now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. auto \u003cempty\u003e If set, the variant is treated as an auto mode variant. It has the same behavior as the themeVariantAuto option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. Example Configuration of This Site hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] identifier = 'neon' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearn Light/Dark - identifier: relearn-light - identifier: relearn-dark - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - identifier: neon { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"identifier\": \"neon\" } ] } } Modify Shipped Variants In case you like a shipped variant but only want to tweak some aspects, you have two choices:\nCopy and change\nYou can copy the shipped variant file from the theme’s assets/css directory to the site’s assets/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your hugo.toml by the chosen name.\nCreate and import\nYou can create a new variant file in the site’s assets/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your hugo.toml by the chosen name.\nFor example, you want to use the relearn-light variant but want to change the syntax highlighting schema to the one used in the neon variant. For that, create a new assets/css/theme-my-branding.css in your site’s directory and add the following lines:\n​ assets/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name of the chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */ } Afterwards put this in your hugo.toml to use your new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-branding { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant but keep your modifications.\n", - "description": "The Relearn theme provides configuration options to change your site\u0026rsquo;s colors, favicon and logo.", - "tags": null, + "content": "The Relearn theme provides configuration options to change your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed through so called color variants.\nA color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo.toml.\nThe Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The interactive variant generator may help you with this task.\nOnce configured in your hugo.toml, you can select them with the variant selector at the bottom of the menu.\nChange the Variant (Simple) Single Variant Set the themeVariant value to the name of your theme file. That’s it! Your site will be displayed in this variant only.\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Note Your theme variant file must reside in your site’s assets/css directory and the file name must start with theme- and end in .css. In the above example, the path of your theme file must be assets/css/theme-relearn-light.css.\nIf you want to make changes to a shipped color variant, create a copy in your site’s assets/css directory. Don’t edit the file in the theme’s directory!\nMultiple Variants You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Tip The theme provides an advanced configuration mode, combining the functionality for multiple variants with the below possibilities of adjusting to your OS settings and syntax highlighting and even more!\nAlthough all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.\nAdjust to OS Settings You can also cause the site to adjust to your OS settings for light/dark mode. Just set the themeVariant to auto to become an auto mode variant. That’s it.\nYou can use the auto value with the single or multiple variants option. If you are using multiple variants, you can drop auto at any position in the option’s array, but usually it makes sense to set it in the first position and make it the default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If you don’t configure anything else, the theme will default to use relearn-light for light mode and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant option if present.\nIn the above example, you would end with red for light mode and the default of relearn-dark for dark mode.\nIf you don’t like that behavior, you can explicitly set themeVariantAuto. The first entry in the array is the color variant for light mode, the second for dark mode.\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Change the Favicon If your favicon is a SVG, PNG or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png or favicon.ico respectively.\nIf you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.\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 layouts/partials/favicon.html in your site’s directory and write something like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change the Logo Create a new file in layouts/partials/logo.html of your site. 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!\nNote The size of the logo will adapt automatically.\nSyntax Highlighting If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation according to Hugo’s documentation and provide a syntax highlighting stylesheet file.\nYou can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to assets/css/chroma-\u003cNAME\u003e.css. To use it with your color variant you have to define --CODE-theme: \u003cNAME\u003e in the color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css and hugo.toml of the exampleSite.\nChange the Variant (Advanced) The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.\nLike with the multiple variants option, you are defining your theme variants in an array but now not by simple strings but in a table with suboptions.\nAgain, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } you now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. auto \u003cempty\u003e If set, the variant is treated as an auto mode variant. It has the same behavior as the themeVariantAuto option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. Example Configuration of This Site hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] identifier = 'neon' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearn Light/Dark - identifier: relearn-light - identifier: relearn-dark - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - identifier: neon { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"identifier\": \"neon\" } ] } } Modify Shipped Variants In case you like a shipped variant but only want to tweak some aspects, you have two choices:\nCopy and change\nYou can copy the shipped variant file from the theme’s assets/css directory to the site’s assets/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your hugo.toml by the chosen name.\nCreate and import\nYou can create a new variant file in the site’s assets/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your hugo.toml by the chosen name.\nFor example, you want to use the relearn-light variant but want to change the syntax highlighting schema to the one used in the neon variant. For that, create a new assets/css/theme-my-branding.css in your site’s directory and add the following lines:\n​ assets/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name of the chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */ } Afterwards put this in your hugo.toml to use your new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-branding { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant but keep your modifications.", + "description": "The Relearn theme provides configuration options to change your site’s colors, favicon and logo.", + "tags": [], "title": "Branding", "uri": "/hugo-theme-relearn/basics/branding/index.html" }, @@ -177,15 +179,15 @@ var relearn_search_index = [ "breadcrumb": "Basics", "content": "Usage scenarios The theme is usable in different scenarios, requiring the following mandatory settings in your hugo.toml. All settings not mentioned can be set to your liking.\nPublic Web Server from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { \"baseURL\": \"https://example.com/\" } Public Web Server from Subdirectory hugo. toml yaml json baseURL = 'https://example.com/mysite/' relativeURLs = false baseURL: https://example.com/mysite/ relativeURLs: false { \"baseURL\": \"https://example.com/mysite/\", \"relativeURLs\": false } Private Web Server (LAN) The same settings as with any of the public web server usage scenarios or\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } File System hugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } Warning Using a baseURL with a subdirectory and relativeURLs=true are mutually exclusive due to the fact, that Hugo does not apply the baseURL correctly.\nIf you need both, you have to generate your site twice but with different settings into separate directories.\nNote Sublemental pages (like sitemap.xml, rss.xml) and generated social media links inside of your pages will always be generated with absolute URLs and will not work if you set relativeURLs=true.\nInfo If you are using uglyURLs=false (Hugo’s default), the theme will append an additional index.html to all page links to make your site be servable from the file system. If you don’t care about the file system and only serve your page via a web server you can generate the links without this:\nhugo. toml yaml json [params] disableExplicitIndexURLs = true params: disableExplicitIndexURLs: true { \"params\": { \"disableExplicitIndexURLs\": true } } Activate search If not already present, add the following lines in your hugo.toml file.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search'] outputs: home: - html - rss - search { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\" ] } } This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library.\nActivate dedicated search page You can add a dedicated search page for your page by adding the searchpage outputformat to your home page by adding the following lines in your hugo.toml file. This will cause Hugo to generate a new file http://example.com/mysite/search.html.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search', 'searchpage'] outputs: home: - html - rss - search - searchpage { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\", \"searchpage\" ] } } You can access this page by either clicking on the magnifier glass or by typing some search term and pressing ENTER inside of the menu’s search box .\nNote To have Hugo create the dedicated search page successfully, you must not generate the URL http://example.com/mysite/search.html from your own content. This can happen if you set uglyURLs=true in your hugo.toml and defining a Markdown file content/search.md.\nTo make sure, there is no duplicate content for any given URL of your project, run hugo --printPathWarnings.\nActivate print support You can activate print support to add the capability to print whole chapters or even the complete site. Just add the print output format to your home, section and page in your hugo.toml as seen below:\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print', 'search'] page = ['html', 'rss', 'print'] section = ['html', 'rss', 'print'] outputs: home: - html - rss - print - search page: - html - rss - print section: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\", \"search\" ], \"page\": [ \"html\", \"rss\", \"print\" ], \"section\": [ \"html\", \"rss\", \"print\" ] } } This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.\nNote The resulting URL will not be configured ugly in terms of Hugo’s URL handling even if you’ve set uglyURLs=true in your hugo.toml. This is due to the fact that for one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy with the resulting URLs you can manually redefine outputFormats.print in your own hugo.toml to your liking.\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 the landingPageName for the defined languages:\nhugo. toml yaml json [languages] [languages.en] [languages.en.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" [languages.pir] [languages.pir.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" languages: en: params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home pir: params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Homme { \"languages\": { \"en\": { \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" } }, \"pir\": { \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Arrr! Homme\" } } } } If this option is not configured for a specific language, they will get their default values:\n​ toml yaml json landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" } The home button is going to look like this:\nSocial Media Meta Tags You can add social media meta tags for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the Hugo docs.\nChange the Menu Width The menu width adjusts automatically for different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 14.375rem M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem The values for the screen width breakpoints aren’t configurable.\nIf you want to adjust the menu width you can define the following CSS variables in your custom-header.html. Note that --MENU-WIDTH-S applies to the menu flyout width in mobile mode for small screen sizes.\n:root { --MENU-WIDTH-S: 14.375rem; --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Change the Main Area’s Max Width By default the main area width will only grow to a certain extent if more vertical screen space is available. This is done for readability purposes as long line are usually harder to read.\nIf you are unhappy with the default, you can define the following CSS variable in your custom-header.html and set the value to your liking. If you want to use all available space, select a really big value like 1000rem;\n:root { --MAIN-WIDTH-MAX: 80.25rem; }Own Shortcodes with JavaScript Dependencies Certain shortcodes make use of additional dependencies like JavaScript and CSS files. The theme only loads these dependencies if the shortcode is used. To do so correctly the theme adds management code in various files.\nYou can you use this mechanism in your own shortcodes. Say you want to add a shortcode myshortcode that also requires the jquery JavaScript library.\nWrite the shortcode file layouts/shortcodes/myshortcode.html and add the following line\n​ layouts/shortcodes/myshortcode.html {{- .Page.Store.Set \"hasMyShortcode\" true }} Add the following snippet to your hugo.toml\nhugo. toml yaml json [params] [params.relearn] [params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = 'MyShortcode' params: relearn: dependencies: myshortcode: name: MyShortcode { \"params\": { \"relearn\": { \"dependencies\": { \"myshortcode\": { \"name\": \"MyShortcode\" } } } } } Add the dependency loader file layouts/partials/dependencies/myshortcode.html. The loader file will be called from multiple locations inside of the theme with the parameter page containing the current page variable and location with one of the currently defined locations\nheader: if called at the end of the HTML head element footer: if called at the end of the HTML body element ​ layouts/partials/dependencies/myshortcode.html {{- if eq .location \"footer\" }} \u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e {{- end }} Character casing is relevant!\nthe name setting in your hugo.toml must match the key (that needs to be prefixed with a has) you used for the store in your layouts/shortcodes/myshortcode.html. the key on params.relearn.dependencies in your hugo.toml must match the base file name of your loader file. See the math, mermaid and openapi shortcodes for examples.\nNote If you are really into customization of the theme and want to use the dependency loader for your own locations, you can do this by simply calling it from inside of your overriden partials\n{{- partial \"dependencies.html\" (dict \"page\" . \"location\" \"mylocation\") }} Output Formats Certain parts of the theme can be changed for support of your own output formats. Eg. if you define a new output format PLAINTEXT in your hugo.toml, you can add a file layouts/partials/header.plaintext.html to change the way, the page header should look like for that output format.\nReact to Variant Switches in JavaScript Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event themeVariantLoaded on the document will be dispatched. You can add an event listener and react to changes.\ndocument.addEventListener( 'themeVariantLoaded', function( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials 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 :\nheader.html: the header of the page. See output-formats footer.html: the footer of the page. See output-formats body.html: the body of the page. The body may contain of one or many articles. See output-formats article.html: the output for a single article, can contain elements around your content. See output-formats menu.html: left menu. Not meant to be overwritten search.html: search box. Not meant to be overwritten custom-header.html: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file. custom-footer.html: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include javascript HTML tag directive in your file. favicon.html: the favicon heading.html: side-wide configuration to change the pages title headings. heading-pre.html: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s headingPre setting into account. heading-post.html: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s headingPost setting into account. logo.html: the logo, on top left hand corner meta.html: HTML meta tags, if you want to change default behavior menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s menuPre setting into account. menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s menuPost setting into account. menu-footer.html: footer of the left menu toc.html: table of contents content.html: the content page itself. This can be overridden if you want to display page’s meta data above or below the content. content-header.html: header above the title, has a default implementation but you can overwrite it if you don’t like it. content-footer.html: footer below the content, has a default implementation but you can overwrite it if you don’t like it. ", "description": "Usage scenarios The theme is usable in different scenarios, requiring the following mandatory settings in your hugo.", - "tags": null, + "tags": [], "title": "Customization", "uri": "/hugo-theme-relearn/basics/customization/index.html" }, { "breadcrumb": "Basics", - "content": "This interactive tool may help you to generate your own color variant stylesheet.\nShow usage instructions To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.\nThe graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.\nThe arrowed lines reflect how colors are inherited through different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this select the neon variant and modify the different heading colors. There, colors for the heading h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can browse to other pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and copy it into your site’s assets/css directory. Afterwards you have to adjust the themeVariant parameter in your hugo.toml to your chosen file name.\nEg. if your new variants file is named theme-my-custom-variant.css, you have to set themeVariant='my-custom-variant' to use it.\nSee the docs for further configuration options\nDownload variant Reset variant\nGraph Download variant Reset variant\n", + "content": "This interactive tool may help you to generate your own color variant stylesheet.\nShow usage instructions To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.\nThe graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.\nThe arrowed lines reflect how colors are inherited through different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this select the neon variant and modify the different heading colors. There, colors for the heading h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can browse to other pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and copy it into your site’s assets/css directory. Afterwards you have to adjust the themeVariant parameter in your hugo.toml to your chosen file name.\nEg. if your new variants file is named theme-my-custom-variant.css, you have to set themeVariant='my-custom-variant' to use it.\nSee the docs for further configuration options\nDownload variant Reset variant\nGraph Download variant Reset variant", "description": "This interactive tool may help you to generate your own color variant stylesheet.", - "tags": null, + "tags": [], "title": "Stylesheet generator", "uri": "/hugo-theme-relearn/basics/generator/index.html" }, @@ -193,15 +195,15 @@ var relearn_search_index = [ "breadcrumb": "Basics", "content": "The theme comes with a reasonably configured topbar.\nNevertheless, your requirements may differ from this configuration. Luckily the theme got you covered as the themebar, its buttons and the functionality behind these buttons is fully configurable by you.\nTip All mentioned file names below can be clicked and show you the implementation for a better understanding.\nAreas The default configuration comes with three predefined areas that may contain an arbitrary set of buttons.\nstart: shown between menu and breadcrumb end: shown on the opposite breadcrumb side in comparison to the start area more: shown when pressing the more button in the topbar While you can not add additional areas in the topbar, you are free to configure additional buttons that behave like the more button, providing further user defined areas.\nButtons The theme ships with the following predefined buttons (from left to right in the screenshot)\nsidebar: opens the sidebar flyout if in mobile layout toc: opens the table of contents in an overlay edit: browses to the editable page if the editURL parameter is set print: browses to the chapters printable page if print support was activated prev: browses to the previous page if there is one next: browses to the next page if there is one more: opens the overlay for the more area Not all buttons are displayed at every given time. This is configurable (see below if interested).\nRedefining Areas Each predefined area and button comes in their own file. By that it is easy for you to overwrite an area file in your installation reusing only the buttons you like.\nEg. you can redefine the predefined end area by adding the file layouts/partials/topbar/area/end.html in your installation (not in the theme itself) to remove all but the more button.\nThe below example sets an explicit value for the onempty parameter, overriding the specific default value for this button (these defaults vary depending on the button). The parameter causes the more button to always be displayed instead of hiding once its content is empty.\n{{ partial \"topbar/button/more.html\" (dict \"page\" . \"onempty\" \"disable\" )}}Defining own Buttons Button Types The theme distinguishes between two types of buttons:\nbutton: a clickable button that either browses to another site, triggers a user defined script or opens an overlay containing user defined content area-button: the template for the more button, to define your own area overlay buttons Button Parameter Screen Widths and Actions Depending on the screen width you can configure how the button should behave. Screen width is divided into three classes:\ns: (controlled by the onwidths parameter) mobile layout where the menu sidebar is hidden m: (controlled by the onwidthm parameter) desktop layout with visible sidebar while the content area width still resizes l: (controlled by the onwidthl parameter) desktop layout with visible sidebar once the content area reached its maximum width For each width class, you can configure one of the following actions:\nshow: the button is displayed in its given area hide: the button is removed area-XXX: the button is moved from its given area into the area XXX; eg. this is used to move buttons to the more area overlay in the mobile layout Hiding and Disabling Stuff While hiding a button depending on the screen size can be configured with the above described hide action, you may want to hide the button on certain other conditions as well.\nFor example, the print button in its default configuration should only be displayed if print support was configured. This is done in your button template by checking the conditions first before displaying the button (see layouts/partials/topbar/button/print.html).\nAnother preferred condition for hiding a button is, if the displayed overlay is empty. This is the case for the toc (see layouts/partials/topbar/button/toc.html) as well as the more button (see layouts/partials/topbar/button/more.html) and controlled by the parameter onempty.\nThis parameter can have one of the following values:\ndisable: the button displayed in disabled state if the overlay is empty hide: the button is removed if the overlay is empty If you want to disable a button containing no overlay, this can be achieved by an empty href parameter. An example can be seen in the prev button (see layouts/partials/topbar/button/prev.html) where the URL for the previous site may be empty.\nReference Button Contains the basic button functionality and is used as a base implementation for all other buttons (layouts/partials/topbar/func/button.html).\nCall this from your own button templates if you want to implement a button without an overlay like the print button (layouts/partials/topbar/button/print.html) or with an overlay containing arbitrary content like the toc button (layouts/partials/topbar/button/toc.html).\nFor displaying an area in the button’s overlay, see Area-Button.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. class \u003cempty\u003e Mandatory unique class name for this button. Displaying two buttons with the same value for class is undefined. href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click.\n- if starting with javascript: all following text will be executed in your browser\n- every other string will be interpreted as URL\n- if empty the button will be displayed in disabled state regardless of its content icon \u003cempty\u003e Font Awesome icon name. onempty disable Defines what to do with the button if the content parameter was set but ends up empty:\n- disable: The button is displayed in disabled state.\n- hide: The button is removed. onwidths show The action, that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed in the tooltip. title \u003cempty\u003e Arbitrary text for the button. content \u003cempty\u003e Arbitrary HTML to put into the content overlay. This parameter may be empty. In this case no overlay will be generated. Area-Button Contains the basic functionality to display area overlay buttons (layouts/partials/topbar/func/area-button.html).\nCall this from your own button templates if you want to implement a button with an area overlay like the more button (layouts/partials/topbar/button/more.html).\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. area \u003cempty\u003e Mandatory unique area name for this area. Displaying two areas with the same value for area is undefined. icon \u003cempty\u003e Font Awesome icon name. onempty disable Defines what to do with the button if the content overlay is empty:\n- disable: The button is displayed in disabled state.\n- hide: The button is removed. onwidths show The action, that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed in the tooltip. title \u003cempty\u003e Arbitrary text for the button. Predefined Buttons The predefined buttons by the theme (all other buttons besides the more and toc button in layouts/partials/topbar/button).\nCall these from your own redefined area templates if you want to use default button behavior.\nThe \u003cvarying\u003e parameter values are different for each button and configured for standard behavior as seen on this page.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. onwidths \u003cvarying\u003e The action, that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. Predefined Overlay-Buttons The predefined buttons by the theme that open an overlay (the more and toc button in layouts/partials/topbar/button).\nCall these from your own redefined area templates if you want to use default button behavior utilizing overlay functionality.\nThe \u003cvarying\u003e parameter values are different for each button and configured for standard behavior as seen on this page.\nParameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. onempty disable Defines what to do with the button if the content overlay is empty:\n- disable: The button is displayed in disabled state.\n- hide: The button is removed. onwidths \u003cvarying\u003e The action, that should be executed if the site is displayed in the given width:\n- show: The button is displayed in its given area\n- hide: The button is removed.\n- area-XXX: The button is moved from its given area into the area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. ", "description": "The theme comes with a reasonably configured topbar.\nNevertheless, your requirements may differ from this configuration.", - "tags": null, + "tags": [], "title": "Topbar Modification", "uri": "/hugo-theme-relearn/basics/topbar/index.html" }, { "breadcrumb": "Basics", "content": " Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead of .Title if available #816 Fixes [bug] scrollbar: scroll bar in side menu gets stuck in dragged state on mobile #808 5.26.2 (2024-03-18) Enhancements [feature] icons: use fixed width to ease layout #812 Fixes [bug] search: broken since version 5.26.1 #813 [bug] search: fix result links for pages in root #810 5.26.1 (2024-03-17) Fixes [bug] mermaid: show reset button after pan #807 [bug] openapi: make it run for file:// protocol #806 [bug] theme: fix relative path detection if relativeURLs=false #804 5.26.0 (2024-03-16) Enhancements [feature] image: add lazy loading image effect option #803 [feature] render-hook: support Markdown attributes #795 [feature] theme: support full page width #752 Fixes [bug] clipboard: fix broken style if block code is in table #790 [bug] nav: browser back navigation does not jump to the correct position #509 Maintenance [task] build: update all available actions to nodejs 20 #802 [task] openapi: update swagger-ui to 5.11.10 #798 [task] mermaid: update to 10.9.0 #797 5.25.0 (2024-02-29) Enhancements [feature][change] theme: print out GitInfo in page footer if configured #786 [feature][change] resources: new shortcode to deprecate attachments shortcode #22 Fixes [bug] swagger: fix compat warning #787 5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author settings want to warn #785 5.24.2 (2024-02-24) Enhancements [feature] image: adjust to Hugo 0.123 #777 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolution reporting configurable #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility with Hugo 0.123 #771 [feature] topbar: support editURL in frontmatter #764 [feature] menu: use –MENU-WIDTH-S to adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make heading a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml to hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text for button #739 [feature] theme: run hugo demo site without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Hugo options #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discovering links on keyboard navigation #726 [feature][change] variant: increase contrast for light themes #722 [feature] theme: break build if minimum Hugo version is not matched #719 [feature] taxonomy: humanize term on missing term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence syntax in Hugo \u003e= 0.121.0 #749 [bug] link: fix links to pages containing dots in their name #748 [bug] image: get resource images if link is prefixed with ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespacing in FF #737 [bug] i18n: fix warning messages for zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespacing in codefences #723 5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy page #712 [feature] taxonomy: warn on missing term title #709 Fixes [bug] taxonomy: fix sorting of terms on content pages #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term page #705 Fixes [bug] variant: fix typo in chroma-learn.css #708 [bug] links: ignore local markdown links linking to files with extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow for content on term pages #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link and copy to clipboard button on mobile #697 [feature][change] config: adjust to changes in Hugo 0.120 #693 [feature] variants: add more contrast to neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort options #684 [feature] theme: add social media meta information #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref is used falsly #681 [feature] menu: make width configurable #677 [feature] tabs: use color for link of inactive tabs #675 [feature] taxonomy: modularize term list generation #671 [feature] theme: remove warnings with hugo --printI18nWarnings #670 [feature] theme: implement portable linking #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout for width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms in pages if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid to 10.6.0 #703 [task] openapi: update swagger-ui to 5.9.1 #702 5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translation #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by removing duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color for zen #667 [bug] clipboard: fix RTL location of tooltip #661 [bug] clipboard: ignore RTL for code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generation for markdownified titles #657 [bug] mermaid: avoid graph bombing on hugo –minify #656 [bug] mermaid: fix width for some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color for tables #648 [feature] search: add breadcrumb to dedicated search results #647 [feature][change] menu: optionally disable index pages for sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between headings and theme #646 [bug] theme: remove HTML validation errors #644 [bug] breadcrumb: remove superflous whitespace between items #643 5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configurable #639 [feature][change] menu: fix footer padding #637 Fixes [bug] breadcrumb: don’t ignore spaces for separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects to lightbox images #631 Maintenance [task] openapi: update to swagger 5.7.2 #641 5.20.0 (2023-08-26) Enhancements [feature][change] theme: support for colored borders between menu and content #626 [feature] image: allow option to apply image effects globally #623 [feature][change] openapi: switch to light syntaxhighlightning where applicable #621 [feature] images: document usage of images with links #576 Fixes [bug] highlight: fix rendering for Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search page #627 [bug] highlight: don’t switch to block view if hl_inline=true #618 [bug] variant: minor adjustments to zen variants #617 [bug] mermaid: lazy render graph if it is initially hidden #187 Maintenance [task] openapi: update to swagger 5.4.1 #620 5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant in light and dark #613 [feature] i18n: add Hungarian translation #604 [feature] mermaid: update to 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param is a map/slice #611 [bug] mermaid: fix broken zoom since update to v10 #608 [bug] mermaid: variant generator diagram does not respond to events #607 [bug] print: avoid chroma leak for relearn-dark #605 Maintenance [task] mermaid: update to 10.3.1 #610 5.18.0 (2023-07-27) Enhancements [feature][change] shortcodes: add more deprecation warnings #598 [feature][change] shortcodes: change context parameter to page if called as partial #595 [feature] siteparam: support nested parameters and text formatting #590 [feature][change] a11y: improve when tabbing through links #581 Fixes [bug] openapi: inherit RTL setting from Hugo content #600 [bug] 404: fix display in RTL #597 [bug] highlight: fix position of copy-to-clipboard button in RTL #594 [bug] openapi: fix spelling #593 [bug] search: fix typo in output format #591 [bug] tabs: fix tab selection by groupid #582 [bug] theme: restore compat with Hugo 0.95.0 #580 [bug][change] theme: improve display of links #577 5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy to clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configurable line breaks #169 Fixes [bug] theme: support Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy to clipboard #569 5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 page #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecation warnings #565 Fixes [bug] mermaid: allow for YAML frontmatter inside of graph #564 [bug] alias: fix redirect URLs in case of empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title and icon option #552 [feature] shortcodes: add style option to mimic code box color scheme #551 [feature] tabs: support color options #550 [feature] favicon: add light \u0026 dark option for OS’s preferred color scheme #549 Fixes [bug] icon: remove whitespace on start #560 [bug] shortcodes: avoid superflous margin at start and end of content #558 [bug] expand: fix html encoding of finishing content tag #557 [bug] icon: fix ouput “raw HTML omitted” with goldmark config unsafe=false #555 5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support for category default taxonomy #541 Fixes [bug] attachments: work for Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shortcodes: intermediately use random ids instead of .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode to display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded content #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Hugo 0.112 #540 Maintenance [task] chore: update Mermaid to 9.4.3 #534 [task] mermaid: update to 10.2.0 #499 5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc for standard installation #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb and title for taxonomy #532 5.14.1 (2023-05-20) No changelog for this release.\n5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index for tags #531 [feature] tags: increase readability of taxonomy pages #530 [feature] nav: make breadcrumb separator configurable #529 [feature] i18n: add translation for default taxonomies #528 [feature] theme: set appropriate defaults for all theme specific params #516 [feature] theme: allow to display tags below article #513 Fixes [bug] shortcode: make .context always a page #527 5.13.2 (2023-05-17) Fixes [bug] print: enable print for pages with _build options #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc to scroll page #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementation with swagger-ui #523 Fixes [bug] variant: avoid leaking shadows in neon print style #524 5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles and breadcrumbs for search and tag pages #521 Fixes [bug] menu: avoid hiding of expander on hover when active item has children #520 [bug] menu: showVisitedLinks not working for some theme variants #518 [bug] theme: fix resource URLs for 404 page on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used in bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param is not working as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language is present #503 [bug] shortcodes: allow markdown for title and content #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state for alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix setting of colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand and image ids stable #477 [feature] variant: set scrollbar color to dark for dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimization for huge screen sizes #466 Fixes [bug] i18n: write code ltr even for rtl languages #492 [bug] anchor: fix link in FF when served from file system #482 [bug] shortcodes: don’t break build and render for invalid parameters #480 [bug] nav: restore scroll position on browser back #476 [bug] variant: avoid style leak for auto style #473 Maintenance [task] build: add imagebot #485 5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs content is not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include missing theme-auto.css in distribution #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translation #455 [feature][change] lightbox: switch to CSS-only solution #451 [feature][change] variant: add support for prefers-color-scheme #445 [feature][change] expand: refactor for a11y #339 [feature][change] mermaid: make zoom configurable #144 Fixes [bug] swagger: avoid errors when using invalid rapi-doc fragment ids #465 [bug] search: fix oddities in keyboard handling #463 [bug] badge: fix text color for IE11 #462 [bug] mermaid: rerender graph if search term is present and variant is switched #460 [bug] tags: show tag on pages when tag has space #459 [bug] edit: remove double slash on root page link #450 Maintenance [task] build: add moving version tags #453 [task][change] theme: remove jQuery #452 [task] build: check for release notes before release #448 5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb for huge installations #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links with relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shortcodes: support for accent color #440 [feature] shortcodes: add color parameter where applicable #438 [feature] theme: announce translations as alternate links #422 Fixes [bug] nav: fix breadcrumbs for deeply nested sections #442 [bug] theme: improve whitespacing in tables #441 5.9.4 (2023-01-23) Fixes [bug] variant: fix search icon and text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigation for horizontal scrolling #435 [bug][breaking] theme: allow pages on top level #434 Maintenance [task] build: switch to wildcard version of actions #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts for Hindi and Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configurable #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links in separate tab #419 [feature] theme: make it a Hugo module #417 Fixes [bug][change] attachments: fix incorrect links for defaultContentLanguageInSubdir=true #425 5.8.1 (2022-12-11) Fixes [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] icon: add new shortcode #412 [feature] theme: style and document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spacing for tag flyout in FF #413 5.7.0 (2022-11-29) Enhancements [feature] button: refactor for a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color in FF and IE #405 [bug][change] i18n: rename Korean translation from country to lang code #404 Maintenance [task] search: update lunr languages to 1.10.0 #403 5.6.6 (2022-11-23) Enhancements [feature] search: make build and js forgiving against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator for use of neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage of background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias pages usable by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compatible with Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section in config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distortion #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handling #390 [feature] search: improve keyboard handling #387 [feature] search: add dedicated search page #386 [feature] theme: make creation of generator meta tag configurable #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid leading whitespace #394 [bug] theme: fix build errors when referencing SVGs in markdown #393 [bug] variant: avoid neon to leak into IE11 fallback #392 [bug] theme: fix urls for file:// protocol in sitemap #385 [bug] theme: add id to h1 elements #384 [bug] rss: fix display of hidden subpages #382 [bug] nav: fix key navigation when pressing wrong modifiers #379 Maintenance [task] mermaid: update to version 9.2.2 #391 5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on pages #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo in 404.html #376 [bug] theme: allow menu items and children to be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflowing issue with anchors and tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: optimize page load for images #304 Fixes [bug] theme: fix context in render hooks #373 [bug] print: make canonical URL absolute #371 5.4.3 (2022-11-05) Enhancements [feature] history: refactor for a11y #341 Fixes [bug] theme: fix multilang links when site served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output to env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow passing of parameters with codefence syntax #363 [feature] i18n: add Finnish translation #361 [feature] mermaid: allow passing of parameters with codefence syntax #360 [feature] i18n: support RTL #357 [feature][change] button: add option for target #351 [feature][change] theme: allow to be served by file:// protocol #349 5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translation #343 [feature] theme: option to align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label and content #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links of subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused page parameter from docs #336 [bug] print: remove menu placeholder in Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors where applicable #307 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter pages overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls for uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translation #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Hugo minimum requirement to 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term is found in submenus #312 Fixes [bug] print: switch mermaid and swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme to light #313 [bug] mermaid: header is showing up in FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if page is hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overriding partials for output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework of archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: load CSS if JS is disabled #305 5.0.1 (2022-07-07) Enhancements [feature][breaking] theme: optimize loading of js and css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize rendering #300 [feature] history: don’t reload page when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align content with topbar icon limits #290 [feature] button: allow for empty href #288 [feature] i18n: make Simplified Chinese the standard language for the zn code #287 [feature] clipboard: move head styles to stylesheet #286 [feature] math: add mathjax rendering #235 [feature] theme: allow for page heading modification #139 Fixes [bug] favicon: fix URL if site resides in subfolder #302 [bug] code: show copy-to-clipboard marker for blocklevel code #298 [bug] menu: make active expander visible on hover #297 [bug] print: disable arrow navigation #294 [bug] print: add missing page break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size of chapter heading #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Mermaid 9.1.3 #293 4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not load in documentation #285 [bug] children: descriptions not working #284 [bug] print: fix empty page for shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url for logo and home button #282 4.2.3 (2022-06-23) Fixes [bug][breaking] include: second parameter is ignored #281 4.2.2 (2022-06-23) No changelog for this release.\n4.2.1 (2022-06-23) No changelog for this release.\n4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab selection if panel does not contain item #279 [feature] shortcodes: convert to partials #277 Fixes [bug] swagger: avoid builtin syntax-highlightning #280 [bug] search: fix console message for missing lunr translations #278 [bug] tabs: fix wrapping when having many tabs #272 4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when content starts with heading #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang content #271 4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language with wrong lang code #270 [bug] i18n: fix search for non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigation for scrolling #268 Fixes [bug] swagger: adjust font-size for method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compatible with Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc to 9.3.2 #266 [task] mermaid: update to 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll page on CTRL+f #242 4.0.1 (2022-06-05) No changelog for this release.\n4.0.0 (2022-06-05) Enhancements [feature] shortcodes: add named parameter if missing #260 [feature][breaking] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translation #254 [feature] attachments: support for brand colors #252 [feature] notice: support for brand colors #251 [feature][breaking] config: remove custom_css #248 [feature] theme: use proper file extension for page-meta.go #246 [feature] variant: add support for brand color variables #239 [feature] i18n: add Polish translation #237 Fixes [bug] shortcodes: accept boolean parameters if given as string #261 [bug] print: adjust button and tab size #259 [bug] print: show Mermaid if requested in frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display of tooltip for heading anchor #241 3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translation #233 [feature] menu: expand/collapse menu items without navigation #231 [feature] print: add option to print whole chapter #230 [feature][breaking] theme: apply user supplied content footer below content #229 Fixes [bug] theme: scroll to heading on initial load #232 3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support for oas/swagger documentation #226 Fixes [bug] variant: make variant switch work on slow networks #228 3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just the title page #224 [bug] theme: align content scrollbar to the right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differing themes for color variant switch #219 [feature] mermaid: load javascript on demand #218 Maintenance [task] mermaid: update to 8.14.0 #220 3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translation #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add icon parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage of multiple Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color in Chrome #213 [bug] mobile: improve behavior of sidebar menu #210 3.0.4 (2022-02-24) Enhancements [feature] theme: improve font loading #201 [feature][change] variant: fix inconsistent color variable naming #200 Fixes [bug] variant: fix occasional fail when resetting generator #208 [bug] docs: don’t move header on logo hover in IE11 #207 [bug] variant: avoid flash of menu header when non default variant is active #206 [bug] theme: fix wrong HTML closing tag order in chapters #205 [bug] theme: adjust breadcrumb and title for empty home page titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count in taxonomy list #195 Fixes [bug] theme: remove Hugo build warning if page is not file based #197 [bug] tags: adhere to titleSeparator #196 [bug] theme: hide footer divider and variant selector in IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically according to style #192 Fixes [bug] theme: revert fontawsome to version 5 for IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if the page has headings #182 [feature][breaking] theme: change default colors to Relearn defaults #181 [feature] variant: add a variant selector #178 [feature][breaking] menu: rework footer UX #177 [feature] theme: support for dark mode #175 [feature] docs: use light syntax highlightning theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X in filled out search box in IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change for icons on hover #176 2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigation respect ordersectionsby configuration #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links in official documentation #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when the shortcut is an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info to head #158 Fixes [bug] theme: fix selection of *.ico files as favicons #160 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 behavior #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 malicious 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 malicious 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 compatibility #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 highlighter: 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 superfluous 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": "Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo\u0026rsquo;s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .", - "tags": null, + "description": "Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generation #825 [feature] theme: adjust to Hugo’s build-in code #824 [feature][change] link: warn if fragment is not found #823 [feature] theme: add styling for selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll to prev/next heading using keyboard shortcut #819 [feature] breadcrumb: use .", + "tags": [], "title": "History", "uri": "/hugo-theme-relearn/basics/history/index.html" }, @@ -210,28 +212,28 @@ var relearn_search_index = [ "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" + "Children", + "Non-Hidden" ], "title": "page 3", "uri": "/hugo-theme-relearn/shortcodes/children/children-3/index.html" }, { "breadcrumb": "Shortcodes \u003e Children", - "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", + "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.", "description": "This is a hidden demo child page", "tags": [ - "children", - "the hidden" + "Children", + "a secret" ], "title": "page 4 (hidden)", "uri": "/hugo-theme-relearn/shortcodes/children/children-4/index.html" }, { "breadcrumb": "Tags", - "content": "This lists all pages that are hidden from the home page. This includes pages that define hidden=true in their frontmatter as well as descendents of hidden pages.\nWhen giving term pages, you should give it a title. Otherwise it will print out a warning and will use the urlized title, which may looks weird.\nWhile internally this term is called hidden, it is referenced in the resulting english pages as a secret and as hush, matey in the piratish translation.\nJust an example heading The TOC will contain this heading and the index headings below.\n", + "content": "This lists all pages that are hidden from the home page. This includes pages that define hidden=true in their frontmatter as well as descendents of hidden pages.\nWhen giving term pages, you should give it a title. Otherwise it will print out a warning and will use the urlized title, which may looks weird.\nWhile internally this term is called hidden, it is referenced in the resulting english pages as a secret and as hush, matey in the piratish translation.\nJust an example heading The TOC will contain this heading and the index headings below.", "description": "This lists all pages that are hidden from the home page.", - "tags": null, + "tags": [], "title": "Tag :: a secret", "uri": "/hugo-theme-relearn/tags/the-hidden/index.html" }, @@ -239,15 +241,15 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": " Warning This shortcode is deprecated in favor of the new resources shortcode. See migration instructions below.\nThe attachments shortcode displays a list of files attached to a page with adjustable color, title and icon.\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) Migration While this shortcode will still be available for some time, it does not receive support anymore. Start to migrate early, as it will be removed with the next major update of the theme.\nThe resources shortcode leverages Hugo’s resource feature for page bundles. It has all the same parameter as the attachments shortcode but applies the pattern directly on a resources Name attribute.\nTo migrate your pages apply the following steps:\nIf a page is not already a page bundle convert it Move your files to a valid destination inside of your page bundle (depending if you have a branch or a leaf bundle) Change the calls from the attachments shortcode to the resources shortcode and adjust the pattern parameter to the new directory layout and the resources Name attribute. Multilanguage features are not supported directly by the shortcode anymore but rely on Hugo’s handling for resource translations.\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"page\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent The style scheme used for the box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: Attachments\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: paperclip\nIf you want no icon, you have to set this parameter to \" \" (a non empty d with spaces) sort asc Sorting the output in ascending or descending order. pattern .* A regular expressions, used to filter the attachments by file name. For example:\n- to match a file suffix of ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- to match file names ending in jpg or png, use .*\\.(jpg|png) Setup Single language The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).\nIf your page is a leaf bundle, attachments must be placed in a nested index.files folder, accordingly.\ncontent _index.md page index.md index.files attachment.pdf If your page is a branch bundle, attachments must be placed in a nested _index.files folder, accordingly.\nWarning This is only available for Hugo \u003c 0.112.0\ncontent _index.md page _index.md _index.files attachment.pdf For simple pages, attachments must be placed in a folder named like your page and ending with .files.\nWarning This is only available for Hugo \u003c 0.112.0\ncontent _index.md page.files attachment.pdf page.md Multilingual Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.\nEg. for a site in English and Piratish:\ncontent index.en.md index.pir.md page index.en.md index.pir.md index.en.files attachment.pdf index.pir.files attachment.pdf ", "description": "List of files attached to a page", - "tags": null, + "tags": [], "title": "Attachments", "uri": "/hugo-theme-relearn/shortcodes/attachments/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The badge shortcode displays little markers in your text with adjustable color, title and icon.\nImportant Version6.6.6 Captain InfoNew Awesome\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default The style scheme used for the badge.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the badge title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text for the badge. Examples Style By Severity {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Breaking{{% /badge %}} InfoNew NoteChange TipOptional WarningBreaking\nBy Brand Colors {{% badge style=\"primary\" icon=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" icon=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" icon=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" icon=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"green\" icon=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" icon=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" icon=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" icon=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" icon=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" icon=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Icon and Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nWithout Icon {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}}Version6.6.6 InfoAwesome RankCaptain\nWithout Title Text {{% badge icon=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nAll Set {{% badge icon=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 InfoAwesome RankCaptain\nOverride for Severity {{% badge style=\"info\" icon=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome With Icon Content You can combine the badge with the icon shortcode to create even more stunning visuals.\nIn this case you need to declare {{\u003c badge \u003e}} instead of {{% badge %}}. Note, that in this case it is not possible to put markdown in the content.\n{{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}}\nPirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside of Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" icon=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\n", + "content": "The badge shortcode displays little markers in your text with adjustable color, title and icon.\nImportant Version6.6.6 Captain InfoNew Awesome\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default The style scheme used for the badge.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the badge title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text for the badge. Examples Style By Severity {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Breaking{{% /badge %}} InfoNew NoteChange TipOptional WarningBreaking\nBy Brand Colors {{% badge style=\"primary\" icon=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" icon=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" icon=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" icon=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"green\" icon=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" icon=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" icon=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" icon=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" icon=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" icon=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Icon and Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nWithout Icon {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" icon=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}}Version6.6.6 InfoAwesome RankCaptain\nWithout Title Text {{% badge icon=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nAll Set {{% badge icon=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" icon=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 InfoAwesome RankCaptain\nOverride for Severity {{% badge style=\"info\" icon=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content {{% badge color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome With Icon Content You can combine the badge with the icon shortcode to create even more stunning visuals.\nIn this case you need to declare {{\u003c badge \u003e}} instead of {{% badge %}}. Note, that in this case it is not possible to put markdown in the content.\n{{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" icon=\"angle-double-up\" title=\"Rank\" \u003e}}{{% icon skull-crossbones %}} Pirate{{\u003c /badge \u003e}}\nPirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside of Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" icon=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.", "description": "Marker badges to display in your text", - "tags": null, + "tags": [], "title": "Badge", "uri": "/hugo-theme-relearn/shortcodes/badge/index.html" }, @@ -255,7 +257,7 @@ var relearn_search_index = [ "breadcrumb": "Categories", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Category :: Basic", "uri": "/hugo-theme-relearn/categories/basic/index.html" }, @@ -263,7 +265,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The button shortcode displays a clickable button with adjustable color, title and icon.\nGet Hugo Get Hugo\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" icon=\"dragon\" %}}Get Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once the button is clicked, it opens another browser tab for the given URL.\nParameter Name Default Notes href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.\n- if starting with javascript: all following text will be executed in your browser\n- every other string will be interpreted as URL style transparent The style scheme used for the button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) iconposition left Places the icon to the left or right of the title. target see notes The destination frame/window if href is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:\n- the setting of externalLinkTarget or _blank if not set, for any address starting with http:// or https://\n- no specific value for all other links type see notes The button type if href is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to button \u003ccontent\u003e see notes Arbitrary text for the button title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo Get Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo\nIcon Empty {{% button href=\"https://gohugo.io/\" icon=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}{{% /button %}} To the Left {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}Get Hugo{{% /button %}} Get Hugo To the Right {{% button href=\"https://gohugo.io/\" icon=\"download\" iconposition=\"right\" %}}Get Hugo{{% /button %}}Get Hugo Override for Severity {{% button href=\"https://gohugo.io/\" icon=\"dragon\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Hugo in same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Hugo in new Window/Frame (default){{% /button %}}Get Hugo in same Window/Frame Get Hugo in new Window/Frame (default)\nOther With User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" %}}Get **Hugo**{{% /button %}} Get Hugo Severity Style with All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Tip Button to Internal Page {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button with JavaScript Action If your JavaScript action does not change the focus afterwards, make sure to call this.blur() in the end to unselect the button.\n{{% button style=\"primary\" icon=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element To use native HTML elements in your Markdown, add this in your hugo.toml\n[markup.goldmark.renderer] unsafe = true\u003cform action=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", "description": "Clickable buttons", - "tags": null, + "tags": [], "title": "Button", "uri": "/hugo-theme-relearn/shortcodes/button/index.html" }, @@ -271,7 +273,7 @@ var relearn_search_index = [ "breadcrumb": "", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categories", "uri": "/hugo-theme-relearn/categories/index.html" }, @@ -279,7 +281,7 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Children", "uri": "/hugo-theme-relearn/tags/children/index.html" }, @@ -287,7 +289,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The children shortcode lists the child pages of the current page and its descendants.\npage X page 1 page 2 page 3 Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% children sort=\"weight\" %}} {{ partial \"shortcodes/children.html\" (dict \"page\" . \"sort\" \"weight\" )}} Parameter Name Default Notes 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 as well. description false When true shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - read more info about summaries on gohugo.io. depth 1 The depth of descendants to display. For example, if the value is 2, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. 999. sort auto The sort criteria of the displayed list.\n- auto defaults to ordersectionsby of the pages frontmatter\nor to ordersectionsby of the site configuration\nor to weight\n- weight\n- title\n- linktitle\n- modifieddate\n- expirydate\n- publishdate\n- date\n- length\n- default adhering to Hugo’s default sort criteria Examples All Default {{% children %}} page X page 1 page 2 page 3 With Description {{% children description=\"true\" %}} page XThis is a plain page test, and the beginning of a YAML multiline description... page 1This is a demo child page\npage 2This is a demo child page with no description. So its content is used as description.\npage 3This is a demo child page\nInfinite Depth and Hidden Pages {{% 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 (headless) page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 page 4 (hidden) Heading Styles for Container and Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"true\" %}} page XThis is a plain page test, and the beginning of a YAML multiline description... page 1This is a demo child page\npage 1-1This is a demo child page\npage 1-1-2 (headless)This is a demo child page\npage 1-1-3This is a demo child page\npage 2This is a demo child page with no description. So its content is used as description.\npage 3This is a demo child page\npage 3-1This is a plain page test nested in a parent\nDivs for Group and Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} page X page 1 page 1-1 page 1-1-2 (headless) page 1-1-3 page 2 page 3 page 3-1 ", "description": "List the child pages of a page", - "tags": null, + "tags": [], "title": "Children", "uri": "/hugo-theme-relearn/shortcodes/children/index.html" }, @@ -295,7 +297,7 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Config", "uri": "/hugo-theme-relearn/tags/config/index.html" }, @@ -303,7 +305,7 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Content", "uri": "/hugo-theme-relearn/tags/content/index.html" }, @@ -311,7 +313,7 @@ var relearn_search_index = [ "breadcrumb": "Categories", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Category :: Content", "uri": "/hugo-theme-relearn/categories/content/index.html" }, @@ -319,7 +321,7 @@ var relearn_search_index = [ "breadcrumb": "Development", "content": "Code Quality A new release can happen at any time from the main branch of the GitHub project without further acknowledgment. This makes it necessary that, every pushed set of changesets into the main branch must be self-contained and correct, resulting in a releasable version.\nStay simple for the user by focusing on the mantra “convention over configuration”.\nAt installation the site should work reasonable without (m)any configuration.\nStay close to the Hugo way.\nDon’t use npm or any preprocessing, our contributors may not be front-end developers.\nDocument new features in the exampleSite. This also contains entries to the What’s new page.\nDon’t break existing features if you don’t have to.\nRemove reported issue from the browser’s console.\nCheck for unnecessary whitespace and correct indention of your resulting HTML.\nConventional Commits Write commit messages in the conventional commit format.\nFollowing is an inpomplete list of some of the used conventional commit types. Be creative.\nCommon Feature Structure Shortcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shortcodes i18n scrollbar expand theme mobile nav icon print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice openapi piratify siteparam tabs ", "description": "What to know if you want to contribute", - "tags": null, + "tags": [], "title": "Contributing", "uri": "/hugo-theme-relearn/dev/contributing/index.html" }, @@ -327,7 +329,7 @@ var relearn_search_index = [ "breadcrumb": "", "content": "Contributors Special thanks to everyone who has contributed to this project.\nMany thanks to Mathieu Cornic for his work on porting the Learn theme to Hugo.\nMany thanks to Andy Miller for initially creating the Learn theme for Grav.\nTheme Dependencies autoComplete - A lightweight and powerful vanilla JavaScript completion suggester clipboard.js - A modern approach to copy text to clipboard d3-zoom - Pan and zoom SVG, HTML or Canvas using mouse or touch input - plus dependencies d3-color - Color spaces! RGB, HSL, Cubehelix, CIELAB, and more d3-dispatch - Register named callbacks and call them with arguments d3-ease - Easing functions for smooth animation d3-interpolate - Interpolate numbers, colors, strings, arrays, objects, whatever d3-selection - Transform the DOM by selecting elements and joining to data d3-timer - An efficient queue for managing thousands of concurrent animations d3-transition - Animated transitions for D3 selections d3-drag - Drag and drop SVG, HTML or Canvas using mouse or touch input Font Awesome - The internet’s icon library and toolkit js-yaml - JavaScript YAML parser and dumper Lunr - Enables a great search experience without the need for external, server-side, search services Lunr Languages - A collection of languages stemmers and stopwords for Lunr Javascript library MathJax - Beautiful math and chemical formulae in all browsers Mermaid - Generation of diagram and flowchart from text in a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin SwaggerUI - Generate beautiful documentation from a Swagger-compliant API WorkSans - Work Sans is a 9 weight typeface family based loosely on early Grotesques Docs Dependencies github-buttons - Unofficial github:buttons Tooling Dependencies GitHub - Continuous deployment, testing and hosting of this project’s sources and its documentation Various GitHub Actions https://github.com/actions/checkout https://github.com/actions/setup-node https://github.com/Akkjon/close-milestone https://github.com/andstor/file-reader-action https://github.com/ashley-taylor/regex-property-action https://github.com/Kaven-Universe/github-action-current-date-time https://github.com/mingjun97/file-regex-replace https://github.com/octokit/graphql-action https://github.com/peaceiris/actions-gh-pages https://github.com/peaceiris/actions-hugo https://github.com/WyriHaximus/github-action-create-milestone https://github.com/WyriHaximus/github-action-next-semvers gren - A releasenotes generator for GitHub Hugo - The static site generator of your choice ", "description": "Contributors Special thanks to everyone who has contributed to this project.", - "tags": null, + "tags": [], "title": "Credits", "uri": "/hugo-theme-relearn/more/credits/index.html" }, @@ -335,7 +337,7 @@ var relearn_search_index = [ "breadcrumb": "Categories", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Category :: Custom", "uri": "/hugo-theme-relearn/categories/custom/index.html" }, @@ -343,15 +345,15 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Documentation", "uri": "/hugo-theme-relearn/tags/documentation/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The expand shortcode displays an expandable/collapsible section of text.\nExpand me… Thank you!\nThat’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank you!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank you!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank you!\" )}} Parameter Name Position Default Notes title 1 \"Expand me...\" Arbitrary text to appear next to the expand/collapse icon. open 2 false When true the content text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed on expand. Examples All Defaults {{% expand %}}Yes, you did it!{{% /expand %}} Expand me… Yes, you did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need to press you!{{% /expand %}} Expand me… No need to press you! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) {{% /expand %}} Show me almost endless possibilities You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work)\n", + "content": "The expand shortcode displays an expandable/collapsible section of text.\nExpand me… Thank you!\nThat’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank you!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank you!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank you!\" )}} Parameter Name Position Default Notes title 1 \"Expand me...\" Arbitrary text to appear next to the expand/collapse icon. open 2 false When true the content text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed on expand. Examples All Defaults {{% expand %}}Yes, you did it!{{% /expand %}} Expand me… Yes, you did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need to press you!{{% /expand %}} Expand me… No need to press you! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) {{% /expand %}} Show me almost endless possibilities You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work)", "description": "Expandable/collapsible sections of text", - "tags": null, + "tags": [], "title": "Expand", "uri": "/hugo-theme-relearn/shortcodes/expand/index.html" }, @@ -359,15 +361,15 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The highlight shortcode renders your code with a syntax highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode is fully compatible with Hugo’s highlight shortcode but offers some extensions.\nIt is called interchangeably in the same way as Hugo’s own shortcode providing positional parameter or by simply using codefences.\nYou are free to also call this shortcode from your own partials. In this case it resembles Hugo’s highlight function syntax if you call this shortcode as a partial using compatibility syntax.\nWhile the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Position Default Notes type 1 \u003cempty\u003e The language of the code to highlight. Choose from one of the supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title for code. This displays the code like a single tab if hl_inline=false (which is Hugo’s default). wrap see notes Extension. When true the content may wrap on long lines otherwise it will be scrollable.\nThe default value can be set in your hugo.toml and overwritten via frontmatter. See below. options 2 \u003cempty\u003e An optional, comma-separated list of zero or more Hugo supported options as well as extension parameter from this table. \u003coption\u003e \u003cempty\u003e Any of Hugo’s supported options. \u003ccontent\u003e \u003cempty\u003e Your code to highlight. Configuration Default values for Hugo’s supported options can be set via goldmark settings in your hugo.toml\nDefault values for extension options can be set via params settings in your hugo.toml or be overwritten by frontmatter for each individual page.\nGlobal Configuration File You can configure the color style used for code blocks in your color variants stylesheet file.\nRecommended Settings hugo. toml yaml json [markup] [markup.highlight] lineNumbersInTable = false noClasses = false markup: highlight: lineNumbersInTable: false noClasses: false { \"markup\": { \"highlight\": { \"lineNumbersInTable\": false, \"noClasses\": false } } } Optional Settings hugo. toml yaml json [params] highlightWrap = true params: highlightWrap: true { \"params\": { \"highlightWrap\": true } } Page’s Frontmatter ​ toml yaml json +++ highlightWrap = true +++ --- highlightWrap: true --- { \"highlightWrap\": true } Examples Line Numbers with Starting Offset As mentioned above, line numbers in a table layout will shift if code is wrapping, so better use inline. To make things easier for you, set lineNumbersInTable = false in your hugo.toml and add lineNos = true when calling the shortcode instead of the specific values table or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence with Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") With Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff ", "description": "Render code with a syntax highlighter", - "tags": null, + "tags": [], "title": "Highlight", "uri": "/hugo-theme-relearn/shortcodes/highlight/index.html" }, { "breadcrumb": "", - "content": " Hugo Relearn Theme A theme for Hugo designed for documentation.\n★ What’s new in the latest release ★\nMotivation The Relearn theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adapting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.\nFeatures Wide set of usage scenarios Responsive design for mobile usage Looks nice on paper (if it has to) Usable offline, no external dependencies Usable from your local file system via file:// protocol Support for the VSCode Front Matter extension for on-premise CMS capabilities Support for Open Graph, Schema and Twitter Cards Configurable theming and visuals Configurable brand images Automatic switch for light/dark variant depending on your OS settings Predefined light, dark and color variants User selectable variants Stylesheet generator Configurable syntax highlighting Unique theme features Print whole chapters or even the complete site In page search Site search Dedicated search page Taxonomy support Configurable topbar buttons Unlimited nested menu items Configurable shortcut links Hidden pages Multi language support Full support for languages written right to left Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support for mixed language content Additional Markdown features Support for GFM (GitHub Flavored Markdown) Image effects like sizing, shadow, border and alignment Image lightbox Shortcodes galore Display resources contained in a page bundle Marker badges Configurable buttons List child pages Expand areas to reveal content Font Awesome icons Inclusion of other files Math and chemical formulae using MathJax Mermaid diagrams for flowcharts, sequences, gantts, pie, etc. Colorful boxes OpenAPI specifications using Swagger UI Reveal you site’s configuration parameter Single tabbed panels and multiple tabbed panels Installation \u0026 Usage For a detailed description of the theme’s capabilities visit the official documentation.\nChangelog See the What’s New page for release highlights or the detailed change history for a complete list of changes.\nContributions You are most welcome to contribute bugfixes or new features. Check the contribution guidelines first before starting.\nLicense The Relearn theme is licensed under the MIT License.\nCredits This theme would not be possible without the work of many others.\n", + "content": " Hugo Relearn Theme A theme for Hugo designed for documentation.\n★ What’s new in the latest release ★\nMotivation The Relearn theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adapting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.\nFeatures Wide set of usage scenarios Responsive design for mobile usage Looks nice on paper (if it has to) Usable offline, no external dependencies Usable from your local file system via file:// protocol Support for the VSCode Front Matter extension for on-premise CMS capabilities Support for Open Graph, Schema and Twitter Cards Configurable theming and visuals Configurable brand images Automatic switch for light/dark variant depending on your OS settings Predefined light, dark and color variants User selectable variants Stylesheet generator Configurable syntax highlighting Unique theme features Print whole chapters or even the complete site In page search Site search Dedicated search page Taxonomy support Configurable topbar buttons Unlimited nested menu items Configurable shortcut links Hidden pages Multi language support Full support for languages written right to left Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support for mixed language content Additional Markdown features Support for GFM (GitHub Flavored Markdown) Image effects like sizing, shadow, border and alignment Image lightbox Shortcodes galore Display resources contained in a page bundle Marker badges Configurable buttons List child pages Expand areas to reveal content Font Awesome icons Inclusion of other files Math and chemical formulae using MathJax Mermaid diagrams for flowcharts, sequences, gantts, pie, etc. Colorful boxes OpenAPI specifications using Swagger UI Reveal you site’s configuration parameter Single tabbed panels and multiple tabbed panels Installation \u0026 Usage For a detailed description of the theme’s capabilities visit the official documentation.\nChangelog See the What’s New page for release highlights or the detailed change history for a complete list of changes.\nContributions You are most welcome to contribute bugfixes or new features. Check the contribution guidelines first before starting.\nLicense The Relearn theme is licensed under the MIT License.\nCredits This theme would not be possible without the work of many others.", "description": "A theme for Hugo designed for documentation.", - "tags": null, + "tags": [], "title": "Hugo Relearn Theme", "uri": "/hugo-theme-relearn/index.html" }, @@ -375,15 +377,15 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The icon shortcode displays icons using the Font Awesome library.\nUsage While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% icon icon=\"exclamation-triangle\" %}} {{% icon icon=\"angle-double-up\" %}} {{% icon icon=\"skull-crossbones\" %}} {{% icon exclamation-triangle %}} {{% icon angle-double-up %}} {{% icon skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Position Default Notes icon 1 \u003cempty\u003e Font Awesome icon name to be displayed. It will be displayed in the text color of its according context. Finding 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 icon name and paste into the Markdown content.\nCustomising Icons Font Awesome provides many ways to modify the icon\nChange color (by default the icon will inherit the parent color) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\nExamples Standard Usage Built with {{% icon heart %}} by Relearn and HugoBuilt with by Relearn and Hugo\nAdvanced HTML Usage While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. 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 HugoBuilt with by Relearn and Hugo\nTo use these native HTML elements in your Markdown, add this in your hugo.toml:\n[markup.goldmark.renderer] unsafe = true", "description": "Nice icons for your page", - "tags": null, + "tags": [], "title": "Icon", "uri": "/hugo-theme-relearn/shortcodes/icon/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The include shortcode includes other files from your project inside of the current page.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} The included files can even contain Markdown and will be taken into account when generating the table of contents.\nParameter Name Position Default Notes file 1 \u003cempty\u003e The path to the file to be included. Path resolution adheres to Hugo’s build-in readFile function hidefirstheading 2 false When true and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files. Examples Arbitrary Content {{% include \"shortcodes/include/INCLUDE_ME.md\" %}}You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc.1 ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” ↩︎\n", + "content": "The include shortcode includes other files from your project inside of the current page.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} The included files can even contain Markdown and will be taken into account when generating the table of contents.\nParameter Name Position Default Notes file 1 \u003cempty\u003e The path to the file to be included. Path resolution adheres to Hugo’s build-in readFile function hidefirstheading 2 false When true and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files. Examples Arbitrary Content {{% include \"shortcodes/include/INCLUDE_ME.md\" %}}You can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc.1 ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” ↩︎", "description": "Displays content from other files", - "tags": null, + "tags": [], "title": "Include", "uri": "/hugo-theme-relearn/shortcodes/include/index.html" }, @@ -391,7 +393,7 @@ var relearn_search_index = [ "breadcrumb": "Development", "content": "Semver This project tries to follow the semver policy - although not followed 100% in the past.\nUsually an entry of Breaking on the What’s new page causes a new major release number.\nAll other entries on the What’s new page will increase the minor release number.\nReleases resulting in a new major or minor number are called main release.\nReleases containing bugfixes only, are only increasing the patch release number. Those releases don’t result in announcements on the What’s new page.\nEntries on the What’s new page are checked and enforced during the version-release GitHub Action.\nManaging Issues Issues are categorized and managed by assigning labels to it.\nOnce working on an issue, assign it to a fitting maintainer.\nWhen done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.\nA once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.\nManaging Pull Requests If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.\nYou can assign multiple PRs to one issue as long as they belong together.\nUsually set the same labels and milestone for the PR as for the accompanied issue.\nLabels Kind An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.\nLabel Description Changelog section documentation Improvements or additions to documentation - discussion This issue was converted to a discussion - task Maintenance work Maintenance feature New feature or request Features bug Something isn’t working Fixes Impact If the issue would cause a new main release due to semver semantics it needs one of the according labels and the matching badge on the What’s new page.\nLabel Description change Introduces changes with existing installations breaking Introduces breaking changes with existing installations Declination If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.\nLabel Description duplicate This issue or pull request already exists invalid This doesn’t seem right support Solved by reconfiguring the authors site unresolved No progress on this issue update A documented change in behavior wontfix This will not be worked on Halt You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.\nLabel Description blocked Depends on other issue to be fixed first idea A valuable idea that’s currently not worked on undecided No decision was made yet helpwanted Great idea, send in a PR needsfeedback Further information is needed 3rd-Party If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.\nLabel Description browser This is a topic related to the browser but not the theme device This is a topic related to a certain device hugo This is a topic related to Hugo itself but not the theme mermaid This is a topic related to Mermaid itself but not the theme Making Releases A release is based on a milestone named like the release itself - just the version number, eg: 1.2.3. It’s in the maintainers responsibility to check semver semantics of the milestone’s name prior to release and change it if necessary.\nMaking releases is automated by the version-release GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the main branch of the repository.\nTreat released milestones as immutable. Don’t rerelease an already released milestone. An already released milestone may already been consumed by your users.\nDuring execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.\nThe following checks will be enforced\nthe milestone exists there is at least one closed issue assigned to the milestone all assigned issues for this milestone are closed if it’s a main release, there must be a new \u003cmajor\u003e.\u003cminor\u003e at the beginning of the What’s new page if it’s a patch release, there must be the \u003cmajor\u003e.\u003cminor\u003e from the previous release at the beginning of the What’s new page After a successful run of the action\nthe History page is updated, including release version, release date and text the What’s new page is updated, including release version, release date and text the version number for the \u003cmeta generator\u003e is updated the updated files are committed the milestone is closed the repository is tagged with the version number (eg. 1.2.3), the main version number (eg. 1.2.x) and the major version number (eg. 1.x) a new entry in the GitHub release list with the according changelog will be created the official documentation is built and deployed the version number for the \u003cmeta generator\u003e is updated to a temporary and committed (this helps to determine if users are running directly on the main branch or are using releases) a new milestone for the next patch release is created (this can later be renamed to a main release if necessary) ", "description": "What to know as a maintainer", - "tags": null, + "tags": [], "title": "Maintaining", "uri": "/hugo-theme-relearn/dev/maintaining/index.html" }, @@ -399,7 +401,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The math shortcode generates beautiful formatted math and chemical formulae using the MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Usage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\nMath is also usable without enclosing it in a shortcode or codefence but requires configuration by you. In this case no parameter from the below table are available.\n​ codefence shortcode partial passthrough ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Parameter Name Default Notes align center Allowed values are left, center or right. \u003ccontent\u003e \u003cempty\u003e Your formulae. Configuration MathJax is configured with default settings but you can customize MathJax’s default settings for all of your files through a JSON object in your hugo.toml or override these settings per page through your pages frontmatter.\nThe JSON object of your hugo.toml / frontmatter is forwarded into MathJax’s configuration object.\nSee MathJax documentation for all allowed settings.\nGlobal Configuration File This example reflects the default configuration also used if you don’t define mathJaxInitialize\nhugo. toml yaml json [params] mathJaxInitialize = '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' params: mathJaxInitialize: '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' { \"params\": { \"mathJaxInitialize\": \"{ \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"$\\\", \\\"$\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"$$\\\", \\\"$$\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } } Page’s Frontmatter Usually you don’t need to redefine the global initialization settings for a single page. But if you do, you have repeat all the values from your global configuration you want to keep for a single page as well.\nEg. If you have redefined the delimiters to something exotic like @ symbols in your global config, but want to additionally align your math to the left for a specific page, you have to put this to your frontmatter:\n​ toml yaml json +++ mathJaxInitialize = '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' +++ --- mathJaxInitialize: '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' --- { \"mathJaxInitialize\": \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" }, { \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"@\\\", \\\"@\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"@@\\\", \\\"@@\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } Passthrough Configuration You can use your math without enclosing it in a shortcode or codefence by using a passthrough configuration in your hugo.toml:\nhugo. toml yaml json [markup] [markup.goldmark] [markup.goldmark.extensions] [markup.goldmark.extensions.passthrough] enable = true [markup.goldmark.extensions.passthrough.delimiters] block = [['\\[', '\\]'], ['$$', '$$']] inline = [['\\(', '\\)'], ['$', '$']] markup: goldmark: extensions: passthrough: delimiters: block: - - \\[ - \\] - - $$ - $$ inline: - - \\( - \\) - - $ - $ enable: true { \"markup\": { \"goldmark\": { \"extensions\": { \"passthrough\": { \"delimiters\": { \"block\": [ [ \"\\\\[\", \"\\\\]\" ], [ \"$$\", \"$$\" ] ], \"inline\": [ [ \"\\\\(\", \"\\\\)\" ], [ \"$\", \"$\" ] ] }, \"enable\": true } } } } } In this case you have to tell the theme that your page contains math by setting this in your page’s frontmatter:\n​ toml yaml json +++ disableMathJax = false +++ --- disableMathJax: false --- { \"disableMathJax\": false } See the example on how it makes using math really easy.\nExamples Inline Math Inline math is generated if you use a single `$` as a delimiter around your formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math is generated if you use a single $ as a delimiter around your formulae: $\\sqrt{3}$\nBlocklevel Math with Right Alignment If you delimit your formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If you delimit your formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence You can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Passthrough This works for block as well as inline math but is only available if you are using the passthrough configuration.\nWith passthrough configuration you can just drop your math without enclosed by shortcodes or codefences but no settings from the parameter table are available.\n$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$ Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", "description": "Beautiful math and chemical formulae", - "tags": null, + "tags": [], "title": "Math", "uri": "/hugo-theme-relearn/shortcodes/math/index.html" }, @@ -407,7 +409,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The mermaid shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Usage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} The generated graphs can be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.\nParameter Name Default Notes align center Allowed values are left, center or right. zoom see notes Whether the graph is pan- and zoomable.\nIf not set the value is determined by the mermaidZoom setting of the site or the pages frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan and zoom active \u003ccontent\u003e \u003cempty\u003e Your Mermaid graph. Configuration Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files through a JSON object in your hugo.toml, override these settings per page through your pages frontmatter or override these setting per diagramm through diagram directives.\nThe JSON object of your hugo.toml / frontmatter is forwarded into Mermaid’s mermaid.initialize() function.\nSee Mermaid documentation for all allowed settings.\nThe theme setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in hugo.toml, frontmatter or diagram directives.\nGlobal Configuration File hugo. toml yaml json [params] mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true params: mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true { \"params\": { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } } Page’s Frontmatter ​ toml yaml json +++ mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true +++ --- mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true --- { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } Examples Flowchart with YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- 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}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram with Configuration Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! Class Diagram with Codefence Syntax ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned to the Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model with Non-Default Mermaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title 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}} 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 Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid Timeline {{\u003c mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] Block Diagram {{\u003c mermaid \u003e}} block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one in the middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px {{\u003c /mermaid \u003e}} block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one in the middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px ", "description": "Generate diagrams and flowcharts from text", - "tags": null, + "tags": [], "title": "Mermaid", "uri": "/hugo-theme-relearn/shortcodes/mermaid/index.html" }, @@ -415,15 +417,15 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Non-Hidden", "uri": "/hugo-theme-relearn/tags/non-hidden/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.\nThere may be pirates It is all about the boxes.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" icon=\"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It is all about the boxes.\" )}} Parameter Name Position Default Notes style 1 default The style scheme used for the box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title 2 see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon 3 see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in box. Examples By Severity Info with markup {{% notice style=\"info\" %}} An **information** disclaimer You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} Info An information disclaimer\nYou can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work)\nNote {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Note A notice disclaimer\nTip {{% notice style=\"tip\" %}} A **tip** disclaimer {{% /notice %}} Tip A tip disclaimer\nWarning {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Warning A warning disclaimer\nWarning with Non-Default Title and Icon {{% notice style=\"warning\" title=\"Here are dragons\" icon=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here are dragons A warning disclaimer\nWarning without a Title and Icon {{% notice style=\"warning\" title=\" \" icon=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary with Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary with Icon only {{% notice style=\"secondary\" icon=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title and Icon {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen with Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey with Icon only {{% notice style=\"grey\" icon=\"bug\" %}} A **grey** disclaimer {{% /notice %}} A grey disclaimer\nOrange with Title and Icon {{% notice style=\"orange\" title=\"Orange\" icon=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Orange A orange disclaimer\nRed without a Title and Icon {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default with Positional Parameter {{% notice default \"Pay Attention to this Note!\" \"skull-crossbones\" %}} Some serious information. {{% /notice %}} Pay Attention to this Note! Some serious information.\nTransparent with Title and Icon {{% notice style=\"transparent\" title=\"Pay Attention to this Note!\" icon=\"skull-crossbones\" %}} Some serious information. {{% /notice %}} Pay Attention to this Note! Some serious information.\nWith User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% notice color=\"fuchsia\" title=\"**Hugo**\" icon=\"fa-fw fab fa-hackerrank\" %}} Victor? Is it you? {{% /notice %}} Hugo Victor? Is it you?\n", + "content": "The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.\nThere may be pirates It is all about the boxes.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" icon=\"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It is all about the boxes.\" )}} Parameter Name Position Default Notes style 1 default The style scheme used for the box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title 2 see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon 3 see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in box. Examples By Severity Info with markup {{% notice style=\"info\" %}} An **information** disclaimer You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possibilities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} Info An information disclaimer\nYou can add standard markdown syntax:\nmultiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possibilities are endless (almost - including other shortcodes may or may not work)\nNote {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Note A notice disclaimer\nTip {{% notice style=\"tip\" %}} A **tip** disclaimer {{% /notice %}} Tip A tip disclaimer\nWarning {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Warning A warning disclaimer\nWarning with Non-Default Title and Icon {{% notice style=\"warning\" title=\"Here are dragons\" icon=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here are dragons A warning disclaimer\nWarning without a Title and Icon {{% notice style=\"warning\" title=\" \" icon=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary with Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary with Icon only {{% notice style=\"secondary\" icon=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title and Icon {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen with Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey with Icon only {{% notice style=\"grey\" icon=\"bug\" %}} A **grey** disclaimer {{% /notice %}} A grey disclaimer\nOrange with Title and Icon {{% notice style=\"orange\" title=\"Orange\" icon=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Orange A orange disclaimer\nRed without a Title and Icon {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default with Positional Parameter {{% notice default \"Pay Attention to this Note!\" \"skull-crossbones\" %}} Some serious information. {{% /notice %}} Pay Attention to this Note! Some serious information.\nTransparent with Title and Icon {{% notice style=\"transparent\" title=\"Pay Attention to this Note!\" icon=\"skull-crossbones\" %}} Some serious information. {{% /notice %}} Pay Attention to this Note! Some serious information.\nWith User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% notice color=\"fuchsia\" title=\"**Hugo**\" icon=\"fa-fw fab fa-hackerrank\" %}} Victor? Is it you? {{% /notice %}} Hugo Victor? Is it you?", "description": "Disclaimers to help you structure your page", - "tags": null, + "tags": [], "title": "Notice", "uri": "/hugo-theme-relearn/shortcodes/notice/index.html" }, @@ -431,7 +433,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The openapi shortcode uses the Swagger UI library to display your OpenAPI / Swagger specifications.\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{\u003c openapi src=\"https://petstore3.openapi.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/openapi.html\" (dict \"page\" . \"src\" \"https://petstore3.openapi.io/api/v3/openapi.json\" )}} Parameter Name Default Notes src \u003cempty\u003e The URL to the OpenAPI specification file. This can be relative to the URL of your page if it is a leaf or branch bundle. Note If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.\nInstead, open the print preview in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.\nExample Using Local File {{\u003c openapi src=\"petstore.json\" \u003e}} ", "description": "UI for your OpenAPI / Swagger specifications", - "tags": null, + "tags": [], "title": "OpenAPI", "uri": "/hugo-theme-relearn/shortcodes/openapi/index.html" }, @@ -440,8 +442,8 @@ var relearn_search_index = [ "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 (headless) page 1-1-3 ", "description": "This is a demo child page", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 1-1", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html" @@ -451,8 +453,8 @@ var relearn_search_index = [ "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", - "the hidden" + "Children", + "a secret" ], "title": "page 1-1-1 (hidden)", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" @@ -462,8 +464,8 @@ var relearn_search_index = [ "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", - "the hidden" + "Children", + "a secret" ], "title": "page 1-1-1-1", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html" @@ -473,96 +475,96 @@ var relearn_search_index = [ "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", - "the hidden" + "Children", + "a secret" ], "title": "page 1-1-1-1-1 (hidden)", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html" }, { "breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-1 (hidden) \u003e page 1-1-1-1 \u003e page 1-1-1-1-1 (hidden)", - "content": "This is a non-hidden demo child page of a hidden parent page.\n", + "content": "This is a non-hidden demo child page of a hidden parent page.", "description": "This is a non-hidden demo child page of a hidden parent page", "tags": [ - "children", - "the hidden" + "Children", + "a secret" ], "title": "page 1-1-1-1-1-1", "uri": "/hugo-theme-relearn/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" }, { "breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-2 (headless)", - "content": "This is a plain demo child page.\n", + "content": "This is a plain demo child page.", "description": "This is a demo child page", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 1-1-2-1", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" }, { "breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1 \u003e page 1-1-2 (headless)", - "content": "This is a plain demo child page.\n", + "content": "This is a plain demo child page.", "description": "This is a demo child page", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 1-1-2-2", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" }, { "breadcrumb": "Shortcodes \u003e Children \u003e page 1 \u003e page 1-1", - "content": "This is a plain demo child page.\n", + "content": "This is a plain demo child page.", "description": "This is a demo child page", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 1-1-3", "uri": "/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" }, { "breadcrumb": "Shortcodes \u003e Children \u003e page 3", - "content": "This is a plain demo child page.\n", + "content": "This is a plain demo child page.", "description": "This is a plain page test nested in a parent", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "page 3-1", "uri": "/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The resources shortcode displays the titles of resources contained in a page bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features are not supported directly by the shortcode but rely on Hugo’s handling for resource translations applied when the theme iterates over all available resources.\nParameter Name Default Notes style transparent The style scheme used for the box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: Resources\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: paperclip\nIf you want no icon, you have to set this parameter to \" \" (a non empty d with spaces) sort asc Sorting the output in ascending or descending order. pattern .* A regular expressions, used to filter the resources by name. For example:\n- to match a file suffix of ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- to match file names ending in jpg or png, use .*\\.(jpg|png) Examples Custom Title, List of Resources Ending in png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Info Styled Box, Descending Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Info Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) With User-Defined Color and Font Awesome Brand Icon {{% resources color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title and Icons For further examples for style, color, title and icon, see the notice shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.\n", + "content": "The resources shortcode displays the titles of resources contained in a page bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features are not supported directly by the shortcode but rely on Hugo’s handling for resource translations applied when the theme iterates over all available resources.\nParameter Name Default Notes style transparent The style scheme used for the box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: Resources\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: paperclip\nIf you want no icon, you have to set this parameter to \" \" (a non empty d with spaces) sort asc Sorting the output in ascending or descending order. pattern .* A regular expressions, used to filter the resources by name. For example:\n- to match a file suffix of ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- to match file names ending in jpg or png, use .*\\.(jpg|png) Examples Custom Title, List of Resources Ending in png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Info Styled Box, Descending Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Info Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) With User-Defined Color and Font Awesome Brand Icon {{% resources color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title and Icons For further examples for style, color, title and icon, see the notice shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.", "description": "List resources contained in a page bundle", - "tags": null, + "tags": [], "title": "Resources", "uri": "/hugo-theme-relearn/shortcodes/resources/index.html" }, { "breadcrumb": "Development", - "content": "Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings\nCommon Creation:\nUse English translation Empty search Remove history checkmarks but leave it on the page thats used for the screenshot After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position Demo Screenshot Content:\nA meaningful full-screen screenshot of an interesting page.\nThe content should be:\ntimeless: not showing any dates or often edited content interesting: show a bunch of interesting elements like headings, code, etc balanced: no cluttering with overpresent elements or coloring aligned: aligned outlines Used by:\nHugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Page URL: Screenshot Link\nCreation:\nsave as images/screenshot.png Remarks:\nThe location is mandatory due to Hugo’s theme site builder.\nPreview images/screenshot.png:\nHero Image Content:\nShow the Demo Screenshot page on different devices and different themes. Composition of the different device screenshots into a template.\nThe content should be:\nconsistent: always use the same page for all devices pleasing: use a delightful background Used by:\nHugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project site: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/settings 1280 x 640 Page URL: Hero Image Link\nCreation:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize to 2700 x 1800 centered, scale to 900 x 600 and save as images/tn.png From original template size resize to 3000 x 1500 offset y: -330, scale to 1280 x 640 and save as images/hero.png Remarks:\nThe location of images/tn.png is mandatory due to Hugo’s theme site builder.\nPreview images/hero.png:\nPreview images/tn.png:\n", + "content": "Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings\nCommon Creation:\nUse English translation Empty search Remove history checkmarks but leave it on the page thats used for the screenshot After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position Demo Screenshot Content:\nA meaningful full-screen screenshot of an interesting page.\nThe content should be:\ntimeless: not showing any dates or often edited content interesting: show a bunch of interesting elements like headings, code, etc balanced: no cluttering with overpresent elements or coloring aligned: aligned outlines Used by:\nHugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Page URL: Screenshot Link\nCreation:\nsave as images/screenshot.png Remarks:\nThe location is mandatory due to Hugo’s theme site builder.\nPreview images/screenshot.png:\nHero Image Content:\nShow the Demo Screenshot page on different devices and different themes. Composition of the different device screenshots into a template.\nThe content should be:\nconsistent: always use the same page for all devices pleasing: use a delightful background Used by:\nHugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project site: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/settings 1280 x 640 Page URL: Hero Image Link\nCreation:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize to 2700 x 1800 centered, scale to 900 x 600 and save as images/tn.png From original template size resize to 3000 x 1500 offset y: -330, scale to 1280 x 640 and save as images/hero.png Remarks:\nThe location of images/tn.png is mandatory due to Hugo’s theme site builder.\nPreview images/hero.png:\nPreview images/tn.png:", "description": "Recipe to create various documentation screenshots", - "tags": null, + "tags": [], "title": "Screenshots", "uri": "/hugo-theme-relearn/dev/screenshots/index.html" }, { "breadcrumb": "Shortcodes", - "content": "The siteparam shortcode prints values of site params.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Position Default Notes name 1 \u003cempty\u003e The name of the site param to be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested parameter with Markdown and HTML formatting To use formatted parameter, add this in your hugo.toml:\nhugo. toml yaml json [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true markup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values containing Markdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested option \u003cb\u003ewith\u003c/b\u003e formatting\n", + "content": "The siteparam shortcode prints values of site params.\nUsage While the examples are using shortcodes with named parameter you are free to use positional as well or call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Position Default Notes name 1 \u003cempty\u003e The name of the site param to be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested parameter with Markdown and HTML formatting To use formatted parameter, add this in your hugo.toml:\nhugo. toml yaml json [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true markup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values containing Markdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested option \u003cb\u003ewith\u003c/b\u003e formatting", "description": "Get value of site params", - "tags": null, + "tags": [], "title": "SiteParam", "uri": "/hugo-theme-relearn/shortcodes/siteparam/index.html" }, { "breadcrumb": "Shortcodes", - "content": "You can use a tab shortcode to display a single tab.\nThis is especially useful if you want to flag your code example with an explicit language.\nIf you want multiple tabs grouped together you can wrap your tabs into the tabs shortcode.\n​ c printf(\"Hello World!\"); Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderString) )}} Parameter Name Default Notes style see notes The style scheme used for the tab. If you don’t set a style and you display a single code block inside of the tab, its default styling will adapt to that of a code block. Otherwise default is used.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary title for the tab. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in the tab. Examples Single Code Block with Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Markdown Content {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **and** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text and code will get a margin.\nprintf(\"Hello World!\"); Understanding style and color Behavior The style parameter affects how the color parameter is applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} The `style` parameter is set to a color style. This will set the background to a lighter version of the chosen style color as configured in your theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only the `color` parameter is set. This will set the background to a lighter version of the chosen CSS color value. {{% /tab %}} {{% tab title=\"default style and color\" style=\"default\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. The `default` style will set the background to your `--MAIN-BG-color` as configured for your theme variant resembling the default style but with different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} The `style` parameter is set to a severity style. This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon. {{% /tab %}} {{% tab title=\"severity style and color\" style=\"info\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style and color just severity style severity style and color The style parameter is set to a color style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant.\nOnly the color parameter is set.\nThis will set the background to a lighter version of the chosen CSS color value.\nThe style parameter affects how the color parameter is applied.\nThe default style will set the background to your --MAIN-BG-color as configured for your theme variant resembling the default style but with different color.\nThe style parameter is set to a severity style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.\nThe style parameter affects how the color parameter is applied.\nThis will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.\n", + "content": "You can use a tab shortcode to display a single tab.\nThis is especially useful if you want to flag your code example with an explicit language.\nIf you want multiple tabs grouped together you can wrap your tabs into the tabs shortcode.\n​ c printf(\"Hello World!\"); Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderString) )}} Parameter Name Default Notes style see notes The style scheme used for the tab. If you don’t set a style and you display a single code block inside of the tab, its default styling will adapt to that of a code block. Otherwise default is used.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color title see notes Arbitrary title for the tab. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text to be displayed in the tab. Examples Single Code Block with Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Markdown Content {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **and** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text and code will get a margin.\nprintf(\"Hello World!\"); Understanding style and color Behavior The style parameter affects how the color parameter is applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} The `style` parameter is set to a color style. This will set the background to a lighter version of the chosen style color as configured in your theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only the `color` parameter is set. This will set the background to a lighter version of the chosen CSS color value. {{% /tab %}} {{% tab title=\"default style and color\" style=\"default\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. The `default` style will set the background to your `--MAIN-BG-color` as configured for your theme variant resembling the default style but with different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} The `style` parameter is set to a severity style. This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon. {{% /tab %}} {{% tab title=\"severity style and color\" style=\"info\" color=\"blue\" %}} The `style` parameter affects how the `color` parameter is applied. This will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style and color just severity style severity style and color The style parameter is set to a color style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant.\nOnly the color parameter is set.\nThis will set the background to a lighter version of the chosen CSS color value.\nThe style parameter affects how the color parameter is applied.\nThe default style will set the background to your --MAIN-BG-color as configured for your theme variant resembling the default style but with different color.\nThe style parameter is set to a severity style.\nThis will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.\nThe style parameter affects how the color parameter is applied.\nThis will set the background to a lighter version of the chosen CSS color value and also affects the chosen icon.", "description": "Show content in a single tab", - "tags": null, + "tags": [], "title": "Tab", "uri": "/hugo-theme-relearn/shortcodes/tab/index.html" }, @@ -570,7 +572,7 @@ var relearn_search_index = [ "breadcrumb": "Shortcodes", "content": "The tabs shortcode displays arbitrary content in an unlimited number of tabs.\nThis comes in handy eg. for providing code snippets for multiple languages.\nIf you just want a single tab you can instead call the tab shortcode standalone.\nhello. py sh c print(\"Hello World!\") echo \"Hello World!\" printf(\"Hello World!\"); Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\nSee the tab shortcode for a description of the parameter for nested tabs.\n​ shortcode partial {{\u003c tabs title=\"hello.\" \u003e}} {{% tab title=\"py\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"sh\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{% tab title=\"c\" %}} ```c printf\"Hello World!\"); ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"page\" . \"title\" \"hello.\" \"content\" (slice (dict \"title\" \"py\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | .RenderString) ) (dict \"title\" \"sh\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | .RenderString) ) (dict \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\");\\n```\" | .RenderString) ) ) )}} Parameter Name Default Notes groupid \u003crandom\u003e Arbitrary name of the group the tab view belongs to.\nTab views with the same groupid sychronize their selected tab. The tab selection is restored automatically based on the groupid for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.\nThis sychronization applies to the whole site! style \u003cempty\u003e Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values. color \u003cempty\u003e Sets a default value for every contained tab. Can be overridden by each tab. See the tab shortcode for possible values. title \u003cempty\u003e Arbitrary title written in front of the tab view. icon \u003cempty\u003e Font Awesome icon name set to the left of the title. \u003ccontent\u003e \u003cempty\u003e Arbitrary number of tabs defined with the tab sub-shortcode. Examples Behavior of the groupid See what happens to the tab views while you select different tabs.\nWhile pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.\n​ Group A, Tab View 1 Group A, Tab View 2 Group B {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"_**XML**_ stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab title=\"text\" %}} Hello World {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"b\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} Group A, Tab View 1 ​ json XML stuff text 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello World Group A, Tab View 2 ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Group B ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Nested Tab Views and Color In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with {{\u003c tab \u003e}} instead of {{% tab %}}. Note, that in this case it is not possible to put markdown in the parent tab.\nYou can also set style and color parameter for all tabs and overwrite them on tab level. See the tab shortcode for possible values.\n{{\u003c tabs groupid=\"main\" style=\"primary\" title=\"Rationale\" icon=\"thumbtack\" \u003e}} {{\u003c tab title=\"Text\" \u003e}} Simple text is possible here... {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} Python is **super** easy. - most of the time. - if you don't want to output unicode {{% /tab %}} {{% tab title=\"bash\" %}} Bash is for **hackers**. {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c tab title=\"Code\" style=\"default\" color=\"darkorchid\" \u003e}} ...but no markdown {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c /tabs \u003e}} Rationale Text Code Simple text is possible here... ​ python bash Python is super easy.\nmost of the time. if you don’t want to output unicode Bash is for hackers.\n...but no markdown ​ python bash print(\"Hello World!\") echo \"Hello World!\" ", "description": "Show content in tabbed views", - "tags": null, + "tags": [], "title": "Tabs", "uri": "/hugo-theme-relearn/shortcodes/tabs/index.html" }, @@ -578,7 +580,7 @@ var relearn_search_index = [ "breadcrumb": "Categories", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Category :: Taxonomy", "uri": "/hugo-theme-relearn/categories/taxonomy/index.html" }, @@ -586,7 +588,7 @@ var relearn_search_index = [ "breadcrumb": "Categories", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Category :: Theming", "uri": "/hugo-theme-relearn/categories/theming/index.html" }, @@ -594,7 +596,7 @@ var relearn_search_index = [ "breadcrumb": "Tags", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tag :: Tutorial", "uri": "/hugo-theme-relearn/tags/tutorial/index.html" } diff --git a/index.xml b/index.xml index 3898a61a25..d26eaea369 100644 --- a/index.xml +++ b/index.xml @@ -3,7 +3,7 @@ Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/index.html - Recent content on Hugo Relearn Theme + A theme for Hugo designed for documentation. Hugo en diff --git a/more/credits/index.html b/more/credits/index.html index eaae98414e..772ff9b512 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/more/credits/index.print.html b/more/credits/index.print.html index 60d89226b2..5244a622ca 100644 --- a/more/credits/index.print.html +++ b/more/credits/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/more/credits/index.xml b/more/credits/index.xml index 9c3f9cfca8..d0be994573 100644 --- a/more/credits/index.xml +++ b/more/credits/index.xml @@ -1,9 +1,9 @@ - Credits on Hugo Relearn Theme + Credits :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/more/credits/index.html - Recent content in Credits on Hugo Relearn Theme + Contributors Special thanks to everyone who has contributed to this project. Hugo en diff --git a/pir/404.html b/pir/404.html index 81ccfe96b8..51e249bd17 100644 --- a/pir/404.html +++ b/pir/404.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ 404 Page not found :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/branding/index.print.html b/pir/basics/branding/index.print.html index d9fa7b7125..105fdc7ae2 100644 --- a/pir/basics/branding/index.print.html +++ b/pir/basics/branding/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/branding/index.xml b/pir/basics/branding/index.xml index b4fea92392..62536897b3 100644 --- a/pir/basics/branding/index.xml +++ b/pir/basics/branding/index.xml @@ -1,9 +1,9 @@ - Brrrand'n on Cap'n Hugo Relearrrn Theme + Brrrand'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html - Recent content in Brrrand'n on Cap'n Hugo Relearrrn Theme + Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. Hugo art-pir diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index 8a2e61b75c..8f77517ce9 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/configuration/index.print.html b/pir/basics/configuration/index.print.html index 3406df9839..068107ec4f 100644 --- a/pir/basics/configuration/index.print.html +++ b/pir/basics/configuration/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/index.xml b/pir/basics/configuration/index.xml index 462a17ea50..fabda45e18 100644 --- a/pir/basics/configuration/index.xml +++ b/pir/basics/configuration/index.xml @@ -1,9 +1,9 @@ - Configurrrat'n on Cap'n Hugo Relearrrn Theme + Configurrrat'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html - Recent content in Configurrrat'n on Cap'n Hugo Relearrrn Theme + On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo. Hugo art-pir diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index 348fc4c250..6a0f4fdf1c 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/customization/index.print.html b/pir/basics/customization/index.print.html index bd3dda77a1..c2ccb5cc52 100644 --- a/pir/basics/customization/index.print.html +++ b/pir/basics/customization/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/customization/index.xml b/pir/basics/customization/index.xml index 5e6504779f..20256ef7e0 100644 --- a/pir/basics/customization/index.xml +++ b/pir/basics/customization/index.xml @@ -1,9 +1,9 @@ - Customizat'n on Cap'n Hugo Relearrrn Theme + Customizat'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html - Recent content in Customizat'n on Cap'n Hugo Relearrrn Theme + Usage scenarios Th' theme be us'ble 'n different scenarios, requir'n th' follow'n mandatory sett'ns 'n yer hugo. Hugo art-pir diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index 805b07e524..ffb0b4bd92 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/generator/index.print.html b/pir/basics/generator/index.print.html index 00836df560..c7fb58b93e 100644 --- a/pir/basics/generator/index.print.html +++ b/pir/basics/generator/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/generator/index.xml b/pir/basics/generator/index.xml index 8d23ad3fa8..98e4dd6d2d 100644 --- a/pir/basics/generator/index.xml +++ b/pir/basics/generator/index.xml @@ -1,9 +1,9 @@ - Stylesheet generrrat'r on Cap'n Hugo Relearrrn Theme + Stylesheet generrrat'r :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/generator/index.html - Recent content in Stylesheet generrrat'r on Cap'n Hugo Relearrrn Theme + This interactive tool may help ye t' generate yer own color variant stylesheet. Hugo art-pir diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index c468677c22..fe2a4a2bcf 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -5,21 +5,21 @@ - + - + - + - + Historrry :: Cap'n Hugo Relearrrn Theme @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/history/index.print.html b/pir/basics/history/index.print.html index d42506d72d..111e2d57cb 100644 --- a/pir/basics/history/index.print.html +++ b/pir/basics/history/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + Historrry :: Cap'n Hugo Relearrrn Theme @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/history/index.xml b/pir/basics/history/index.xml index 731980c889..1932eecfe2 100644 --- a/pir/basics/history/index.xml +++ b/pir/basics/history/index.xml @@ -1,9 +1,9 @@ - Historrry on Cap'n Hugo Relearrrn Theme + Historrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/history/index.html - Recent content in Historrry on Cap'n Hugo Relearrrn Theme + Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo’s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use . Hugo art-pir diff --git a/pir/basics/index.html b/pir/basics/index.html index c1ae3c738b..078c37bb6e 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/index.print.html b/pir/basics/index.print.html index 98a4dbb718..77406eb14c 100644 --- a/pir/basics/index.print.html +++ b/pir/basics/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/index.xml b/pir/basics/index.xml index eb7f3bb349..101528fda5 100644 --- a/pir/basics/index.xml +++ b/pir/basics/index.xml @@ -1,9 +1,9 @@ - Basics on Cap'n Hugo Relearrrn Theme + Basics :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/index.html - Recent content in Basics on Cap'n Hugo Relearrrn Theme + Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it. Hugo art-pir @@ -33,14 +33,14 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html - On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo. + On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo. Brrrand'n https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html - Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. + Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. Customizat'n @@ -68,7 +68,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/basics/history/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/history/index.html - Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo’s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use . + Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo’s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use . \ No newline at end of file diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index 4fe70fc170..26b2b642d2 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/installation/index.print.html b/pir/basics/installation/index.print.html index 9986b5a07a..c635e47769 100644 --- a/pir/basics/installation/index.print.html +++ b/pir/basics/installation/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/installation/index.xml b/pir/basics/installation/index.xml index bb035f9e27..d031ef2013 100644 --- a/pir/basics/installation/index.xml +++ b/pir/basics/installation/index.xml @@ -1,9 +1,9 @@ - Installat'n on Cap'n Hugo Relearrrn Theme + Installat'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/installation/index.html - Recent content in Installat'n on Cap'n Hugo Relearrrn Theme + Th' follow'n steps be here t' help ye initialize yer new website. Hugo art-pir diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index 5d6c2c9078..ddc011acbb 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/migration/index.print.html b/pir/basics/migration/index.print.html index 315e469f71..3a9e3d4bac 100644 --- a/pir/basics/migration/index.print.html +++ b/pir/basics/migration/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/migration/index.xml b/pir/basics/migration/index.xml index 4a022639b3..f24ded0a10 100644 --- a/pir/basics/migration/index.xml +++ b/pir/basics/migration/index.xml @@ -1,9 +1,9 @@ - What's New on Cap'n Hugo Relearrrn Theme + What's New :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/migration/index.html - Recent content in What's New on Cap'n Hugo Relearrrn Theme + Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Hugo art-pir diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index c7545fd4c6..edad57d9e5 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/requirements/index.print.html b/pir/basics/requirements/index.print.html index c21396daa5..58091d3b87 100644 --- a/pir/basics/requirements/index.print.html +++ b/pir/basics/requirements/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/requirements/index.xml b/pir/basics/requirements/index.xml index a6178f85b5..0fcef4bea6 100644 --- a/pir/basics/requirements/index.xml +++ b/pir/basics/requirements/index.xml @@ -1,9 +1,9 @@ - Requirrrements on Cap'n Hugo Relearrrn Theme + Requirrrements :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/requirements/index.html - Recent content in Requirrrements on Cap'n Hugo Relearrrn Theme + Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements. Hugo art-pir diff --git a/pir/basics/topbar/index.html b/pir/basics/topbar/index.html index 098429a8ea..d1abd08407 100644 --- a/pir/basics/topbar/index.html +++ b/pir/basics/topbar/index.html @@ -32,18 +32,18 @@ Nevertheless, yer requirements may differ from this configurat'n."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/topbar/index.print.html b/pir/basics/topbar/index.print.html index 12331a9cdc..d921843060 100644 --- a/pir/basics/topbar/index.print.html +++ b/pir/basics/topbar/index.print.html @@ -32,19 +32,19 @@ Nevertheless, yer requirements may differ from this configurat'n."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/topbar/index.xml b/pir/basics/topbar/index.xml index 2495ef1b32..11e8b9df1a 100644 --- a/pir/basics/topbar/index.xml +++ b/pir/basics/topbar/index.xml @@ -1,9 +1,9 @@ - Topbarrr Modificat'n on Cap'n Hugo Relearrrn Theme + Topbarrr Modificat'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/basics/topbar/index.html - Recent content in Topbarrr Modificat'n on Cap'n Hugo Relearrrn Theme + Th' theme comes wit' a reasonably configured topbar. Nevertheless, yer requirements may differ from this configurat'n. Hugo art-pir diff --git a/pir/categories/basic/index.html b/pir/categories/basic/index.html index 4aa4514990..2d1276acf0 100644 --- a/pir/categories/basic/index.html +++ b/pir/categories/basic/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/basic/index.xml b/pir/categories/basic/index.xml index 1edb1e8bab..b93b347519 100644 --- a/pir/categories/basic/index.xml +++ b/pir/categories/basic/index.xml @@ -1,9 +1,9 @@ - Basic on Cap'n Hugo Relearrrn Theme + Basic :: Categorrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/basic/index.html - Recent content in Basic on Cap'n Hugo Relearrrn Theme + Hugo art-pir diff --git a/pir/categories/content/index.html b/pir/categories/content/index.html index ef03121412..cbe4da2c70 100644 --- a/pir/categories/content/index.html +++ b/pir/categories/content/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/content/index.xml b/pir/categories/content/index.xml index 8c80f976bd..165548e1ae 100644 --- a/pir/categories/content/index.xml +++ b/pir/categories/content/index.xml @@ -1,9 +1,9 @@ - Content on Cap'n Hugo Relearrrn Theme + Content :: Categorrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/content/index.html - Recent content in Content on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html - Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. + Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. \ No newline at end of file diff --git a/pir/categories/custom/index.html b/pir/categories/custom/index.html index da3e55dc92..3b9b22f8d2 100644 --- a/pir/categories/custom/index.html +++ b/pir/categories/custom/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.xml b/pir/categories/custom/index.xml index 6d429a62ac..82d3ccb8ec 100644 --- a/pir/categories/custom/index.xml +++ b/pir/categories/custom/index.xml @@ -1,9 +1,9 @@ - Custom on Cap'n Hugo Relearrrn Theme + Custom :: Categorrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/custom/index.html - Recent content in Custom on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html - Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. + Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. \ No newline at end of file diff --git a/pir/categories/index.html b/pir/categories/index.html index 9bb80c1c06..6cfed44a83 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/index.xml b/pir/categories/index.xml index ab631c93b0..810d2c9144 100644 --- a/pir/categories/index.xml +++ b/pir/categories/index.xml @@ -1,42 +1,42 @@ - Categories on Cap'n Hugo Relearrrn Theme + Categorrries :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/index.html - Recent content in Categories on Cap'n Hugo Relearrrn Theme + Hugo art-pir - Basic + Categorrry :: Basic https://mcshelby.github.io/hugo-theme-relearn/pir/categories/basic/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/categories/basic/index.html - Content + Categorrry :: Content https://mcshelby.github.io/hugo-theme-relearn/pir/categories/content/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/categories/content/index.html - Custom + Categorrry :: Custom https://mcshelby.github.io/hugo-theme-relearn/pir/categories/custom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/categories/custom/index.html - Taxonomy + Categorrry :: Taxonomy https://mcshelby.github.io/hugo-theme-relearn/pir/categories/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/categories/taxonomy/index.html - Theming + Categorrry :: Theming https://mcshelby.github.io/hugo-theme-relearn/pir/categories/theming/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/categories/theming/index.html diff --git a/pir/categories/taxonomy/index.html b/pir/categories/taxonomy/index.html index f7e07bb254..9ff8e2b02e 100644 --- a/pir/categories/taxonomy/index.html +++ b/pir/categories/taxonomy/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/taxonomy/index.xml b/pir/categories/taxonomy/index.xml index c069b9970f..2e8ced078f 100644 --- a/pir/categories/taxonomy/index.xml +++ b/pir/categories/taxonomy/index.xml @@ -1,9 +1,9 @@ - Taxonomy on Cap'n Hugo Relearrrn Theme + Taxonomy :: Categorrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/taxonomy/index.html - Recent content in Taxonomy on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html - Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. + Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. \ No newline at end of file diff --git a/pir/categories/theming/index.html b/pir/categories/theming/index.html index 3e831b9ea0..7ad15d2f27 100644 --- a/pir/categories/theming/index.html +++ b/pir/categories/theming/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.xml b/pir/categories/theming/index.xml index 1fa24b966a..fc8a069d5a 100644 --- a/pir/categories/theming/index.xml +++ b/pir/categories/theming/index.xml @@ -1,9 +1,9 @@ - Theming on Cap'n Hugo Relearrrn Theme + Theming :: Categorrry :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/categories/theming/index.html - Recent content in Theming on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html - Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. + Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. Stylesheet generrrat'r diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index 0085aa371c..853f8cd45d 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/archetypes/index.print.html b/pir/cont/archetypes/index.print.html index 4dd12da72f..4ac97a4e05 100644 --- a/pir/cont/archetypes/index.print.html +++ b/pir/cont/archetypes/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/archetypes/index.xml b/pir/cont/archetypes/index.xml index e7e0494326..0c891cd742 100644 --- a/pir/cont/archetypes/index.xml +++ b/pir/cont/archetypes/index.xml @@ -1,9 +1,9 @@ - Arrrchetypes on Cap'n Hugo Relearrrn Theme + Arrrchetypes :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/archetypes/index.html - Recent content in Arrrchetypes on Cap'n Hugo Relearrrn Theme + Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. Hugo art-pir diff --git a/pir/cont/frontmatter/index.html b/pir/cont/frontmatter/index.html index c4ce5cf490..ea63979f25 100644 --- a/pir/cont/frontmatter/index.html +++ b/pir/cont/frontmatter/index.html @@ -32,18 +32,18 @@ All Frontmatter Opt'ns Th' values reflect example opt'ns."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/frontmatter/index.print.html b/pir/cont/frontmatter/index.print.html index a624612aa5..9faeaac044 100644 --- a/pir/cont/frontmatter/index.print.html +++ b/pir/cont/frontmatter/index.print.html @@ -32,19 +32,19 @@ All Frontmatter Opt'ns Th' values reflect example opt'ns."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/frontmatter/index.xml b/pir/cont/frontmatter/index.xml index 80cebde2d1..b93c6a480f 100644 --- a/pir/cont/frontmatter/index.xml +++ b/pir/cont/frontmatter/index.xml @@ -1,9 +1,9 @@ - Frrrontmatter on Cap'n Hugo Relearrrn Theme + Frrrontmatter :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html - Recent content in Frrrontmatter on Cap'n Hugo Relearrrn Theme + Each Cap'n Hugo plank has t' define a frontmatter. All Frontmatter Opt'ns Th' values reflect example opt'ns. Hugo art-pir diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index 1ed872bd45..9f20236147 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/i18n/index.print.html b/pir/cont/i18n/index.print.html index 5e4f22f704..4e21a367aa 100644 --- a/pir/cont/i18n/index.print.html +++ b/pir/cont/i18n/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/i18n/index.xml b/pir/cont/i18n/index.xml index 3d8b1401f4..b1a48f0f48 100644 --- a/pir/cont/i18n/index.xml +++ b/pir/cont/i18n/index.xml @@ -1,9 +1,9 @@ - Multilingual an' i18n on Cap'n Hugo Relearrrn Theme + Multilingual an' i18n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/i18n/index.html - Recent content in Multilingual an' i18n on Cap'n Hugo Relearrrn Theme + Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode. Hugo art-pir diff --git a/pir/cont/imageeffects/index.html b/pir/cont/imageeffects/index.html index 5d35560f59..dd5249bc87 100644 --- a/pir/cont/imageeffects/index.html +++ b/pir/cont/imageeffects/index.html @@ -20,7 +20,7 @@ Name Descript'n border Draws a light thin border around th' image lazy L Name Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank."> - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/imageeffects/index.print.html b/pir/cont/imageeffects/index.print.html index 28e5e15d2c..2320295641 100644 --- a/pir/cont/imageeffects/index.print.html +++ b/pir/cont/imageeffects/index.print.html @@ -20,7 +20,7 @@ Name Descript'n border Draws a light thin border around th' image lazy L Name Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank."> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/imageeffects/index.xml b/pir/cont/imageeffects/index.xml index ebabadc6e2..acc47c7245 100644 --- a/pir/cont/imageeffects/index.xml +++ b/pir/cont/imageeffects/index.xml @@ -1,9 +1,9 @@ - Image Effects on Cap'n Hugo Relearrrn Theme + Image Effects :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/imageeffects/index.html - Recent content in Image Effects on Cap'n Hugo Relearrrn Theme + Th' theme supports non-standard image effects. Name Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank. Hugo art-pir diff --git a/pir/cont/index.html b/pir/cont/index.html index 2df6f214f9..a65cc8a4f8 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/index.print.html b/pir/cont/index.print.html index e152977cff..68fa0d47e1 100644 --- a/pir/cont/index.print.html +++ b/pir/cont/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.xml b/pir/cont/index.xml index 0a4e170829..566af4f43a 100644 --- a/pir/cont/index.xml +++ b/pir/cont/index.xml @@ -1,9 +1,9 @@ - Rambl'n on Cap'n Hugo Relearrrn Theme + Rambl'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/index.html - Recent content in Rambl'n on Cap'n Hugo Relearrrn Theme + Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively. Hugo art-pir @@ -33,7 +33,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html - Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks. + Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks. Image Effects @@ -61,7 +61,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html - Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. + Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. \ No newline at end of file diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index cfcd329a6a..ede8a58e6f 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/markdown/index.print.html b/pir/cont/markdown/index.print.html index 6ce96cc57d..b2d038f081 100644 --- a/pir/cont/markdown/index.print.html +++ b/pir/cont/markdown/index.print.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/markdown/index.xml b/pir/cont/markdown/index.xml index e1e8a90f19..c46e3e87f4 100644 --- a/pir/cont/markdown/index.xml +++ b/pir/cont/markdown/index.xml @@ -1,9 +1,9 @@ - Marrrkdown rules on Cap'n Hugo Relearrrn Theme + Marrrkdown rules :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html - Recent content in Marrrkdown rules on Cap'n Hugo Relearrrn Theme + Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks. Hugo art-pir diff --git a/pir/cont/menushortcuts/index.html b/pir/cont/menushortcuts/index.html index 3570e7cf74..2a3a30edb4 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/menushortcuts/index.print.html b/pir/cont/menushortcuts/index.print.html index d409820360..74c5af442f 100644 --- a/pir/cont/menushortcuts/index.print.html +++ b/pir/cont/menushortcuts/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/menushortcuts/index.xml b/pir/cont/menushortcuts/index.xml index a033bb7836..fdcd2b4175 100644 --- a/pir/cont/menushortcuts/index.xml +++ b/pir/cont/menushortcuts/index.xml @@ -1,9 +1,9 @@ - Menu extrrra shorrrtcuts on Cap'n Hugo Relearrrn Theme + Menu extrrra shorrrtcuts :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/menushortcuts/index.html - Recent content in Menu extrrra shorrrtcuts on Cap'n Hugo Relearrrn Theme + Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n. Hugo art-pir diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index abe7db76b0..fb7ecfbe5e 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/pages/index.print.html b/pir/cont/pages/index.print.html index 9856c03d74..f777ac7555 100644 --- a/pir/cont/pages/index.print.html +++ b/pir/cont/pages/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/pages/index.xml b/pir/cont/pages/index.xml index 637e7d0e2b..d4a5ad4ddd 100644 --- a/pir/cont/pages/index.xml +++ b/pir/cont/pages/index.xml @@ -1,9 +1,9 @@ - planks orrrganizat'n on Cap'n Hugo Relearrrn Theme + planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/pages/index.html - Recent content in planks orrrganizat'n on Cap'n Hugo Relearrrn Theme + 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. Hugo art-pir diff --git a/pir/cont/taxonomy/index.html b/pir/cont/taxonomy/index.html index 85c78dd3bb..297b0385d8 100644 --- a/pir/cont/taxonomy/index.html +++ b/pir/cont/taxonomy/index.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/taxonomy/index.print.html b/pir/cont/taxonomy/index.print.html index e1234c1910..6b8e0546ca 100644 --- a/pir/cont/taxonomy/index.print.html +++ b/pir/cont/taxonomy/index.print.html @@ -5,23 +5,23 @@ - + - + - + - + - + @@ -31,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/taxonomy/index.xml b/pir/cont/taxonomy/index.xml index 1e46e202aa..2b7e774115 100644 --- a/pir/cont/taxonomy/index.xml +++ b/pir/cont/taxonomy/index.xml @@ -1,9 +1,9 @@ - Taxonomy on Cap'n Hugo Relearrrn Theme + Taxonomy :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html - Recent content in Taxonomy on Cap'n Hugo Relearrrn Theme + Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. Hugo art-pir diff --git a/pir/dev/contributing/index.html b/pir/dev/contributing/index.html index b8301b007c..4ea9d8c1a6 100644 --- a/pir/dev/contributing/index.html +++ b/pir/dev/contributing/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/contributing/index.print.html b/pir/dev/contributing/index.print.html index b743745205..52d60f9e49 100644 --- a/pir/dev/contributing/index.print.html +++ b/pir/dev/contributing/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/contributing/index.xml b/pir/dev/contributing/index.xml index b9595b6437..8b1a4b2f27 100644 --- a/pir/dev/contributing/index.xml +++ b/pir/dev/contributing/index.xml @@ -1,9 +1,9 @@ - Contributing on Cap'n Hugo Relearrrn Theme + Contributing :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html - Recent content in Contributing on Cap'n Hugo Relearrrn Theme + What to know if you want to contribute Hugo art-pir diff --git a/pir/dev/index.html b/pir/dev/index.html index 81f69d8dc8..ec6f642288 100644 --- a/pir/dev/index.html +++ b/pir/dev/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/index.print.html b/pir/dev/index.print.html index ae638fc88d..90f7d1e201 100644 --- a/pir/dev/index.print.html +++ b/pir/dev/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/index.xml b/pir/dev/index.xml index bf5f41b201..c07f0a213a 100644 --- a/pir/dev/index.xml +++ b/pir/dev/index.xml @@ -1,9 +1,9 @@ - Development on Cap'n Hugo Relearrrn Theme + Development :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/dev/index.html - Recent content in Development on Cap'n Hugo Relearrrn Theme + This chapter contains informat'n only needed fer development an' maintain'n th' theme. Hugo art-pir @@ -12,21 +12,21 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html - Code Quality A new release can happen at any time from th' main branch o' th' GitHub project without further acknowledgment. + What to know if you want to contribute Maintaining https://mcshelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html - Semver This project tries t' follow th' semver policy - although not followed 100% 'n th' past. + What to know as a maintainer Scrrrenshots https://mcshelby.github.io/hugo-theme-relearn/pir/dev/screenshots/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/dev/screenshots/index.html - Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns + Recipe t' create various documentat'n scrrreenshots \ No newline at end of file diff --git a/pir/dev/maintaining/index.html b/pir/dev/maintaining/index.html index 9b5faba39d..a0e6e9e95f 100644 --- a/pir/dev/maintaining/index.html +++ b/pir/dev/maintaining/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/maintaining/index.print.html b/pir/dev/maintaining/index.print.html index c89a7fa53b..169d3eec59 100644 --- a/pir/dev/maintaining/index.print.html +++ b/pir/dev/maintaining/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/maintaining/index.xml b/pir/dev/maintaining/index.xml index 5e41c3f2c2..b28bb5ec84 100644 --- a/pir/dev/maintaining/index.xml +++ b/pir/dev/maintaining/index.xml @@ -1,9 +1,9 @@ - Maintaining on Cap'n Hugo Relearrrn Theme + Maintaining :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html - Recent content in Maintaining on Cap'n Hugo Relearrrn Theme + What to know as a maintainer Hugo art-pir diff --git a/pir/dev/screenshots/index.html b/pir/dev/screenshots/index.html index d5add0d4ae..2898c99457 100644 --- a/pir/dev/screenshots/index.html +++ b/pir/dev/screenshots/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/screenshots/index.print.html b/pir/dev/screenshots/index.print.html index 70f3af9aab..46ac1c214e 100644 --- a/pir/dev/screenshots/index.print.html +++ b/pir/dev/screenshots/index.print.html @@ -27,19 +27,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/screenshots/index.xml b/pir/dev/screenshots/index.xml index ec66e87e90..a15ea80e04 100644 --- a/pir/dev/screenshots/index.xml +++ b/pir/dev/screenshots/index.xml @@ -1,9 +1,9 @@ - Scrrrenshots on Cap'n Hugo Relearrrn Theme + Scrrrenshots :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/dev/screenshots/index.html - Recent content in Scrrrenshots on Cap'n Hugo Relearrrn Theme + Recipe t' create various documentat'n scrrreenshots Hugo art-pir diff --git a/pir/index.html b/pir/index.html index 3e5c8ecaf6..d320431e64 100644 --- a/pir/index.html +++ b/pir/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/index.print.html b/pir/index.print.html index 46f090ae2a..4f82dc5ac2 100644 --- a/pir/index.print.html +++ b/pir/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - + - - + + - + diff --git a/pir/index.search.js b/pir/index.search.js index a25893b8a5..6ff0cee5ad 100644 --- a/pir/index.search.js +++ b/pir/index.search.js @@ -1,16 +1,16 @@ var relearn_search_index = [ { "breadcrumb": "", - "content": "Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.\n", + "content": "Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.", "description": "Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.", - "tags": null, + "tags": [], "title": "Basics", "uri": "/hugo-theme-relearn/pir/basics/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children", - "content": "This be a plain demo child plank.\n", - "description": "This be a plain plank test, an' th' beginn'n o' a YAML multiline description…\n", + "content": "This be a plain demo child plank.", + "description": "This be a plain plank test, an' th' beginn'n o' a YAML multiline description…", "tags": [ "Children" ], @@ -19,9 +19,9 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "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 rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\nCreate yer project Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eTh' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\n", + "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 rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\nCreate yer project Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eTh' Relearrrn theme provides archetypes t' help ye create this kind o' planks.", "description": "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.", - "tags": null, + "tags": [], "title": "planks orrrganizat'n", "uri": "/hugo-theme-relearn/pir/cont/pages/index.html" }, @@ -29,54 +29,54 @@ var relearn_search_index = [ "breadcrumb": "Rambl'n", "content": "Each Cap'n Hugo plank has t' define a frontmatter.\nAll Frontmatter Opt'ns Th' values reflect example opt'ns. Th' defaults can be taken from th' annotated example below.\n​ toml yaml json +++ LastModifierDisplayName = '' LastModifierEmail = '' alwaysopen = '' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' descript'n = '' disableBreadcrumb = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableToc = false editURL = '' headingPost = '' headingPre = '' hidden = false highlightWrap = true images = ['images/hero.png'] mathJaxInitialize = '{}' menuPost = '' menuPre = '' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' title = 'Example Page' [imageEffects] border = true lazy = true lightbox = true shadow = false +++ --- LastModifierDisplayName: \"\" LastModifierEmail: \"\" alwaysopen: \"\" collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" descript'n: \"\" disableBreadcrumb: false disableMathJax: true disableMermaid: true disableNextPrev: false disableOpenapi: true disableToc: false editURL: \"\" headingPost: \"\" headingPre: \"\" hidden: false highlightWrap: true imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png mathJaxInitialize: '{}' menuPost: \"\" menuPre: \"\" mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true ordersectionsby: weight title: Example Plank --- { \"LastModifierDisplayName\": \"\", \"LastModifierEmail\": \"\", \"alwaysopen\": \"\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"description\": \"\", \"disableBreadcrumb\": false, \"disableMathJax\": true, \"disableMermaid\": true, \"disableNextPrev\": false, \"disableOpenapi\": true, \"disableToc\": false, \"editURL\": \"\", \"headingPost\": \"\", \"headingPre\": \"\", \"hidden\": false, \"highlightWrap\": true, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"mathJaxInitialize\": \"{}\", \"menuPost\": \"\", \"menuPre\": \"\", \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"ordersectionsby\": \"weight\", \"title\": \"Example Page\" } Annotated Frontmatter Opt'ns ​ toml +++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by giv'n it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes as well. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used. images = [ \"images/hero.png\" ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = \"Example Page\" # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's hugo.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' value can contain th' macro # `${FilePath}` which will be replaced by th' file path o' yer displayed plank. # If not set, th' set value o' yer site's hugo.toml be used. If th' global # parameter be given but ye want t' hide th' button fer th' displayed plank, # ye can set th' value t' an empty str'n. If instead o' hid'n ye want t' have # an disabled button, ye can set th' value t' a str'n contain'n just spaces. # This be useful if ye want t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu appearance. # Prefix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = \"\" # Suffix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = \"\" # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. # If not set, th' set value o' yer site's hugo.toml be used. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value be true, th' plank be hidden from th' menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Prefix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n. headingPre = \"\" # Suffix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n. headingPost = \"\" # Display name o' th' page's last editor. # Default: not set # If set, it will be displayed 'n th' default footer. LastModifierDisplayName = \"\" # Email address o' th' page's last editor. # Default: not set # If set together wit' LastModifierDisplayName, it will be displayed 'n th' # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effect values default t' th' values o' yer site's hugo.toml an' can be # overridden through URL parameter given t' th' image. See th' documentat'n fer # details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++ Some Detailed Examples Add Ay'con t' a Menu Entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n​ toml yaml json +++ menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" title = 'GitHub repo' +++ --- menuPre: '\u003ci class=''fab fa-github''\u003e\u003c/i\u003e ' title: GitHub repo --- { \"menuPre\": \"\\u003ci class='fab fa-github'\\u003e\\u003c/i\\u003e \", \"title\": \"GitHub repo\" } 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​ toml yaml json +++ title = 'My page' weight = 5 +++ --- title: My plank weight: 5 --- { \"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.\nBut a page’s title has t' be descriptive on its own while th' menu be a hierarchy. Cap'n Hugo adds th' linkTitle parameter fer that purpose:\nFor example (for a plank named content/install/linux.md):\n​ toml yaml json +++ linkTitle = 'Linux' title = 'Install on Linux' +++ --- linkTitle: Linux title: Install on Linux --- { \"linkTitle\": \"Linux\", \"title\": \"Install on Linux\" } Override Expand State Rules fer Menu Entries Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' alwaysopen sett'n on a per plank basis. If alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\nDis'ble Sect'n Planks Ye may want t' structure yer planks 'n a hierarchical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.\nT' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.\nFor this, open content/level-one/_index.md an' add th' follow'n frontmatter\n​ toml yaml json +++ collapsibleMenu = true [_build] render = 'never' +++ --- _build: render: never collapsibleMenu: true --- { \"_build\": { \"render\": \"never\" }, \"collapsibleMenu\": true } ", "description": "Each Cap'n Hugo plank has t' define a frontmatter.\nAll Frontmatter Opt'ns Th' values reflect example opt'ns.", - "tags": null, + "tags": [], "title": "Frrrontmatter", "uri": "/hugo-theme-relearn/pir/cont/frontmatter/index.html" }, { "breadcrumb": "", - "content": "Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.\n", + "content": "Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.", "description": "Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.", - "tags": null, + "tags": [], "title": "Rambl'n", "uri": "/hugo-theme-relearn/pir/cont/index.html" }, { "breadcrumb": "Basics", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' history plank.\n0.121.0 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n6.0.0.beta (XXXX-XX-XX) Break'n This release requires ye t' move yer self-defined variant (theme-*.css) an' chroma stylesheets (chroma-*.css) from static/css t' assets/css.\nThis was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.\nIn addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:\n--CODE-theme: monokai; Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.\nWit' th' newly introduced unified handl'n o' descript'ns throughout th' theme, th' only place th' old parameter would have been used was yer home plank.\nFor migrat'n, move th' descript'n parameter o' yer hugo.toml into th' frontmatter section o' yer home plank.\nBreak'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.\nChange it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.\nBreak'n Th' frontmatter opt'n menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.\nBreak'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.\nBreak'n Support fer Internet Explorer 11 was finally dropped.\nChange Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.\nYe may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.\nChange Th' children shortcode was fixed t' adhere t' its documentat'n, generat'n th' descript'n based on this rule: When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken.\nPreviously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.\nNew Th' include shortcode be now able t' resolve links t' resources as well as t' files 'n th' file system (the old behavior). Ye can configure t' generate warnings or errors dur'n build by sett'n include.errorlevel t' either warning or error 'n yer hugo.toml if a path can not be resolved.\nNew Math be now us'ble without enclos'n it 'n a shortcode or codefence by us'n Hugo’s passthrough configurat'n.\nNew Translat'n into Romanian.\n5.27.0 (2024-04-07) 0.121.0 This release requires a newer Cap'n Hugo version.\nChange If th' theme be configured t' generate warnings or errors dur'n build by sett'n image.errorlevel t' either warning or error 'n yer hugo.toml, it will now also generate output if a link fragment be not found 'n th' target plank.\nChange Th' dependency loader was made more versatile.\nTh' configurat'n 'n yer hugo.toml does not require th' locat'n parameter anymore. If ye still use it, th' theme will work as before but will generate a warning. So ye don’t need t' change anyth'n, yet.\nWit' th' new mechanism, yer dependency loader now receives an additional locat'n parameter instead that ye can query t' inject yer dependencies 'n th' desired locat'n.\nBy that ye can now call th' dependency mechanism 'n yer own overriden partials by giv'n it a distinct locat'n parameter. In addit'n yer injected files can now be spread t' multiple locat'ns which wasn’t previously poss'ble.\nNew Additional styl'n was added fer th' native HTML elements \u003cmark\u003e an' \u003ckbd\u003e. T' use them ye must allow th' usage o' HTML 'n yer hugo.toml. Th' Marrrkdown documentat'n was enhanced fer this.\nNew Ye now can scroll forward an' backward through all head'ns o' a plank by us'n ALT 🡑 an' ALT 🡓. This also works fer th' PRINT output format.\nNew Th' breadcrumbs used 'n th' topbar, search results an' th' taxonomy term lists be now us'n th' planks frontmatter linktitle instead o' title if set.\n5.26.0 (2024-03-18) New Th' lazy load'n o' images be now configur'ble by us'n th' new lazy image effect. Th' default value hasn’t changed 'n comparison t' older versions, ye don’t need t' change anyth'n.\nNew It be now poss'ble t' adjust th' max width o' th' main area, eg. 'n case ye want t' use th' full plank width fer yer rrrambl'n.\nNew Images an' Codefences be now respect'n Hugo’s Marrrkdown attributes.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer block diagrams.\nNew This release fixes a long outstand'n bug whar' th' plank wasn’t reposition'n correctly when go'n forward or backward 'n yer browser history.\n5.25.0 (2024-02-29) Change This release deprecates th' attachments shortcode 'n favor o' th' new th' resources shortcode.\nIf ye be us'n Hugo below 0.123.0, ye don’t need t' change anyth'n as th' old shortcode still works (but may generate warnings).\nAnyways, users be strongly advised t' migrate as th' attachments shortcode will not receive support anymore. Migrat'n instruct'ns be listed on th' attachments shortcode plank.\nChange If ye run Hugo wit' GitInfo configured, th' default plank footer now prints out name, email address an' date o' th' last commit. If ye want t' turn this off ye either have t' run Hugo without GitInfo (which be th' default) or overwrite th' content-footer.html partial.\n5.24.0 (2024-02-28) 0.112.4 This release requires a newer Cap'n Hugo version.\nChange Th' topbar button received a way t' add text next t' th' ay'con. For this, th' original title opt'n was renamed t' hint while th' new title opt'n be now displayed next t' th' ay'con.\nChange Th' frontmatter opt'n menuTitle be now deprecated 'n favor fer Hugo’s own linkTitle. Ye don’t need t' change anyth'n as th' old menuTitle opt'n be still supported.\nChange Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlight'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.\nNew If th' theme can not resolve a link t' a plank or image, ye can now generate warnings or errors dur'n build by sett'n link.errorlevel or image.errorlevel t' either warning or error 'n yer hugo.toml respectively. By default this condit'n be silently ignored an' th' link be written as-is.\nPlease note that a plank link will generate false negatives if uglyURLs=true an' it references an ordinary plank before 0.123.0.\nPlease note that an image link will generate false negatives if th' file resides 'n yer static directory.\nNew Ye now can configure additional opt'ns fer every theme variant 'n yer hugo.toml. This allows fer optional advanced functionality. Ye don’t need t' change anyth'n as th' old configurat'n opt'ns will still work (but may generate warnings now).\nTh' advanced functionality allows ye t' set an explicit name fer a theme variant an' now allows fer multiple auto mode variants that adjust t' th' light/dark preference o' yer OS sett'ns.\nNew New partial fer defin'n th' head'n. See documentat'n fer further read'n.\nNew Support fer Hugo’s built-in figure shortcode.\nNew On taxonomy an' term planks ye can now use prev/next navigat'n as within th' normal plank structure.\nNew In additiion t' th' exist'n menu width customizat'n, it be now also poss'ble t' set th' width o' th' menu flyout fer small screen sizes wit' th' --MENU-WIDTH-S CSS property.\nNew Improvements fer accessibility when tabb'n through th' plank fer images, links an' tab handles.\nNew Th' editURL config parameter be now overwrit'ble 'n yer planks frontmatter. In addit'n it received more versatility by lett'n ye control whar' t' put th' file path into th' URL. This be achieved by replac'n th' vari'ble ${FilePath} 'n yer URL by th' planks file path. Ye don’t need t' change anyth'n 'n yer exist'n configurat'n as th' old way without th' replacement vari'ble still works.\nNew Th' themes config an' frontmatter opt'ns received a comprehensive documentat'n update. In addit'n th' theme switched from config.toml t' hugo.toml.\nNew Restored compatibility wit' Cap'n Hugo versions 0.121.0 or higher fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\nNew Restored compatibility wit' Cap'n Hugo versions 0.123.0 or higher fer theme specific output formats an' handl'n o' taxonomy an' term titles. This does not change th' minimum required Cap'n Hugo version.\n5.23.0 (2023-11-03) Change Wit' 0.120.0 th' author sett'ns move into th' [params] array 'n yer hugo.toml. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.\nChange yer previous sett'n from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Cap'n Hugo { \"params\": { \"author\": \"Hugo\" } } t'\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Cap'n Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term planks now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer hugo.toml by add'n disableTermBreadcrumbs=true.\nNew Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns fer th' menu an' th' children shortcode. Both will now accept th' follow'n values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adher'n t' Hugo’s default sort order).\nNew Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. See th' docs.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independent way t' link t' planks inside o' yer project. It always required ye t' know how yer uglyURLs sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This be a hassle as ye have t' change these links manually once ye change yer uglyURLs sett'n or change th' type o' a plank.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow it’s poss'ble t' use th' same path o' a call t' relref 'n a plain Marrrkdown link (eg [generator](../generator)). This be independent o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so [generator](generator/index.html) will work as before.\nTh' follow'n types o' link'n be supported:\nlink descript'n [generator](en/basics/generator) absolute from yer project root (multilang) [generator](/en/basics/generator) absolute from yer project root (multilang) [generator](basics/generator) absolute from yer current language root [generator](/basics/generator) absolute from yer current language root [generator](./../generator) relative from th' current plank [generator](../generator) relative from th' current plank 5.22.0 (2023-10-02) Change This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' R-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See th' documentat'n fer how t' do this.\nThis feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n shortcuts t' planks inside o' yer project wit' a headless branch parent.\nIn this case it be advised t' remove th' title from th' headless branch parent’s frontmatter, as it will otherwise appear 'n yer breadcrumbs.\nNew It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s frontmatter.\nNew If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew Translat'n into Swahili. This language be not supported fer search.\n5.21.0 (2023-09-18) Change We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer menu-footer.html partial overridden, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.\nNew This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See th' documentat'n fer further details.\nNew Th' theme has updated its Swagger dependency t' 5.7.2 fer th' openapi shortcode. This br'ns support fer OpenAPI Specificat'n 3.1.\n5.20.0 (2023-08-26) Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.\nWit' this comes a change 'n th' light theme variants o' Relearrrn Bright, Relearrrn Light an' Zen Light by switch'n th' syntaxhighlight'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.\nAdditionally, th' syntaxhighlight'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed th' CSS vari'ble --MENU-SECTION-HR-color t' --MENU-SECTION-SEPARATOR-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose borders be now configur'ble by us'n th' CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color an' --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor exist'n variants noth'n has changed visually.\nNew Th' default values fer th' image effects be now configur'ble fer yer whole ship via hugo.toml or fer each plank through frontmatter.\nNew This release fixes a long outstand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed expand or inactive tabs.\nNew Restored compatibility wit' Cap'n Hugo versions lower than 0.111.0 fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\n5.19.0 (2023-08-12) New Th' highlight shortcode now accepts th' new parameter title. This displays th' code like a single tab. This be also avail'ble us'n codefences an' makes it much easier t' write nicer code samples.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew Th' theme now dispatches th' custom event themeVariantLoaded on th' document when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.\nNew Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' sankey diagram type an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).\nNew Translat'n into Hungarian.\n5.18.0 (2023-07-27) Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange There be visual improvements 'n display'n text links 'n yer rrrambl'n as well as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.\nNew Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' siteparam shortcode be now cap'ble 'n display'n nested params as well as support'n text formatt'n.\n5.17.0 (2023-06-22) Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n [params] disableHoverBlockCopyToClipBoard=true t' yer hugo.toml.\nNew Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.\n5.16.0 (2023-06-10) Change Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documentat'n.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew Th' tabs shortcode an' th' tab shortcode received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.\nTh' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.\nAdditionally th' name parameter was renamed t' title but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.\nNew Th' theme now optionally supports separate favicons fer light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility wit' Cap'n Hugo 0.112.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nTh' attachments shortcode has compatibility issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt be planned t' refactor th' attchments shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.\nNew Th' already known tabshas a new friend th' tab shortcode t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew Besides th' tag taxonomy th' theme now also provides th' category taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.\n5.14.0 (2023-05-20) New Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.\nHugo’s default taxonmies tags an' categories be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer hugo.toml.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional taxonomies not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{ partial \"tags.html\" . }} t' it. Show tags below rrrambl'n: Overwrite content-footer.html an' add {{ partial \"tags.html\" . }} t' it. New Th' new parameter breadcrumbSeparator be now avail'ble 'n yer hugo.toml t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.\n5.13.0 (2023-05-17) Change Th' swagger shortcode was deprecated 'n favor fer th' openapi shortcode. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' swagger shortcode 'n th' next major release.\nAdditionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.\n5.12.0 (2023-05-04) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Support fer th' great VSCode Front Matter extension which provides on-premise CMS capabilties t' Cap'n Hugo.\nTh' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' pirate translat'n. This feature be not avail'ble 'n Internet Explorer 11.\nNew Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.\n5.11.0 (2023-02-07) Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn case ye made changes t' th' theme that be depend'n on this library ye can place a copy o' jQuery into yer static/js directory an' board it from yer own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' default sett'n o' on, 'n effect since 1.1.0, changed back t' off as there was interference wit' scroll'n on mobile an' big planks.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer hugo.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis also changed th' lightbox effects parameter from featherlight=false t' lightbox=false. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.\nChange In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' expand shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Translat'n into Czech. This language be not supported fer search.\nNew GitHub releases be also now tagged fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) release mak'n it easier fer ye t' pin th' theme t' a certain version.\n5.10.0 (2023-01-25) New Th' attachments, badge, button an' notice shorrrtcodes have a new parameter color t' set arbitrary CSS color values.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.\n5.9.0 (2022-12-23) Break'n Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.\nIt was later discovered, that this causes planks only meant t' be displayed 'n th' More section o' th' menu an' stored directly inside yer rrrambl'n directory t' now show up 'n th' menu as well.\nT' get rid o' this undesired behavior ye have two choices:\nMake th' plank file a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store th' plank file fer below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md). Don’t give this plank a title as this will cause it t' be shown 'n th' breadcrumbs - a th'n ye most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Th' required folder name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a files subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a index.files directory. Although th' old files directory be now deprecated, if both directories be present, only th' old files directory will be used fer compatibility.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer hugo.toml.\nNew Th' theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New Th' new badge shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.\nNew A new color --ACCENT-color was introduced which be used fer highlight'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old yellow color be still used as default.\n5.7.0 (2022-11-29) Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code ko. Formerly th' country code kr was used instead.\nNew Th' button shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.\nNew Th' search now supports th' Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n through large number o' results.\nT' activate this feature, ye need t' configure it 'n yer hugo.toml as a new outputformat searchpage fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'n CTRL+ALT+t now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' TAB key.\nTh' search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus th' cursor inside o' th' search box so ye can immediately start yer search by typ'n.\nNew Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.\nT' configure this 'n yer hugo.toml make sure t' set Hugo’s disableHugoGeneratorInject=true an' also [params] disableGeneratorVersion=true, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).\n5.5.0 (2022-11-06) Change Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.\nFor that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.\nIf ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML img URLs manually t' th' respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change Wit' th' proper sett'ns 'n yer hugo.toml yer plank be now serv'ble from th' local file system us'n file:// URLs.\nPlease note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer hugo.toml from json t' search. Th' now deprecated json outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from http:// or https://.\nChange Th' button shortcode has a new parameter target t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.\nNew Th' math shortcode an' mermaid shortcode now also support th' align parameter if codefence rules be used.\nNew Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.\nNew Translat'n into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).\nNew Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline opt'n be now documented.\nNew Print'n fer th' swagger shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true 'n yer hugo.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Cap'n Hugo version.\nChange Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' print output format sett'n 'n yer hugo.tomlt':\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalink'ble = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalink'ble: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } } 5.0.0 (2022-07-05) Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.\nYer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n after th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:\nfer yer home plank, add th' frontmatter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated frontmatter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' frontmatter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew Add'n new partials heading-pre.html / heading-post.html an' accord'n frontmatter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew Th' new shortcode math be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n4.2.0 (2022-06-23) Break'n Th' second parameter fer th' include shortcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange Previously, if th' tabs shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.\nChange Th' landingPageURL was removed from hugo.toml. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically an' will point t' th' project’s homepage. If ye want t' support a different link, overwrite th' logo.html partial.\nNew All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.\n4.1.0 (2022-06-12) New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank. 4.0.0 (2022-06-05) Break'n Th' custom_css config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' custom-header.html template 'n a much more generic manner.\nBreak'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from --MAIN-LINK-color an' --MAIN-ANCHOR-HOVER-color respectively.\nNew All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew New colors --PRIMARY-color an' --SECONDARY-color were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have primary or secondary as additional values.\nThese two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 (2022-04-03) Break'n If ye had previously overwritten th' custom-footer.html partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial content-footer.html. custom-footer.html was never meant t' contain HTML other than additional styles an' JavaScript.\nNew If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer hugo.toml. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.\nNew Ye can activate print support 'n yer hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between --MAIN-font fer all rrrambl'n text an' --CODE-font fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.\nNew Th' new shortcode swagger be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Cap'n Hugo version.\nChange In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set disableMermaid=false 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.\nNew Additional color variant vari'ble --MERMAID-theme t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.\n3.1.0 (2022-03-15) New attachment an' notice shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons. 3.0.0 (2022-02-22) Break'n We made changes t' th' menu footer. If ye have yer menu-footer.html partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' menu-footer.html partial that be com'n wit' th' exampleSite.\nThis change was made t' allow yer own menu footer t' be placed right after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).\nBreak'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.\nThis change will only affect yer installat'n if you’ve not set th' themeVariant parameter 'n yer hugo.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant=\"learn\" 'n yer hugo.toml.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color t' --MENU-SEARCH-BORDER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.\nNew Ye can now configure multiple color variants 'n yer hugo.toml. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant selector will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant selector will not be displayed wit' Internet Explorer 11.\n2.9.0 (2021-11-19) Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugo’s standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard compliant form ye must not link t' th' *.md file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugo’s 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' Hugo’s implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server after an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console after 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 foundIn this case, ye must apply one o' two opt'ns:\nStart up a text editor wit' regular expression support fer search an' replace. Search fer (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" an' replace it by $1$2\" 'n all *.md files. This be th' recommended choice.\nCopy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes th' font Novacento/Novecento. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.\nNew Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer hugo.toml. For an example see th' example configurat'n.\n2.7.0 (2021-10-24) New Optional second parameter fer notice shortcode t' set title 'n box header. 2.6.0 (2021-10-21) New Yer ship can now be served from a subfolder if ye set baseURL 'n yer hugo.toml. See th' documentat'n fer a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugo’s rules highlight'n 'n case no language was given or th' language be unsupported. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style. 2.4.0 (2021-10-07) Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.\nNew Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer hugo.toml.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer hugo.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Cap'n Hugo version.\nNew Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.\n2.2.0 (2021-09-09) New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n disableSeoHiddenPages=true 'n yer hugo.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Cap'n Hugo version.\nChange In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n th' exampleSite), they will now be ignored by th' search.\nNew Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n disableSearchHiddenPages=true 'n yer hugo.toml.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.\n2.0.0 (2021-08-28) Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n\nChange In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange --MENU-HOME-LINK-color an' --MENU-HOME-LINK-HOVER-color were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.\nChange Arrow navigat'n an' children shortcode were ignor'n sett'n fer ordersectionsby. This be now changed an' may result 'n different sort'n order o' yer sub planks.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 (2021-07-26) New Shortcode expand wit' new parameter t' open on plank board. 1.1.0 (2021-07-02) Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.\nNew Merrrmaid config opt'ns can be set 'n hugo.toml.\n1.0.0 (2021-07-01) 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.\nNew Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' Relearrrn an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.\n", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' history plank.\n0.121.0 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n6.0.0.beta (XXXX-XX-XX) Break'n This release requires ye t' move yer self-defined variant (theme-*.css) an' chroma stylesheets (chroma-*.css) from static/css t' assets/css.\nThis was necessary t' avoid permission errors on build if runn'n 'n certain Unix configurat'ns.\nIn addit'n it be not allowed anymore t' @import yer chroma stylesheet from inside o' yer variant stylesheet.\nSay, yer chroma stylesheet be named chroma-monokai.css, ye have t' add th' follow'n inside yer variant stylesheet:\n--CODE-theme: monokai; Break'n Th' parameter descript'n 'n yer hugo.toml will now be ignored.\nWit' th' newly introduced unified handl'n o' descript'ns throughout th' theme, th' only place th' old parameter would have been used was yer home plank.\nFor migrat'n, move th' descript'n parameter o' yer hugo.toml into th' frontmatter section o' yer home plank.\nBreak'n Search support fer th' json outputformat deprecated 'n 5.4.0 was removed.\nChange it t' search fer th' homepage 'n yer hugo.toml. See th' docs fer detailed configurat'n.\nBreak'n Th' frontmatter opt'n menuTitle deprecated 'n 5.24.0 was removed 'n favor fer Hugo’s own linkTitle.\nAdditionally, if set, linkTitle will now be used instead o' title t' generate th' breadcrumb.\nBreak'n Th' swagger shortcode deprecated 'n 5.13.0 was removed 'n favor fer th' openapi shortcode wit' th' same set o' parameter.\nBreak'n Support fer Internet Explorer 11 was finally dropped.\nChange Wit' th' removal o' support fer Internet Explorer 11, Font Awesome was upgraded t' version 6.5.2.\nYe may experience slight changes fer some ay'cons. In addit'n ye have additional ~1700 ay'cons t' chose from.\nChange Th' children shortcode was fixed t' adhere t' its documentat'n, generat'n th' descript'n based on this rule: When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken.\nPreviously, th' summary erroneously was ignored which now can lead t' different output if ye set description=true as a parameter.\nNew Th' include shortcode be now able t' resolve links t' resources as well as t' files 'n th' file system (the old behavior). Ye can configure t' generate warnings or errors dur'n build by sett'n include.errorlevel t' either warning or error 'n yer hugo.toml if a path can not be resolved.\nNew Math be now us'ble without enclos'n it 'n a shortcode or codefence by us'n Hugo’s passthrough configurat'n.\nNew Translat'n into Romanian.\n5.27.0 (2024-04-07) 0.121.0 This release requires a newer Cap'n Hugo version.\nChange If th' theme be configured t' generate warnings or errors dur'n build by sett'n image.errorlevel t' either warning or error 'n yer hugo.toml, it will now also generate output if a link fragment be not found 'n th' target plank.\nChange Th' dependency loader was made more versatile.\nTh' configurat'n 'n yer hugo.toml does not require th' locat'n parameter anymore. If ye still use it, th' theme will work as before but will generate a warning. So ye don’t need t' change anyth'n, yet.\nWit' th' new mechanism, yer dependency loader now receives an additional locat'n parameter instead that ye can query t' inject yer dependencies 'n th' desired locat'n.\nBy that ye can now call th' dependency mechanism 'n yer own overriden partials by giv'n it a distinct locat'n parameter. In addit'n yer injected files can now be spread t' multiple locat'ns which wasn’t previously poss'ble.\nNew Additional styl'n was added fer th' native HTML elements \u003cmark\u003e an' \u003ckbd\u003e. T' use them ye must allow th' usage o' HTML 'n yer hugo.toml. Th' Marrrkdown documentat'n was enhanced fer this.\nNew Ye now can scroll forward an' backward through all head'ns o' a plank by us'n ALT 🡑 an' ALT 🡓. This also works fer th' PRINT output format.\nNew Th' breadcrumbs used 'n th' topbar, search results an' th' taxonomy term lists be now us'n th' planks frontmatter linktitle instead o' title if set.\n5.26.0 (2024-03-18) New Th' lazy load'n o' images be now configur'ble by us'n th' new lazy image effect. Th' default value hasn’t changed 'n comparison t' older versions, ye don’t need t' change anyth'n.\nNew It be now poss'ble t' adjust th' max width o' th' main area, eg. 'n case ye want t' use th' full plank width fer yer rrrambl'n.\nNew Images an' Codefences be now respect'n Hugo’s Marrrkdown attributes.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer block diagrams.\nNew This release fixes a long outstand'n bug whar' th' plank wasn’t reposition'n correctly when go'n forward or backward 'n yer browser history.\n5.25.0 (2024-02-29) Change This release deprecates th' attachments shortcode 'n favor o' th' new th' resources shortcode.\nIf ye be us'n Hugo below 0.123.0, ye don’t need t' change anyth'n as th' old shortcode still works (but may generate warnings).\nAnyways, users be strongly advised t' migrate as th' attachments shortcode will not receive support anymore. Migrat'n instruct'ns be listed on th' attachments shortcode plank.\nChange If ye run Hugo wit' GitInfo configured, th' default plank footer now prints out name, email address an' date o' th' last commit. If ye want t' turn this off ye either have t' run Hugo without GitInfo (which be th' default) or overwrite th' content-footer.html partial.\n5.24.0 (2024-02-28) 0.112.4 This release requires a newer Cap'n Hugo version.\nChange Th' topbar button received a way t' add text next t' th' ay'con. For this, th' original title opt'n was renamed t' hint while th' new title opt'n be now displayed next t' th' ay'con.\nChange Th' frontmatter opt'n menuTitle be now deprecated 'n favor fer Hugo’s own linkTitle. Ye don’t need t' change anyth'n as th' old menuTitle opt'n be still supported.\nChange Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlight'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.\nNew If th' theme can not resolve a link t' a plank or image, ye can now generate warnings or errors dur'n build by sett'n link.errorlevel or image.errorlevel t' either warning or error 'n yer hugo.toml respectively. By default this condit'n be silently ignored an' th' link be written as-is.\nPlease note that a plank link will generate false negatives if uglyURLs=true an' it references an ordinary plank before 0.123.0.\nPlease note that an image link will generate false negatives if th' file resides 'n yer static directory.\nNew Ye now can configure additional opt'ns fer every theme variant 'n yer hugo.toml. This allows fer optional advanced functionality. Ye don’t need t' change anyth'n as th' old configurat'n opt'ns will still work (but may generate warnings now).\nTh' advanced functionality allows ye t' set an explicit name fer a theme variant an' now allows fer multiple auto mode variants that adjust t' th' light/dark preference o' yer OS sett'ns.\nNew New partial fer defin'n th' head'n. See documentat'n fer further read'n.\nNew Support fer Hugo’s built-in figure shortcode.\nNew On taxonomy an' term planks ye can now use prev/next navigat'n as within th' normal plank structure.\nNew In additiion t' th' exist'n menu width customizat'n, it be now also poss'ble t' set th' width o' th' menu flyout fer small screen sizes wit' th' --MENU-WIDTH-S CSS property.\nNew Improvements fer accessibility when tabb'n through th' plank fer images, links an' tab handles.\nNew Th' editURL config parameter be now overwrit'ble 'n yer planks frontmatter. In addit'n it received more versatility by lett'n ye control whar' t' put th' file path into th' URL. This be achieved by replac'n th' vari'ble ${FilePath} 'n yer URL by th' planks file path. Ye don’t need t' change anyth'n 'n yer exist'n configurat'n as th' old way without th' replacement vari'ble still works.\nNew Th' themes config an' frontmatter opt'ns received a comprehensive documentat'n update. In addit'n th' theme switched from config.toml t' hugo.toml.\nNew Restored compatibility wit' Cap'n Hugo versions 0.121.0 or higher fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\nNew Restored compatibility wit' Cap'n Hugo versions 0.123.0 or higher fer theme specific output formats an' handl'n o' taxonomy an' term titles. This does not change th' minimum required Cap'n Hugo version.\n5.23.0 (2023-11-03) Change Wit' 0.120.0 th' author sett'ns move into th' [params] array 'n yer hugo.toml. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.\nChange yer previous sett'n from\nhugo. toml yaml json [params] author = 'Hugo' params: author: Cap'n Hugo { \"params\": { \"author\": \"Hugo\" } } t'\nhugo. toml yaml json [params] [params.author] name = 'Hugo' params: author: name: Cap'n Hugo { \"params\": { \"author\": { \"name\": \"Hugo\" } } } Change Taxonomy term planks now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer hugo.toml by add'n disableTermBreadcrumbs=true.\nNew Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns fer th' menu an' th' children shortcode. Both will now accept th' follow'n values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adher'n t' Hugo’s default sort order).\nNew Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. See th' docs.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independent way t' link t' planks inside o' yer project. It always required ye t' know how yer uglyURLs sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This be a hassle as ye have t' change these links manually once ye change yer uglyURLs sett'n or change th' type o' a plank.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow it’s poss'ble t' use th' same path o' a call t' relref 'n a plain Marrrkdown link (eg [generator](../generator)). This be independent o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so [generator](generator/index.html) will work as before.\nTh' follow'n types o' link'n be supported:\nlink descript'n [generator](en/basics/generator) absolute from yer project root (multilang) [generator](/en/basics/generator) absolute from yer project root (multilang) [generator](basics/generator) absolute from yer current language root [generator](/basics/generator) absolute from yer current language root [generator](./../generator) relative from th' current plank [generator](../generator) relative from th' current plank 5.22.0 (2023-10-02) Change This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' R-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See th' documentat'n fer how t' do this.\nThis feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n shortcuts t' planks inside o' yer project wit' a headless branch parent.\nIn this case it be advised t' remove th' title from th' headless branch parent’s frontmatter, as it will otherwise appear 'n yer breadcrumbs.\nNew It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s frontmatter.\nNew If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew Translat'n into Swahili. This language be not supported fer search.\n5.21.0 (2023-09-18) Change We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer menu-footer.html partial overridden, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.\nNew This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See th' documentat'n fer further details.\nNew Th' theme has updated its Swagger dependency t' 5.7.2 fer th' openapi shortcode. This br'ns support fer OpenAPI Specificat'n 3.1.\n5.20.0 (2023-08-26) Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.\nWit' this comes a change 'n th' light theme variants o' Relearrrn Bright, Relearrrn Light an' Zen Light by switch'n th' syntaxhighlight'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.\nAdditionally, th' syntaxhighlight'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed th' CSS vari'ble --MENU-SECTION-HR-color t' --MENU-SECTION-SEPARATOR-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose borders be now configur'ble by us'n th' CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color an' --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor exist'n variants noth'n has changed visually.\nNew Th' default values fer th' image effects be now configur'ble fer yer whole ship via hugo.toml or fer each plank through frontmatter.\nNew This release fixes a long outstand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed expand or inactive tabs.\nNew Restored compatibility wit' Cap'n Hugo versions lower than 0.111.0 fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\n5.19.0 (2023-08-12) New Th' highlight shortcode now accepts th' new parameter title. This displays th' code like a single tab. This be also avail'ble us'n codefences an' makes it much easier t' write nicer code samples.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew Th' theme now dispatches th' custom event themeVariantLoaded on th' document when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.\nNew Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' sankey diagram type an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).\nNew Translat'n into Hungarian.\n5.18.0 (2023-07-27) Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange There be visual improvements 'n display'n text links 'n yer rrrambl'n as well as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.\nNew Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' siteparam shortcode be now cap'ble 'n display'n nested params as well as support'n text formatt'n.\n5.17.0 (2023-06-22) Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n [params] disableHoverBlockCopyToClipBoard=true t' yer hugo.toml.\nNew Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.\n5.16.0 (2023-06-10) Change Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documentat'n.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew Th' tabs shortcode an' th' tab shortcode received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.\nTh' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.\nAdditionally th' name parameter was renamed t' title but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.\nNew Th' theme now optionally supports separate favicons fer light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility wit' Cap'n Hugo 0.112.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nTh' attachments shortcode has compatibility issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt be planned t' refactor th' attchments shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.\nNew Th' already known tabshas a new friend th' tab shortcode t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew Besides th' tag taxonomy th' theme now also provides th' category taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.\n5.14.0 (2023-05-20) New Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.\nHugo’s default taxonmies tags an' categories be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer hugo.toml.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional taxonomies not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{ partial \"tags.html\" . }} t' it. Show tags below rrrambl'n: Overwrite content-footer.html an' add {{ partial \"tags.html\" . }} t' it. New Th' new parameter breadcrumbSeparator be now avail'ble 'n yer hugo.toml t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.\n5.13.0 (2023-05-17) Change Th' swagger shortcode was deprecated 'n favor fer th' openapi shortcode. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' swagger shortcode 'n th' next major release.\nAdditionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.\n5.12.0 (2023-05-04) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Support fer th' great VSCode Front Matter extension which provides on-premise CMS capabilties t' Cap'n Hugo.\nTh' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer frontmatter.json like this\n​ frontmatter.json { ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' pirate translat'n. This feature be not avail'ble 'n Internet Explorer 11.\nNew Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.\n5.11.0 (2023-02-07) Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn case ye made changes t' th' theme that be depend'n on this library ye can place a copy o' jQuery into yer static/js directory an' board it from yer own layouts/partials/custom-header.html like this:\n​ layouts/partials/custom-header.html \u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' default sett'n o' on, 'n effect since 1.1.0, changed back t' off as there was interference wit' scroll'n on mobile an' big planks.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer hugo.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis also changed th' lightbox effects parameter from featherlight=false t' lightbox=false. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.\nChange In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' expand shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Translat'n into Czech. This language be not supported fer search.\nNew GitHub releases be also now tagged fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) release mak'n it easier fer ye t' pin th' theme t' a certain version.\n5.10.0 (2023-01-25) New Th' attachments, badge, button an' notice shorrrtcodes have a new parameter color t' set arbitrary CSS color values.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.\n5.9.0 (2022-12-23) Break'n Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.\nIt was later discovered, that this causes planks only meant t' be displayed 'n th' More section o' th' menu an' stored directly inside yer rrrambl'n directory t' now show up 'n th' menu as well.\nT' get rid o' this undesired behavior ye have two choices:\nMake th' plank file a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store th' plank file fer below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md). Don’t give this plank a title as this will cause it t' be shown 'n th' breadcrumbs - a th'n ye most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } Change Th' required folder name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a files subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnecessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a index.files directory. Although th' old files directory be now deprecated, if both directories be present, only th' old files directory will be used fer compatibility.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer hugo.toml.\nNew Th' theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New Th' new badge shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.\nNew A new color --ACCENT-color was introduced which be used fer highlight'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old yellow color be still used as default.\n5.7.0 (2022-11-29) Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code ko. Formerly th' country code kr was used instead.\nNew Th' button shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.\nNew Th' search now supports th' Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n through large number o' results.\nT' activate this feature, ye need t' configure it 'n yer hugo.toml as a new outputformat searchpage fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'n CTRL+ALT+t now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' TAB key.\nTh' search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus th' cursor inside o' th' search box so ye can immediately start yer search by typ'n.\nNew Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.\nT' configure this 'n yer hugo.toml make sure t' set Hugo’s disableHugoGeneratorInject=true an' also [params] disableGeneratorVersion=true, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).\n5.5.0 (2022-11-06) Change Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.\nFor that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.\nIf ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML img URLs manually t' th' respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change Wit' th' proper sett'ns 'n yer hugo.toml yer plank be now serv'ble from th' local file system us'n file:// URLs.\nPlease note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer hugo.toml from json t' search. Th' now deprecated json outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from http:// or https://.\nChange Th' button shortcode has a new parameter target t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.\nNew Th' math shortcode an' mermaid shortcode now also support th' align parameter if codefence rules be used.\nNew Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.\nNew Translat'n into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).\nNew Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline opt'n be now documented.\nNew Print'n fer th' swagger shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true 'n yer hugo.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Cap'n Hugo version.\nChange Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' print output format sett'n 'n yer hugo.tomlt':\nhugo. toml yaml json [outputFormats] [outputFormats.print] baseName = 'index' isHTML = true mediaType = 'text/html' name = 'print' path = '_print' permalink'ble = false outputFormats: print: baseName: index isHTML: true mediaType: text/html name: print path: _print permalink'ble: false { \"outputFormats\": { \"print\": { \"baseName\": \"index\", \"isHTML\": true, \"mediaType\": \"text/html\", \"name\": \"print\", \"path\": \"_print\", \"permalinkable\": false } } } 5.0.0 (2022-07-05) Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.\nYer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n after th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:\nfer yer home plank, add th' frontmatter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated frontmatter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' frontmatter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew Add'n new partials heading-pre.html / heading-post.html an' accord'n frontmatter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew Th' new shortcode math be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n4.2.0 (2022-06-23) Break'n Th' second parameter fer th' include shortcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange Previously, if th' tabs shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.\nChange Th' landingPageURL was removed from hugo.toml. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically an' will point t' th' project’s homepage. If ye want t' support a different link, overwrite th' logo.html partial.\nNew All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.\n4.1.0 (2022-06-12) New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank. 4.0.0 (2022-06-05) Break'n Th' custom_css config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' custom-header.html template 'n a much more generic manner.\nBreak'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from --MAIN-LINK-color an' --MAIN-ANCHOR-HOVER-color respectively.\nNew All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew New colors --PRIMARY-color an' --SECONDARY-color were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have primary or secondary as additional values.\nThese two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 (2022-04-03) Break'n If ye had previously overwritten th' custom-footer.html partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial content-footer.html. custom-footer.html was never meant t' contain HTML other than additional styles an' JavaScript.\nNew If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer hugo.toml. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.\nNew Ye can activate print support 'n yer hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between --MAIN-font fer all rrrambl'n text an' --CODE-font fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.\nNew Th' new shortcode swagger be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Cap'n Hugo version.\nChange In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set disableMermaid=false 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.\nNew Additional color variant vari'ble --MERMAID-theme t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.\n3.1.0 (2022-03-15) New attachment an' notice shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons. 3.0.0 (2022-02-22) Break'n We made changes t' th' menu footer. If ye have yer menu-footer.html partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' menu-footer.html partial that be com'n wit' th' exampleSite.\nThis change was made t' allow yer own menu footer t' be placed right after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).\nBreak'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.\nThis change will only affect yer installat'n if you’ve not set th' themeVariant parameter 'n yer hugo.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant=\"learn\" 'n yer hugo.toml.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color t' --MENU-SEARCH-BORDER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.\nNew Ye can now configure multiple color variants 'n yer hugo.toml. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant selector will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant selector will not be displayed wit' Internet Explorer 11.\n2.9.0 (2021-11-19) Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugo’s standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard compliant form ye must not link t' th' *.md file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugo’s 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' Hugo’s implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server after an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console after 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 foundIn this case, ye must apply one o' two opt'ns:\nStart up a text editor wit' regular expression support fer search an' replace. Search fer (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" an' replace it by $1$2\" 'n all *.md files. This be th' recommended choice.\nCopy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes th' font Novacento/Novecento. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.\nNew Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer hugo.toml. For an example see th' example configurat'n.\n2.7.0 (2021-10-24) New Optional second parameter fer notice shortcode t' set title 'n box header. 2.6.0 (2021-10-21) New Yer ship can now be served from a subfolder if ye set baseURL 'n yer hugo.toml. See th' documentat'n fer a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugo’s rules highlight'n 'n case no language was given or th' language be unsupported. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style. 2.4.0 (2021-10-07) Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.\nNew Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer hugo.toml.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer hugo.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Cap'n Hugo version.\nNew Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.\n2.2.0 (2021-09-09) New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n disableSeoHiddenPages=true 'n yer hugo.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Cap'n Hugo version.\nChange In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n th' exampleSite), they will now be ignored by th' search.\nNew Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n disableSearchHiddenPages=true 'n yer hugo.toml.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.\n2.0.0 (2021-08-28) Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n\nChange In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange --MENU-HOME-LINK-color an' --MENU-HOME-LINK-HOVER-color were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.\nChange Arrow navigat'n an' children shortcode were ignor'n sett'n fer ordersectionsby. This be now changed an' may result 'n different sort'n order o' yer sub planks.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 (2021-07-26) New Shortcode expand wit' new parameter t' open on plank board. 1.1.0 (2021-07-02) Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.\nNew Merrrmaid config opt'ns can be set 'n hugo.toml.\n1.0.0 (2021-07-01) 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.\nNew Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' Relearrrn an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.", "description": "Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n.", - "tags": null, + "tags": [], "title": "What's New", "uri": "/hugo-theme-relearn/pir/basics/migration/index.html" }, { "breadcrumb": "Rambl'n", - "content": "Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ _index.md +++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ _index.md +++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 1 +++ Lorem Ipsum. Th' weight number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ *.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Self defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n​ \u003ckind\u003e.md +++ archetype = \"\u003ckind\u003e\" +++ Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n", + "content": "Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ _index.md +++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ _index.md +++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 1 +++ Lorem Ipsum. Th' weight number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n​ *.md +++ title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum. Self defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n​ \u003ckind\u003e.md +++ archetype = \"\u003ckind\u003e\" +++ Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.", "description": "Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set.", - "tags": null, + "tags": [], "title": "Arrrchetypes", "uri": "/hugo-theme-relearn/pir/cont/archetypes/index.html" }, { "breadcrumb": "", - "content": "Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shortcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nBadgeMarker badges t' display 'n yer text\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nHighlightRender code wit' a rules highlighter\nAy'conNice ay'cons fer yer plank\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nOpenAPIUI fer yer OpenAPI / Swagger specificat'ns\nResourcesList resources contained 'n a plank bundle\nSiteParamGet value o' ship params\nTabShow rrrambl'n 'n a single tab\nTabsShow rrrambl'n 'n tabbed views\n", + "content": "Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.\nBut this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.\nT' avoid this limitat'ns, Cap'n Hugo created shorrrtcodes. A shortcode be a simple snippet inside a plank.\nTh' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.\nBadgeMarker badges t' display 'n yer text\nButtonClick'ble buttons\nChildrenList th' child planks o' a plank\nExpandExpandable/collaps'ble sections o' text\nHighlightRender code wit' a rules highlighter\nAy'conNice ay'cons fer yer plank\nIncludeDisplays rrrambl'n from other files\nMathBeautiful math an' chemical formulae\nMerrrmaidGenerate diagrams an' flowcharts from text\nNoticeDisclaimers t' help ye structure yer plank\nOpenAPIUI fer yer OpenAPI / Swagger specificat'ns\nResourcesList resources contained 'n a plank bundle\nSiteParamGet value o' ship params\nTabShow rrrambl'n 'n a single tab\nTabsShow rrrambl'n 'n tabbed views", "description": "Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well.", - "tags": null, + "tags": [], "title": "Shorrrtcodes", "uri": "/hugo-theme-relearn/pir/shortcodes/index.html" }, { "breadcrumb": "", - "content": "This chapter contains informat'n only needed fer development an' maintain'n th' theme.\nContribut'nWhat t' know if ye want t' contribute\nMaintain'nWhat t' know as a maintainer\nScreenshotsRecipe t' create various documentat'n screenshots\n", + "content": "This chapter contains informat'n only needed fer development an' maintain'n th' theme.\nContribut'nWhat t' know if ye want t' contribute\nMaintain'nWhat t' know as a maintainer\nScreenshotsRecipe t' create various documentat'n screenshots", "description": "This chapter contains informat'n only needed fer development an' maintain'n th' theme.", - "tags": null, + "tags": [], "title": "Development", "uri": "/hugo-theme-relearn/pir/dev/index.html" }, { "breadcrumb": "Rambl'n", - "content": "Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nSmarrrt Arrrse Bookmark this plank fer easy future reference!\nStandard an' Extensions If not otherwise noted, th' showed examples adhere t' th' Commonmark standard. In addit'n th' theme supports th' follow'n extensions:\nGFM Extension on top o' standard Marrrkdown adher'n t' GitHub Flavored Marrrkdown.\nPHP Extension on top o' standard Marrrkdown adher'n t' PHP Marrrkdown.\nPants Extension by John Gruber adher'n t' SmartyPants.\nRelearrrn Extension specific t' this theme.\nHTML If th' usage o' HTML be allowed 'n yer hugo.toml th' theme supports styl'n fer further elements not access'ble us'n Marrrkdown alone.\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough GFM Ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nMarked Text HTML Ye can mark text 'n th' predefined accent color o' yer stylesheet.\n\u003cmark\u003eParts\u003c/mark\u003e o' this text \u003cmark\u003ebe marked!\u003c/mark\u003e Result Parts o' this text be marked!\nSpecial Typesett'n Text Substitut'n Pants Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nKeyboard Shortcuts HTML Ye can use th' \u003ckbd\u003e element t' style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e t' end yer shift early. Result Press STRG ALT DEL t' end yer shift early.\nSub an' Super Script HTML Ye can also use th' \u003csub\u003e an' \u003csup\u003e elements. For more complex stuff or if yer configurat'n does not allow HTML, ye can use th' math shortcode.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks GFM Ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns PHP Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nGFM Ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | |--------|-------------| | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink GFM Absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearrrn This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble through yer hugo.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", - "description": "Let\u0026rsquo;s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.", + "content": "Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nSmarrrt Arrrse Bookmark this plank fer easy future reference!\nStandard an' Extensions If not otherwise noted, th' showed examples adhere t' th' Commonmark standard. In addit'n th' theme supports th' follow'n extensions:\nGFM Extension on top o' standard Marrrkdown adher'n t' GitHub Flavored Marrrkdown.\nPHP Extension on top o' standard Marrrkdown adher'n t' PHP Marrrkdown.\nPants Extension by John Gruber adher'n t' SmartyPants.\nRelearrrn Extension specific t' this theme.\nHTML If th' usage o' HTML be allowed 'n yer hugo.toml th' theme supports styl'n fer further elements not access'ble us'n Marrrkdown alone.\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough GFM Ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nMarked Text HTML Ye can mark text 'n th' predefined accent color o' yer stylesheet.\n\u003cmark\u003eParts\u003c/mark\u003e o' this text \u003cmark\u003ebe marked!\u003c/mark\u003e Result Parts o' this text be marked!\nSpecial Typesett'n Text Substitut'n Pants Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nKeyboard Shortcuts HTML Ye can use th' \u003ckbd\u003e element t' style keyboard shortcuts.\nPress \u003ckbd\u003eSTRG\u003c/kbd\u003e \u003ckbd\u003eALT\u003c/kbd\u003e \u003ckbd\u003eDEL\u003c/kbd\u003e t' end yer shift early. Result Press STRG ALT DEL t' end yer shift early.\nSub an' Super Script HTML Ye can also use th' \u003csub\u003e an' \u003csup\u003e elements. For more complex stuff or if yer configurat'n does not allow HTML, ye can use th' math shortcode.\nHow many liters H\u003csub\u003e2\u003c/sub\u003eO fit into 1dm\u003csup\u003e3\u003c/sup\u003e? Result How many liters H2O fit into 1dm3?\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks GFM Ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns PHP Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nGFM Ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; ``` Result { name: \"Claus\", surname: \"Santa\", profession: \"courier\", age: 666, address: { city: \"North Pole\", postalCode: 1, country: \"Arctic\" }, friends: [ \"Dasher\", \"Dancer\", \"Prancer\", \"Vixen\", \"Comet\", \"Cupid\", \"Donder\", \"Blitzen\", \"Rudolph\" ] }; Tables GFM Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | |--------|-------------| | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink GFM Absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes PHP Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects Relearrrn This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble through yer hugo.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)", + "description": "Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.", "tags": [ "Content" ], @@ -85,9 +85,9 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": "Th' theme supports non-standard image effects.\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer hugo.toml as well as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer hugo.toml this defaults t'\nhugo. toml yaml json [params] [params.imageEffects] border = false lazy = true lightbox = true shadow = false params: imageEffects: border: false lazy: true lightbox: true shadow: false { \"params\": { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } } This can be overridden 'n a planks frontmatter by eg.\n​ toml yaml json +++ [imageEffects] border = true +++ --- imageEffects: border: true --- { \"imageEffects\": { \"border\": true } } Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) Th' sett'ns applied t' th' above image would be\n​ toml yaml json bg-white = true border = true lazy = true lightbox = false shadow = false bg-white: true border: true lazy: true lightbox: false shadow: false { \"bg-white\": true, \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false } This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" load'n=\"lazy\" alt=\"Minion\" class=\"bg-white border lazy nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer hugo.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' hugo.toml or planks frontmatter.\n", + "content": "Th' theme supports non-standard image effects.\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer hugo.toml as well as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer hugo.toml this defaults t'\nhugo. toml yaml json [params] [params.imageEffects] border = false lazy = true lightbox = true shadow = false params: imageEffects: border: false lazy: true lightbox: true shadow: false { \"params\": { \"imageEffects\": { \"border\": false, \"lazy\": true, \"lightbox\": true, \"shadow\": false } } } This can be overridden 'n a planks frontmatter by eg.\n​ toml yaml json +++ [imageEffects] border = true +++ --- imageEffects: border: true --- { \"imageEffects\": { \"border\": true } } Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) Th' sett'ns applied t' th' above image would be\n​ toml yaml json bg-white = true border = true lazy = true lightbox = false shadow = false bg-white: true border: true lazy: true lightbox: false shadow: false { \"bg-white\": true, \"border\": true, \"lazy\": true, \"lightbox\": false, \"shadow\": false } This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" load'n=\"lazy\" alt=\"Minion\" class=\"bg-white border lazy nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer hugo.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' hugo.toml or planks frontmatter.", "description": "Th' theme supports non-standard image effects.\nName Descript'n border Draws a light thin border around th' image lazy Lets th' image be lazy boarded lightbox Th' image will be click'ble t' show it enlarged shadow Draws a shadow around th' image t' make it appear hovered/glow'n As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' be done consistently fer th' whole plank.", - "tags": null, + "tags": [], "title": "Image Effects", "uri": "/hugo-theme-relearn/pir/cont/imageeffects/index.html" }, @@ -95,7 +95,7 @@ var relearn_search_index = [ "breadcrumb": "Rambl'n", "content": "Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n hugo.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\nhugo. toml yaml json [menu] [[menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" url = 'showcase/' weight = 11 [[menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" url = 'https://gohugo.io/' weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = 'more/credits/' weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" url = 'tags/' weight = 40 menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases url: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits url: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags url: tags/ weight: 40 { \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"url\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Cap'n Hugo Documentation\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Credits\", \"url\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"url\": \"tags/\", \"weight\": 40 } ] } } By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overridden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n​ en.toml [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' hugo.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\nhugo. toml yaml json [languages] [languages.en] languageName = 'English' title = 'Hugo Relearrrn Theme' weight = 1 [languages.en.menu] [[languages.en.menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = 'showcase/' weight = 11 [[languages.en.menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" url = 'https://gohugo.io/' weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = 'more/credits/' weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = 'tags/' weight = 40 [languages.en.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" [languages.pir] languageName = 'Arrr! Pirrrates' title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 [languages.pir.menu] [[languages.pir.menu.shortcuts]] identifier = 'ds' name = \"\u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo\" url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = 'showcase/' weight = 11 [[languages.pir.menu.shortcuts]] identifier = 'hugodoc' name = \"\u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" url = 'https://gohugo.io/' weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = 'more/credits/' weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = 'tags/' weight = 40 [languages.pir.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" languages: en: languageName: English menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases pageRef: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Credits pageRef: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags pageRef: tags/ weight: 40 params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home title: Cap'n Hugo Relearrrn Theme weight: 1 pir: languageName: Arrr! Pirrrates menu: shortcuts: - identifier: ds name: \u003ci class='fa-fw fab fa-github'\u003e\u003c/i\u003e GitHub repo url: https://github.com/McShelby/hugo-theme-relearn weight: 10 - name: \u003ci class='fa-fw fas fa-camera'\u003e\u003c/i\u003e Showcases pageRef: showcase/ weight: 11 - identifier: hugodoc name: \u003ci class='fa-fw fas fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n url: https://gohugo.io/ weight: 20 - name: \u003ci class='fa-fw fas fa-bullhorn'\u003e\u003c/i\u003e Crrredits pageRef: more/credits/ weight: 30 - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Arrr! Tags pageRef: tags/ weight: 40 params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Home title: Cap'n Hugo Relearrrn Theme weight: 1 { \"languages\": { \"en\": { \"languageName\": \"English\", \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"pageRef\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Cap'n Hugo Documentation\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Credits\", \"pageRef\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"pageRef\": \"tags/\", \"weight\": 40 } ] }, \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" }, \"title\": \"Hugo Relearrrn Theme\", \"weight\": 1 }, \"pir\": { \"languageName\": \"Arrr! Pirrrates\", \"menu\": { \"shortcuts\": [ { \"identifier\": \"ds\", \"name\": \"\\u003ci class='fa-fw fab fa-github'\\u003e\\u003c/i\\u003e GitHub repo\", \"url\": \"https://github.com/McShelby/hugo-theme-relearn\", \"weight\": 10 }, { \"name\": \"\\u003ci class='fa-fw fas fa-camera'\\u003e\\u003c/i\\u003e Showcases\", \"pageRef\": \"showcase/\", \"weight\": 11 }, { \"identifier\": \"hugodoc\", \"name\": \"\\u003ci class='fa-fw fas fa-bookmark'\\u003e\\u003c/i\\u003e Cap'n Hugo Documentat'n\", \"url\": \"https://gohugo.io/\", \"weight\": 20 }, { \"name\": \"\\u003ci class='fa-fw fas fa-bullhorn'\\u003e\\u003c/i\\u003e Crrredits\", \"pageRef\": \"more/credits/\", \"weight\": 30 }, { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Arrr! Tags\", \"pageRef\": \"tags/\", \"weight\": 40 } ] }, \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Arrr! Home\" }, \"title\": \"Cap'n Hugo Relearrrn Theme\", \"weight\": 1 } } } Read more about hugo menu an' hugo multilingual menus\nShortcuts t' planks inside o' yer project If ye have shortcuts t' planks inside o' yer project an' ye don’t want them t' show up 'n plank menu section, ye have two choices:\nMake th' plank file fer th' shortcut a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\n​ toml yaml json +++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++ --- _build: list: never publishResources: true render: always title: Showcase --- { \"_build\": { \"list\": \"never\", \"publishResources\": true, \"render\": \"always\" }, \"title\": \"Showcase\" } Store th' plank file fer th' shortcut below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md). Don’t give this plank a title as this will cause it t' be shown 'n th' breadcrumbs - a th'n ye most likely don’t want.\n​ toml yaml json +++ [_build] list = 'never' publishResources = false render = 'never' +++ --- _build: list: never publishResources: false render: never --- { \"_build\": { \"list\": \"never\", \"publishResources\": false, \"render\": \"never\" } } In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\n​ toml yaml json +++ title = 'Credits' +++ --- title: Credits --- { \"title\": \"Credits\" } ", "description": "Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.", - "tags": null, + "tags": [], "title": "Menu extrrra shorrrtcuts", "uri": "/hugo-theme-relearn/pir/cont/menushortcuts/index.html" }, @@ -103,15 +103,17 @@ var relearn_search_index = [ "breadcrumb": "Rambl'n", "content": "Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nAvail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer hugo.toml file.\nFor example wit' current English an' Piratized English website.\nAvast Make sure yer default language be defined as th' first one 'n th' [languages] array, as th' theme needs t' make assumpt'ns on it\nhugo. toml yaml json defaultContentLanguage = 'en' [languages] [languages.en] languageName = 'English' title = 'Hugo Relearrrn Theme' weight = 1 [languages.pir] languageName = 'Arrr! Pirrrates' title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 defaultContentLanguage: en languages: en: languageName: English title: Cap'n Hugo Relearrrn Theme weight: 1 pir: languageName: Arrr! Pirrrates title: Cap'n Hugo Relearrrn Theme weight: 2 { \"defaultContentLanguage\": \"en\", \"languages\": { \"en\": { \"languageName\": \"English\", \"title\": \"Hugo Relearrrn Theme\", \"weight\": 1 }, \"pir\": { \"languageName\": \"Arrr! Pirrrates\", \"title\": \"Cap'n Hugo Relearrrn Theme\", \"weight\": 2 } } } Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' site’s search via th' Lunr search library does not. You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nCzech Indonesian Polish Swahili Search wit' mixed language support In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer hugo.toml t' broaden search.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] params: additionalContentLanguage: - en { \"params\": { \"additionalContentLanguage\": [ \"en\" ] } } As this be an array, ye can add multiple additional languages.\nAvast Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n zh-CN, ye have t' add just zh t' this parameter.\nOverwrite translat'n str'ns Translat'ns str'ns be used fer common default values used 'n th' theme (Edit button, Search placeholder an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.\nT' override these values, create a new file 'n yer local i18n folder i18n/\u003cidlanguage\u003e.toml an' inspire yourself from th' theme themes/hugo-theme-relearn/i18n/en.toml\nDis'ble language switch'n Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.\nJust set disableLanguageSwitchingButton=true 'n yer hugo.toml\nhugo. toml yaml json [params] disableLanguageSwitchingButton = true params: disableLanguageSwitchingButton: true { \"params\": { \"disableLanguageSwitchingButton\": true } } ", "description": "Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.", - "tags": null, + "tags": [], "title": "Multilingual an' i18n", "uri": "/hugo-theme-relearn/pir/cont/i18n/index.html" }, { "breadcrumb": "Rambl'n", "content": "Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box.\nConfigurat'n Just add tags and/or categories t' any plank. They can be given as a single str'n or an array o' str'ns.\n​ toml yaml json +++ categories = ['taxonomy', 'content'] tags = 'tutorial' title = 'Taxonomy' +++ --- categories: - taxonomy - rrrambl'n tags: tutorial title: Taxonomy --- { \"categories\": [ \"taxonomy\", \"content\" ], \"tags\": \"tutorial\", \"title\": \"Taxonomy\" } Behavior Th' tags be displayed at th' top o' th' plank 'n alphabetical order.\nTh' categories be displayed at th' bottom o' th' plank 'n alphabetical order 'n th' default implementat'n o' th' theme but can be customized by provid'n yer own content-footer.html partial.\nEach item be a link t' a taxonomy plank display'n all th' articles wit' th' given term.\nList all th' tags In th' hugo.toml file ye can add a shortcut t' display all th' tags an' categories\nhugo. toml yaml json [menu] [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags\" url = '/tags' [[menu.shortcuts]] name = \"\u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = '/categories' menu: shortcuts: - name: \u003ci class='fa-fw fas fa-tags'\u003e\u003c/i\u003e Tags url: /tags - name: \u003ci class='fa-fw fas fa-layer-group'\u003e\u003c/i\u003e Categories url: /categories { \"menu\": { \"shortcuts\": [ { \"name\": \"\\u003ci class='fa-fw fas fa-tags'\\u003e\\u003c/i\\u003e Tags\", \"url\": \"/tags\" }, { \"name\": \"\\u003ci class='fa-fw fas fa-layer-group'\\u003e\\u003c/i\\u003e Categories\", \"url\": \"/categories\" } ] } } Customizat'n If ye define custom taxonomies an' want t' display a list o' them somewhere on yer plank (often 'n th' layouts/partials/content-footer.html) ye can call a partial that does th' job fer ye:\n{{ partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. taxonomy \u003cempty\u003e Th' plural name o' th' taxonomy t' display as used 'n yer frontmatter. class \u003cempty\u003e Additional CSS classes set on th' outermost generated HTML element.\nIf set t' tags ye will get th' visuals fer display'n th' tags taxonomy, otherwise it will be a simple list o' links as fer th' categories taxonomy. style primary Th' style scheme used if class be tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used if class be tags. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con \u003cempty\u003e An optional Font Awesome ay'con name set t' th' left o' th' list. ", - "description": "Th' Relearrrn theme supports Hugo\u0026rsquo;s default taxonomies tag an' category out o' th' box.", - "tags": "tutorrrial", + "description": "Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box.", + "tags": [ + "Tutorrrial" + ], "title": "Taxonomy", "uri": "/hugo-theme-relearn/pir/cont/taxonomy/index.html" }, @@ -120,26 +122,26 @@ var relearn_search_index = [ "content": "This be a demo child plank.\nSubpages o' this plank plank 1-1 ", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html" }, { "breadcrumb": "Basics", - "content": "Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download at least version 0.121.0 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).\nIt’s a kind o' magic\n", + "content": "Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.\nJust download at least version 0.121.0 o' th' Cap'n Hugo binary fer yer OS (Windows, Linux, Mac).\nIt’s a kind o' magic", "description": "Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.", - "tags": null, + "tags": [], "title": "Requirrrements", "uri": "/hugo-theme-relearn/pir/basics/requirements/index.html" }, { "breadcrumb": "Basics", - "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.\nSmarrrt Arrrse Th' follow'n tutorial leads ye through th' steps o' creat'n a first, minimal new ship.\nYe don’t need t' edit any files besides yer hugo.toml an' only need t' execute th' commands 'n th' given order.\nCreate yer Project Cap'n Hugo provides th' new command t' create a new website:\nhugo new ship my-new-siteAft that change into th' directory:\ncd my-new-siteEvery upcom'n command will be executed from inside yer new site’s root.\nInstall th' Theme Download'n as Archive Ye can download th' theme as .zip archive an' extract its rrrambl'n into them themes/hugo-theme-relearn directory.\nAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Us'n Hugo’s Module System Ye can install th' Relearrrn theme by follow'n th' standard documentat'n us'n Hugo’s module system:\nhugo mod init example.comAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Us'n Git Submodules If ye plan t' store yer project 'n a git repository ye can create one wit':\ngit initNow add th' theme as a submodule by:\ngit submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearnAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create yer Home Plank If ye don’t create a home plank, yet, th' theme will generate a placeholder text wit' instruct'ns on how t' proceed.\nStart yer journey by creat'n a home plank:\nhugo new --kind home _index.mdTh' newly created home plank content/_index.md be empty an' ye obviously should add some meaningful rrrambl'n.\nCreate yer First Chapter Plank Chapters be meant t' be top level planks that contain other child planks. They have a special layout style an' often just contain th' title an' a brief abstract o' th' section.\nNow create yer first chapter plank wit' th' follow'n command:\nhugo new --kind chapter basics/_index.mdWhen open'n th' newly created file content/basics/_index.md, ye should see th' weight frontmatter wit' a number. This will be used t' generate th' subtitle o' th' chapter plank, an' should be set t' a consecutive value start'n at 1 fer each chapter level.\nCreate yer First Rrrambl'n Planks Then create rrrambl'n planks inside th' previously created chapter. Here be three ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content/_index.md hugo new basics/second-content/index.md hugo new basics/third-content.mdFeel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nAvast Please note that Cap'n Hugo overrides th' default archetype template com'n wit' this theme when us'n hugo new ship my-new-site. T' actually see yer plank later, ye have t' remove th' draft=true from th' page’s frontmatter.\nTest'n yer Website Locally Launch yer new web ship by us'n th' follow'n command:\nhugo serveGo t' http://localhost:1313 'n yer browser.\nYe should notice a few th'ns:\nTh' home plank contains yer provided text. Ye have th' menu Basics 'n th' sidebar. Click'n on it reveals three submenus wit' names equal t' th' title properties 'n th' previously created rrrambl'n planks. While ye be runn'n hugo serve yer plank refreshes automatically when ye change a rrrambl'n plank. Neat! Build an' Deploy yer Website When yer ship be ready t' be deployed, run th' follow'n command:\nhugoA public directory will be generated, contain'n all rrrambl'n an' assets fer yer web ship.\nIt now can be deployed t' any web server by simply upload'n its contents or ye can check out one o' Hugo’s many other deployment opt'ns.\nAvast If ye be stor'n yer web ship 'n git, commit all but th' public directory.\n", + "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.\nSmarrrt Arrrse Th' follow'n tutorial leads ye through th' steps o' creat'n a first, minimal new ship.\nYe don’t need t' edit any files besides yer hugo.toml an' only need t' execute th' commands 'n th' given order.\nCreate yer Project Cap'n Hugo provides th' new command t' create a new website:\nhugo new ship my-new-siteAft that change into th' directory:\ncd my-new-siteEvery upcom'n command will be executed from inside yer new site’s root.\nInstall th' Theme Download'n as Archive Ye can download th' theme as .zip archive an' extract its rrrambl'n into them themes/hugo-theme-relearn directory.\nAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Us'n Hugo’s Module System Ye can install th' Relearrrn theme by follow'n th' standard documentat'n us'n Hugo’s module system:\nhugo mod init example.comAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json [module] [[module.imports]] path = 'github.com/McShelby/hugo-theme-relearn' module: imports: - path: github.com/McShelby/hugo-theme-relearn { \"module\": { \"imports\": [ { \"path\": \"github.com/McShelby/hugo-theme-relearn\" } ] } } Us'n Git Submodules If ye plan t' store yer project 'n a git repository ye can create one wit':\ngit initNow add th' theme as a submodule by:\ngit submodule add https://github.com/McShelby/hugo-theme-relearn.git themes/hugo-theme-relearnAfterwards add this at th' end o' yer hugo.toml.\nhugo. toml yaml json theme = 'hugo-theme-relearn' theme: hugo-theme-relearn { \"theme\": \"hugo-theme-relearn\" } Create yer Home Plank If ye don’t create a home plank, yet, th' theme will generate a placeholder text wit' instruct'ns on how t' proceed.\nStart yer journey by creat'n a home plank:\nhugo new --kind home _index.mdTh' newly created home plank content/_index.md be empty an' ye obviously should add some meaningful rrrambl'n.\nCreate yer First Chapter Plank Chapters be meant t' be top level planks that contain other child planks. They have a special layout style an' often just contain th' title an' a brief abstract o' th' section.\nNow create yer first chapter plank wit' th' follow'n command:\nhugo new --kind chapter basics/_index.mdWhen open'n th' newly created file content/basics/_index.md, ye should see th' weight frontmatter wit' a number. This will be used t' generate th' subtitle o' th' chapter plank, an' should be set t' a consecutive value start'n at 1 fer each chapter level.\nCreate yer First Rrrambl'n Planks Then create rrrambl'n planks inside th' previously created chapter. Here be three ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content/_index.md hugo new basics/second-content/index.md hugo new basics/third-content.mdFeel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nAvast Please note that Cap'n Hugo overrides th' default archetype template com'n wit' this theme when us'n hugo new ship my-new-site. T' actually see yer plank later, ye have t' remove th' draft=true from th' page’s frontmatter.\nTest'n yer Website Locally Launch yer new web ship by us'n th' follow'n command:\nhugo serveGo t' http://localhost:1313 'n yer browser.\nYe should notice a few th'ns:\nTh' home plank contains yer provided text. Ye have th' menu Basics 'n th' sidebar. Click'n on it reveals three submenus wit' names equal t' th' title properties 'n th' previously created rrrambl'n planks. While ye be runn'n hugo serve yer plank refreshes automatically when ye change a rrrambl'n plank. Neat! Build an' Deploy yer Website When yer ship be ready t' be deployed, run th' follow'n command:\nhugoA public directory will be generated, contain'n all rrrambl'n an' assets fer yer web ship.\nIt now can be deployed t' any web server by simply upload'n its contents or ye can check out one o' Hugo’s many other deployment opt'ns.\nAvast If ye be stor'n yer web ship 'n git, commit all but th' public directory.", "description": "Th' follow'n steps be here t' help ye initialize yer new website.", "tags": [ - "documentat'n" + "Documentat'n" ], "title": "Installat'n", "uri": "/hugo-theme-relearn/pir/basics/installation/index.html" @@ -147,29 +149,29 @@ var relearn_search_index = [ { "breadcrumb": "Basics", "content": "On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\nAll config opt'ns Th' values reflect th' opt'ns active 'n this documentat'n. Th' defaults can be taken from th' annotated example below.\nhugo. toml yaml json [params] additionalContentLanguage = ['en'] alwaysopen = '' breadcrumbSeparator = '\u003e' collapsibleMenu = true customMathJaxURL = '' customMermaidURL = '' customOpenapiURL = '' disableAssetsBust'n = false disableBreadcrumb = false disableExplicitIndexURLs = false disableGeneratorVersion = false disableHoverBlockCopyToClipBoard = false disableInlineCopyToClipBoard = true disableLandingPageButton = true disableLanguageSwitchingButton = false disableMathJax = true disableMermaid = true disableNextPrev = false disableOpenapi = true disableRandomIds = false disableRootBreadcrumb = true disableSearch = false disableSearchHiddenPages = false disableSeoHiddenPages = true disableShortcutsTitle = false disableTagHiddenPages = false disableTermBreadcrumbs = false disableToc = false editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' externalLinkTarget = '_self' highlightWrap = true images = ['images/hero.png'] mathJaxInitialize = '{}' mermaidInitialize = '{ \"securityLevel\": \"loose\" }' mermaidZoom = true ordersectionsby = 'weight' showVisitedLinks = true titleSeparator = '::' [params.author] name = 'Sören Weber' [params.image] errorlevel = 'error' [params.imageEffects] border = true lazy = true lightbox = true shadow = false [params.include] errorlevel = 'error' [params.link] errorlevel = 'error' [params.social] facebook_admin = '' twitter = '' [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] identifier = 'relearn-bright' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] auto = ['learn', 'neon'] identifier = 'retro-auto' name = 'Retro Learn/Neon' [[params.themeVariant]] identifier = 'neon' [[params.themeVariant]] identifier = 'learn' [[params.themeVariant]] identifier = 'blue' [[params.themeVariant]] identifier = 'green' [[params.themeVariant]] identifier = 'red' params: additionalContentLanguage: - en alwaysopen: \"\" author: name: Sören Weber breadcrumbSeparator: '\u003e' collapsibleMenu: true customMathJaxURL: \"\" customMermaidURL: \"\" customOpenapiURL: \"\" disableAssetsBust'n: false disableBreadcrumb: false disableExplicitIndexURLs: false disableGeneratorVersion: false disableHoverBlockCopyToClipBoard: false disableInlineCopyToClipBoard: true disableLandingPageButton: true disableLanguageSwitchingButton: false disableMathJax: true disableMermaid: true disableNextPrev: false disableOpenapi: true disableRandomIds: false disableRootBreadcrumb: true disableSearch: false disableSearchHiddenPages: false disableSeoHiddenPages: true disableShortcutsTitle: false disableTagHiddenPages: false disableTermBreadcrumbs: false disableToc: false editURL: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath} externalLinkTarget: _self highlightWrap: true image: errorlevel: error imageEffects: border: true lazy: true lightbox: true shadow: false images: - images/hero.png include: errorlevel: error link: errorlevel: error mathJaxInitialize: '{}' mermaidInitialize: '{ \"securityLevel\": \"loose\" }' mermaidZoom: true ordersectionsby: weight showVisitedLinks: true social: facebook_admin: \"\" twitter: \"\" themeVariant: - auto: [] identifier: relearn-auto name: Relearrrn Light/Dark - identifier: relearn-light - identifier: relearn-dark - identifier: relearn-bright - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - auto: - learn - neon identifier: retro-auto name: Retro Learn/Neon - identifier: neon - identifier: learn - identifier: blue - identifier: green - identifier: red titleSeparator: '::' { \"params\": { \"additionalContentLanguage\": [ \"en\" ], \"alwaysopen\": \"\", \"author\": { \"name\": \"Sören Weber\" }, \"breadcrumbSeparator\": \"\\u003e\", \"collapsibleMenu\": true, \"customMathJaxURL\": \"\", \"customMermaidURL\": \"\", \"customOpenapiURL\": \"\", \"disableAssetsBusting\": false, \"disableBreadcrumb\": false, \"disableExplicitIndexURLs\": false, \"disableGeneratorVersion\": false, \"disableHoverBlockCopyToClipBoard\": false, \"disableInlineCopyToClipBoard\": true, \"disableLandingPageButton\": true, \"disableLanguageSwitchingButton\": false, \"disableMathJax\": true, \"disableMermaid\": true, \"disableNextPrev\": false, \"disableOpenapi\": true, \"disableRandomIds\": false, \"disableRootBreadcrumb\": true, \"disableSearch\": false, \"disableSearchHiddenPages\": false, \"disableSeoHiddenPages\": true, \"disableShortcutsTitle\": false, \"disableTagHiddenPages\": false, \"disableTermBreadcrumbs\": false, \"disableToc\": false, \"editURL\": \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\", \"externalLinkTarget\": \"_self\", \"highlightWrap\": true, \"image\": { \"errorlevel\": \"error\" }, \"imageEffects\": { \"border\": true, \"lazy\": true, \"lightbox\": true, \"shadow\": false }, \"images\": [ \"images/hero.png\" ], \"include\": { \"errorlevel\": \"error\" }, \"link\": { \"errorlevel\": \"error\" }, \"mathJaxInitialize\": \"{}\", \"mermaidInitialize\": \"{ \\\"securityLevel\\\": \\\"loose\\\" }\", \"mermaidZoom\": true, \"ordersectionsby\": \"weight\", \"showVisitedLinks\": true, \"social\": { \"facebook_admin\": \"\", \"twitter\": \"\" }, \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"identifier\": \"relearn-bright\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"auto\": [ \"learn\", \"neon\" ], \"identifier\": \"retro-auto\", \"name\": \"Retro Learn/Neon\" }, { \"identifier\": \"neon\" }, { \"identifier\": \"learn\" }, { \"identifier\": \"blue\" }, { \"identifier\": \"green\" }, { \"identifier\": \"red\" } ], \"titleSeparator\": \"::\" } } Annotated config opt'ns ​ hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by giv'n it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes as well. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Brand'n # These opt'ns set yer overall visual appearance. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explanat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"retro-auto\", name = \"Retro Learn/Neon\", auto = [ \"learn\", \"neon\" ] }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In this case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Multilanguage rrrambl'n. # Default: not set # If yer planks contain further languages besides th' main one used, add all # those auxiliary languages here. This will create a search index wit' # support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See hugo.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' value can contain th' macro # `${FilePath}` which will be replaced by th' file path o' yer displayed plank. # If no `${FilePath}` be given 'n th' value, th' value be treated as if th' # `${FilePath}` was appended at th' end o' th' value. This can be overridden # 'n th' planks frontmatter. This be useful if ye want t' give th' opportunity # fer people t' create merge request fer yer rrrambl'n. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu appearance. # Hide th' search box. # Default: false # If th' search box be disabled, th' search functionality be disabled too. # This will also cause th' keyboard shortcut t' be disabled an' th' dedicated # search plank be not linked although it mighty be configured. disableSearch = false # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. # This can be overridden 'n th' page's frontmatter. collapsibleMenu = true # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Hide head'n above th' shortcut menu. # Default: false # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opt'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: \"::\" # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = \"\u003e\" # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Include # These opt'ns configure how th' include shortcode works. # What t' do when path be not resolved. # Default: \"\" # Ye can control what should happen if a path can not be resolved t' as # a resource or via th' file system. If not set, no output will be written # fer th' unresolved path. If set t' `warning` th' same happens an' an additional # warning be printed. If set t' `error` an error message be printed an' th' build # be aborted. include.errorlevel = \"error\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # What t' do when local image link be not resolved. # Default: \"\" # Ye can control what should happen if a local image can not be resolved t' as # a resource. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that this can not resolve files inside o' yer `static` directory. image.errorlevel = \"error\" # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or through URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lazy = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # What t' do when local plank link be not resolved. # Default: \"\" # Ye can control what should happen if a local link can not be resolved t' a # plank. If not set, th' unresolved link be written as given into th' result'n # output. If set t' `warning` th' same happens an' an additional warning be # printed. If set t' `error` an error message be printed an' th' build be # aborted. # Please note that wit' Cap'n Hugo \u003c 0.123.0 + `uglyURLs=true` this can lead t' false # negatives. link.errorlevel = \"error\" # How t' open external links. # Default: \"_blank\" # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use \"_self\". externalLinkTarget = \"_self\" # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", - "description": "On top o' Hugo\u0026rsquo;s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.", + "description": "On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.", "tags": [ - "config" + "Config" ], "title": "Configurrrat'n", "uri": "/hugo-theme-relearn/pir/basics/configuration/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children", - "content": "This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.\n", + "content": "This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.", "description": "This be a demo child plank wit' no descript'n.\nSo its rrrambl'n be used as descript'n.", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 2", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-2/index.html" }, { "breadcrumb": "Basics", - "content": "Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed through so called color variants.\nA color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo.toml.\nTh' Relearrrn theme ships wit' a wide set o' different color variants. Ye can use them as-is, copy them over an' use them as a start'n point fer yer customizat'ns or just create completely new variants unique t' yer ship. Th' interactive variant generator may help ye wit' this task.\nOnce configured 'n yer hugo.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.\nChange th' Variant (Simple) Single Variant Set th' themeVariant value t' th' name o' yer theme file. That’s it! Yer ship will be displayed 'n this variant only.\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Avast Yer theme variant file must reside 'n yer site’s assets/css directory an' th' file name must start wit' theme- an' end 'n .css. In th' above example, th' path o' yer theme file must be assets/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s assets/css directory. Don’t edit th' file 'n th' theme’s directory!\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Smarrrt Arrrse Th' theme provides an advanced configurat'n mode, combin'n th' functionality fer multiple variants wit' th' below possibilities o' adjust'n t' yer OS sett'ns an' rules highlight'n an' even more!\nAlthough all opt'ns documented here be still work'n, th' advanced configurat'n opt'ns be th' recommended way t' configure yer color variants. See below.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto t' become an auto mode variant. That’s it.\nYe can use th' auto value wit' th' single or multiple variants opt'n. If ye be us'n multiple variants, ye can drop auto at any posit'n 'n th' option’s array, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant opt'n if present.\nIn th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.\nIf ye don’t like that behavior, ye can explicitly set themeVariantAuto. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode.\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Change th' Favicon If yer favicon be a SVG, PNG or ICO, just drop yer image 'n yer site’s static/images/ directory an' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf ye want t' adjust yer favicon accord'n t' yer OS sett'ns fer light/dark mode, add th' image files static/images/favicon-light.svg an' static/images/favicon-dark.svg t' yer site’s directory, respectively, correspond'n t' yer file format. In case some o' th' files be miss'n, th' theme falls back t' favicon.svg fer each miss'n file. All supplied favicons must be o' th' same file format.\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 layouts/partials/favicon.html 'n yer site’s directory an' write someth'n like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' Logo Create a new file 'n layouts/partials/logo.html o' yer ship. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically.\nRules Highlight'n If ye want t' switch th' rules highlight'n theme together wit' yer color variant, ye need t' configure yer installat'n accord'n t' Hugo’s documentat'n an' provide a rules highlight'n stylesheet file.\nYe can use a one o' th' shipped stylesheet files or use Cap'n Hugo t' generate a file fer ye. Th' file must be written t' assets/css/chroma-\u003cNAME\u003e.css. T' use it wit' yer color variant ye have t' define --CODE-theme: \u003cNAME\u003e 'n th' color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css an' hugo.toml o' th' exampleSite.\nChange th' Variant (Advanced) Th' theme offers a new way t' configure theme variants an' all o' th' aspects above inside o' a single configurat'n item. This comes wit' some features previously unsupported.\nLike wit' th' multiple variants opt'n, ye be defin'n yer theme variants 'n an array but now not by simple str'ns but 'n a t'ble wit' subopt'ns.\nAgain, 'n this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } ye now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } Th' identifier opt'n be mandatory an' equivalent t' th' str'n 'n th' first example. Further opt'ns can be configured, see th' t'ble below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond t' th' name o' a color variant either 'n yer site’s or th' theme’s directory 'n th' form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes Th' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form. auto \u003cempty\u003e If set, th' variant be treated as an auto mode variant. It has th' same behavior as th' themeVariantAuto opt'n. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode. Defin'n auto mode variants wit' th' advanced opt'ns has th' benefit that ye can now have multiple auto mode variants instead o' just one wit' th' simple opt'ns. Example Configurat'n o' This Ship hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] identifier = 'neon' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearrrn Light/Dark - identifier: relearn-light - identifier: relearn-dark - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - identifier: neon { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"identifier\": \"neon\" } ] } } Modify Shipped Variants In case ye like a shipped variant but only want t' tweak some aspects, ye have two choices:\nCopy an' change\nYe can copy th' shipped variant file from th' theme’s assets/css directory t' th' site’s assets/css directory an' either store it wit' th' same name or give it a new name. Edit th' sett'ns an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' chosen name.\nCreate an' import\nYe can create a new variant file 'n th' site’s assets/css directory an' give it a new name. Import th' shipped variant, add th' sett'ns ye want t' change an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' chosen name.\nFor example, ye want t' use th' relearn-light variant but want t' change th' rules highlight'n schema t' th' one used 'n th' neon variant. For that, create a new assets/css/theme-my-brand'n.css 'n yer site’s directory an' add th' follow'n lines:\n​ assets/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name o' th' chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color fer code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color fer code background */ } Afterwards put this 'n yer hugo.toml t' use yer new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-brand'n { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison t' copy an' change, this has th' advantage that ye profit from any adjustments t' th' relearn-light variant but keep yer modificat'ns.\n", - "description": "Th' Relearrrn theme provides configurat'n opt'ns t' change yer site\u0026rsquo;s colors, favicon an' logo.", - "tags": null, + "content": "Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed through so called color variants.\nA color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo.toml.\nTh' Relearrrn theme ships wit' a wide set o' different color variants. Ye can use them as-is, copy them over an' use them as a start'n point fer yer customizat'ns or just create completely new variants unique t' yer ship. Th' interactive variant generator may help ye wit' this task.\nOnce configured 'n yer hugo.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.\nChange th' Variant (Simple) Single Variant Set th' themeVariant value t' th' name o' yer theme file. That’s it! Yer ship will be displayed 'n this variant only.\nhugo. toml yaml json [params] themeVariant = 'relearn-light' params: themeVariant: relearn-light { \"params\": { \"themeVariant\": \"relearn-light\" } } Avast Yer theme variant file must reside 'n yer site’s assets/css directory an' th' file name must start wit' theme- an' end 'n .css. In th' above example, th' path o' yer theme file must be assets/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s assets/css directory. Don’t edit th' file 'n th' theme’s directory!\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } Smarrrt Arrrse Th' theme provides an advanced configurat'n mode, combin'n th' functionality fer multiple variants wit' th' below possibilities o' adjust'n t' yer OS sett'ns an' rules highlight'n an' even more!\nAlthough all opt'ns documented here be still work'n, th' advanced configurat'n opt'ns be th' recommended way t' configure yer color variants. See below.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto t' become an auto mode variant. That’s it.\nYe can use th' auto value wit' th' single or multiple variants opt'n. If ye be us'n multiple variants, ye can drop auto at any posit'n 'n th' option’s array, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\nhugo. toml yaml json [params] themeVariant = ['auto', 'red'] params: themeVariant: - auto - red { \"params\": { \"themeVariant\": [ \"auto\", \"red\" ] } } If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant opt'n if present.\nIn th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.\nIf ye don’t like that behavior, ye can explicitly set themeVariantAuto. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode.\nhugo. toml yaml json [params] themeVariantAuto = ['learn', 'neon'] params: themeVariantAuto: - learn - neon { \"params\": { \"themeVariantAuto\": [ \"learn\", \"neon\" ] } } Change th' Favicon If yer favicon be a SVG, PNG or ICO, just drop yer image 'n yer site’s static/images/ directory an' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf ye want t' adjust yer favicon accord'n t' yer OS sett'ns fer light/dark mode, add th' image files static/images/favicon-light.svg an' static/images/favicon-dark.svg t' yer site’s directory, respectively, correspond'n t' yer file format. In case some o' th' files be miss'n, th' theme falls back t' favicon.svg fer each miss'n file. All supplied favicons must be o' th' same file format.\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 layouts/partials/favicon.html 'n yer site’s directory an' write someth'n like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' Logo Create a new file 'n layouts/partials/logo.html o' yer ship. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically.\nRules Highlight'n If ye want t' switch th' rules highlight'n theme together wit' yer color variant, ye need t' configure yer installat'n accord'n t' Hugo’s documentat'n an' provide a rules highlight'n stylesheet file.\nYe can use a one o' th' shipped stylesheet files or use Cap'n Hugo t' generate a file fer ye. Th' file must be written t' assets/css/chroma-\u003cNAME\u003e.css. T' use it wit' yer color variant ye have t' define --CODE-theme: \u003cNAME\u003e 'n th' color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css an' hugo.toml o' th' exampleSite.\nChange th' Variant (Advanced) Th' theme offers a new way t' configure theme variants an' all o' th' aspects above inside o' a single configurat'n item. This comes wit' some features previously unsupported.\nLike wit' th' multiple variants opt'n, ye be defin'n yer theme variants 'n an array but now not by simple str'ns but 'n a t'ble wit' subopt'ns.\nAgain, 'n this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\nhugo. toml yaml json [params] themeVariant = ['relearn-light', 'relearn-dark'] params: themeVariant: - relearn-light - relearn-dark { \"params\": { \"themeVariant\": [ \"relearn-light\", \"relearn-dark\" ] } } ye now write it that way:\nhugo. toml yaml json [params] [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' params: themeVariant: - identifier: relearn-light - identifier: relearn-dark { \"params\": { \"themeVariant\": [ { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" } ] } } Th' identifier opt'n be mandatory an' equivalent t' th' str'n 'n th' first example. Further opt'ns can be configured, see th' t'ble below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond t' th' name o' a color variant either 'n yer site’s or th' theme’s directory 'n th' form assets/css/theme-\u003cIDENTIFIER\u003e.css. name see notes Th' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form. auto \u003cempty\u003e If set, th' variant be treated as an auto mode variant. It has th' same behavior as th' themeVariantAuto opt'n. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode. Defin'n auto mode variants wit' th' advanced opt'ns has th' benefit that ye can now have multiple auto mode variants instead o' just one wit' th' simple opt'ns. Example Configurat'n o' This Ship hugo. toml yaml json [params] [[params.themeVariant]] auto = [] identifier = 'relearn-auto' name = 'Relearn Light/Dark' [[params.themeVariant]] identifier = 'relearn-light' [[params.themeVariant]] identifier = 'relearn-dark' [[params.themeVariant]] auto = ['zen-light', 'zen-dark'] identifier = 'zen-auto' name = 'Zen Light/Dark' [[params.themeVariant]] identifier = 'zen-light' [[params.themeVariant]] identifier = 'zen-dark' [[params.themeVariant]] identifier = 'neon' params: themeVariant: - auto: [] identifier: relearn-auto name: Relearrrn Light/Dark - identifier: relearn-light - identifier: relearn-dark - auto: - zen-light - zen-dark identifier: zen-auto name: Zen Light/Dark - identifier: zen-light - identifier: zen-dark - identifier: neon { \"params\": { \"themeVariant\": [ { \"auto\": [], \"identifier\": \"relearn-auto\", \"name\": \"Relearn Light/Dark\" }, { \"identifier\": \"relearn-light\" }, { \"identifier\": \"relearn-dark\" }, { \"auto\": [ \"zen-light\", \"zen-dark\" ], \"identifier\": \"zen-auto\", \"name\": \"Zen Light/Dark\" }, { \"identifier\": \"zen-light\" }, { \"identifier\": \"zen-dark\" }, { \"identifier\": \"neon\" } ] } } Modify Shipped Variants In case ye like a shipped variant but only want t' tweak some aspects, ye have two choices:\nCopy an' change\nYe can copy th' shipped variant file from th' theme’s assets/css directory t' th' site’s assets/css directory an' either store it wit' th' same name or give it a new name. Edit th' sett'ns an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' chosen name.\nCreate an' import\nYe can create a new variant file 'n th' site’s assets/css directory an' give it a new name. Import th' shipped variant, add th' sett'ns ye want t' change an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' chosen name.\nFor example, ye want t' use th' relearn-light variant but want t' change th' rules highlight'n schema t' th' one used 'n th' neon variant. For that, create a new assets/css/theme-my-brand'n.css 'n yer site’s directory an' add th' follow'n lines:\n​ assets/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: neon; /* name o' th' chroma stylesheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color fer code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color fer code background */ } Afterwards put this 'n yer hugo.toml t' use yer new variant:\nhugo. toml yaml json [params] themeVariant = 'my-branding' params: themeVariant: my-brand'n { \"params\": { \"themeVariant\": \"my-branding\" } } In comparison t' copy an' change, this has th' advantage that ye profit from any adjustments t' th' relearn-light variant but keep yer modificat'ns.", + "description": "Th' Relearrrn theme provides configurat'n opt'ns t' change yer site’s colors, favicon an' logo.", + "tags": [], "title": "Brrrand'n", "uri": "/hugo-theme-relearn/pir/basics/branding/index.html" }, @@ -177,15 +179,15 @@ var relearn_search_index = [ "breadcrumb": "Basics", "content": "Usage scenarios Th' theme be us'ble 'n different scenarios, requir'n th' follow'n mandatory sett'ns 'n yer hugo.toml. All sett'ns not mentioned can be set t' yer lik'n.\nPublic Web Server from Root hugo. toml yaml json baseURL = 'https://example.com/' baseURL: https://example.com/ { \"baseURL\": \"https://example.com/\" } Public Web Server from Subdirectory hugo. toml yaml json baseURL = 'https://example.com/mysite/' relativeURLs = false baseURL: https://example.com/mysite/ relativeURLs: false { \"baseURL\": \"https://example.com/mysite/\", \"relativeURLs\": false } Private Web Server (LAN) Th' same sett'ns as wit' any o' th' public web server usage scenarios or\nhugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } File System hugo. toml yaml json baseURL = '/' relativeURLs = true baseURL: / relativeURLs: true { \"baseURL\": \"/\", \"relativeURLs\": true } Arrr Us'n a baseURL wit' a subdirectory an' relativeURLs=true be mutually exclusive due t' th' fact, that Cap'n Hugo does not apply th' baseURL correctly.\nIf ye need both, ye have t' generate yer ship twice but wit' different sett'ns into separate directories.\nAvast Sublemental planks (like sitemap.xml, rss.xml) an' generated social media links inside o' yer planks will always be generated wit' absolute URLs an' will not work if ye set relativeURLs=true.\nAhoi If ye be us'n uglyURLs=false (Hugo’s default), th' theme will append an additional index.html t' all plank links t' make yer ship be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a web server ye can generate th' links without this:\nhugo. toml yaml json [params] disableExplicitIndexURLs = true params: disableExplicitIndexURLs: true { \"params\": { \"disableExplicitIndexURLs\": true } } Activate search If not already present, add th' follow'n lines 'n yer hugo.toml file.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search'] outputs: home: - html - rss - search { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\" ] } } This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library.\nActivate dedicated search plank Ye can add a dedicated search plank fer yer plank by add'n th' searchpage outputformat t' yer home plank by add'n th' follow'n lines 'n yer hugo.toml file. This will cause Cap'n Hugo t' generate a new file http://example.com/mysite/search.html.\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'search', 'searchpage'] outputs: home: - html - rss - search - searchpage { \"outputs\": { \"home\": [ \"html\", \"rss\", \"search\", \"searchpage\" ] } } Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n ENTER inside o' th' menu’s search box .\nAvast T' have Cap'n Hugo create th' dedicated search plank successfully, ye must not generate th' URL http://example.com/mysite/search.html from yer own rrrambl'n. This can happen if ye set uglyURLs=true 'n yer hugo.toml an' defin'n a Marrrkdown file content/search.md.\nT' make sure, there be no duplicate rrrambl'n fer any given URL o' yer project, run hugo --printPathWarn'ns.\nActivate print support Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' print output format t' yer home, section an' plank 'n yer hugo.toml as seen below:\nhugo. toml yaml json [outputs] home = ['html', 'rss', 'print', 'search'] plank = ['html', 'rss', 'print'] section = ['html', 'rss', 'print'] outputs: home: - html - rss - print - search plank: - html - rss - print section: - html - rss - print { \"outputs\": { \"home\": [ \"html\", \"rss\", \"print\", \"search\" ], \"page\": [ \"html\", \"rss\", \"print\" ], \"section\": [ \"html\", \"rss\", \"print\" ] } } This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set uglyURLs=true 'n yer hugo.toml. This be due t' th' fact that fer one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine outputFormats.print 'n yer own hugo.toml t' yer lik'n.\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 th' landingPageName fer th' defined languages:\nhugo. toml yaml json [languages] [languages.en] [languages.en.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" [languages.pir] [languages.pir.params] landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" languages: en: params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home pir: params: landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Arrr! Homme { \"languages\": { \"en\": { \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" } }, \"pir\": { \"params\": { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Arrr! Homme\" } } } } If this opt'n be not configured fer a specific language, they will get their default values:\n​ toml yaml json landingPageName = \"\u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home\" landingPageName: \u003ci class='fa-fw fas fa-home'\u003e\u003c/i\u003e Home { \"landingPageName\": \"\\u003ci class='fa-fw fas fa-home'\\u003e\\u003c/i\\u003e Home\" } Th' home button be go'n t' look like this:\nSocial Media Meta Tags Ye can add social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. These be configured as mentioned 'n th' Cap'n Hugo docs.\nChange th' Menu Width Th' menu width adjusts automatically fer different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 14.375rem M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem Th' values fer th' screen width breakpoints aren’t configur'ble.\nIf ye want t' adjust th' menu width ye can define th' follow'n CSS variables 'n yer custom-header.html. Avast that --MENU-WIDTH-S applies t' th' menu flyout width 'n mobile mode fer small screen sizes.\n:root { --MENU-WIDTH-S: 14.375rem; --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Change th' Main Area’s Max Width By default th' main area width will only grow t' a certain extent if more vertical screen space be avail'ble. This be done fer readability purposes as long line be usually harder t' read.\nIf ye be unhappy wit' th' default, ye can define th' follow'n CSS vari'ble 'n yer custom-header.html an' set th' value t' yer lik'n. If ye want t' use all avail'ble space, select a really big value like 1000rem;\n:root { --MAIN-WIDTH-MAX: 80.25rem; }Own Shorrrtcodes wit' JavaScript Dependencies Certain shorrrtcodes make use o' additional dependencies like JavaScript an' CSS files. Th' theme only loads these dependencies if th' shortcode be used. T' do so correctly th' theme adds management code 'n various files.\nYe can ye use this mechanism 'n yer own shorrrtcodes. Say ye want t' add a shortcode myshortcode that also requires th' jquery JavaScript library.\nWrite th' shortcode file layouts/shortcodes/myshortcode.html an' add th' follow'n line\n​ layouts/shortcodes/myshortcode.html {{- .Plank.Store.Set \"hasMyShortcode\" true }} Add th' follow'n snippet t' yer hugo.toml\nhugo. toml yaml json [params] [params.relearn] [params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = 'MyShortcode' params: relearn: dependencies: myshortcode: name: MyShortcode { \"params\": { \"relearn\": { \"dependencies\": { \"myshortcode\": { \"name\": \"MyShortcode\" } } } } } Add th' dependency loader file layouts/partials/dependencies/myshortcode.html. Th' loader file will be called from multiple locat'ns inside o' th' theme wit' th' parameter plank contain'n th' current plank vari'ble an' locat'n wit' one o' th' currently defined locat'ns\nheader: if called at th' end o' th' HTML head element footer: if called at th' end o' th' HTML body element ​ layouts/partials/dependencies/myshortcode.html {{- if eq .locat'n \"footer\" }} \u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e {{- end }} Character cas'n be relevant!\nth' name sett'n 'n yer hugo.toml must match th' key (that needs t' be prefixed wit' a has) ye used fer th' store 'n yer layouts/shortcodes/myshortcode.html. th' key on params.relearn.dependencies 'n yer hugo.toml must match th' base file name o' yer loader file. See th' math, mermaid an' openapi shorrrtcodes fer examples.\nAvast If ye be really into customizat'n o' th' theme an' want t' use th' dependency loader fer yer own locat'ns, ye can do this by simply call'n it from inside o' yer overriden partials\n{{- partial \"dependencies.html\" (dict \"page\" . \"location\" \"mylocation\") }} Output Formats Certain parts o' th' theme can be changed fer support o' yer own output formats. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/header.plaintext.html t' change th' way, th' plank header should look like fer that output format.\nReact t' Variant Switches 'n JavaScript Once a color variant be fully boarded, either initially or by switch'n th' color variant manually wit' th' variant selector, th' custom event themeVariantLoaded on th' document will be dispatched. Ye can add an event listener an' react t' changes.\ndocument.addEventListener( 'themeVariantLoaded', funct'n( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials 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 :\nheader.html: th' header o' th' plank. See output-formats footer.html: th' footer o' th' plank. See output-formats body.html: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats article.html: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’t forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon head'n.html: side-wide configurat'n t' change th' planks title head'ns. heading-pre.html: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPre sett'n into account. heading-post.html: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPost sett'n into account. logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPost sett'n into account. menu-footer.html: footer o' th' left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye want t' display page’s meta data above or below th' rrrambl'n. content-header.html: header above th' title, has a default implementat'n but ye can overwrite it if ye don’t like it. content-footer.html: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it. ", "description": "Usage scenarios Th' theme be us'ble 'n different scenarios, requir'n th' follow'n mandatory sett'ns 'n yer hugo.", - "tags": null, + "tags": [], "title": "Customizat'n", "uri": "/hugo-theme-relearn/pir/basics/customization/index.html" }, { "breadcrumb": "Basics", - "content": "This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflect how colors be inherited through different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s assets/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer hugo.toml t' yer chosen file name.\nEg. if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nSee th' docs fer further configurat'n opt'ns\nDownload variant Reset variant\nGraph Download variant Reset variant\n", + "content": "This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflect how colors be inherited through different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s assets/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer hugo.toml t' yer chosen file name.\nEg. if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nSee th' docs fer further configurat'n opt'ns\nDownload variant Reset variant\nGraph Download variant Reset variant", "description": "This interactive tool may help ye t' generate yer own color variant stylesheet.", - "tags": null, + "tags": [], "title": "Stylesheet generrrat'r", "uri": "/hugo-theme-relearn/pir/basics/generator/index.html" }, @@ -193,15 +195,15 @@ var relearn_search_index = [ "breadcrumb": "Basics", "content": "Th' theme comes wit' a reasonably configured topbar.\nNevertheless, yer requirements may differ from this configurat'n. Luckily th' theme got ye covered as th' themebar, its buttons an' th' functionality behind these buttons be fully configur'ble by ye.\nSmarrrt Arrrse All mentioned file names below can be clicked an' show ye th' implementat'n fer a better understand'n.\nAreas Th' default configurat'n comes wit' three predefined areas that may contain an arbitrary set o' buttons.\nstart: shown between menu an' breadcrumb end: shown on th' opposite breadcrumb side 'n comparison t' th' start area more: shown when press'n th' more button 'n th' topbar While ye can not add additional areas 'n th' topbar, ye be free t' configure additional buttons that behave like th' more button, provid'n further user defined areas.\nButtons Th' theme ships wit' th' follow'n predefined buttons (from left t' right 'n th' screenshot)\nsidebar: opens th' sidebar flyout if 'n mobile layout toc: opens th' t'ble o' contents 'n an overlay edit: browses t' th' edit'ble plank if th' editURL parameter be set print: browses t' th' chapters print'ble plank if print support was activated prev: browses t' th' previous plank if there be one next: browses t' th' next plank if there be one more: opens th' overlay fer th' more area Not all buttons be displayed at every given time. This be configur'ble (see below if interested).\nRedefin'n Areas Each predefined area an' button comes 'n their own file. By that it be easy fer ye t' overwrite an area file 'n yer installat'n reus'n only th' buttons ye like.\nEg. ye can redefine th' predefined end area by add'n th' file layouts/partials/topbar/area/end.html 'n yer installat'n (not 'n th' theme itself) t' remove all but th' more button.\nTh' below example sets an explicit value fer th' onempty parameter, overrid'n th' specific default value fer this button (these defaults vary depend'n on th' button). Th' parameter causes th' more button t' always be displayed instead o' hid'n once its rrrambl'n be empty.\n{{ partial \"topbar/button/more.html\" (dict \"page\" . \"onempty\" \"disable\" )}}Defin'n own Buttons Button Types Th' theme distinguishes between two types o' buttons:\nbutton: a click'ble button that either browses t' another ship, triggers a user defined script or opens an overlay contain'n user defined rrrambl'n area-button: th' template fer th' more button, t' define yer own area overlay buttons Button Parameter Screen Widths an' Act'ns Depend'n on th' screen width ye can configure how th' button should behave. Screen width be divided into three classes:\ns: (controlled by th' onwidths parameter) mobile layout whar' th' menu sidebar be hidden m: (controlled by th' onwidthm parameter) desktop layout wit' vis'ble sidebar while th' rrrambl'n area width still resizes l: (controlled by th' onwidthl parameter) desktop layout wit' vis'ble sidebar once th' rrrambl'n area reached its maximum width For each width class, ye can configure one o' th' follow'n act'ns:\nshow: th' button be displayed 'n its given area hide: th' button be removed area-XXX: th' button be moved from its given area into th' area XXX; eg. this be used t' move buttons t' th' more area overlay 'n th' mobile layout Hid'n an' Disabl'n Stuff While hid'n a button depend'n on th' screen size can be configured wit' th' above described hide act'n, ye may want t' hide th' button on certain other condit'ns as well.\nFor example, th' print button 'n its default configurat'n should only be displayed if print support was configured. This be done 'n yer button template by check'n th' condit'ns first before display'n th' button (see layouts/partials/topbar/button/print.html).\nAnother preferred condit'n fer hid'n a button be, if th' displayed overlay be empty. This be th' case fer th' toc (see layouts/partials/topbar/button/toc.html) as well as th' more button (see layouts/partials/topbar/button/more.html) an' controlled by th' parameter onempty.\nThis parameter can have one o' th' follow'n values:\ndis'ble: th' button displayed 'n disabled state if th' overlay be empty hide: th' button be removed if th' overlay be empty If ye want t' dis'ble a button contain'n no overlay, this can be achieved by an empty href parameter. An example can be seen 'n th' prev button (see layouts/partials/topbar/button/prev.html) whar' th' URL fer th' previous ship may be empty.\nReference Button Contains th' basic button functionality an' be used as a base implementat'n fer all other buttons (layouts/partials/topbar/func/button.html).\nCall this from yer own button templates if ye want t' implement a button without an overlay like th' print button (layouts/partials/topbar/button/print.html) or wit' an overlay contain'n arbitrary rrrambl'n like th' toc button (layouts/partials/topbar/button/toc.html).\nFor display'n an area 'n th' button’s overlay, see Area-Button.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. class \u003cempty\u003e Mandatory unique class name fer this button. Display'n two buttons wit' th' same value fer class be undefined. href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL\n- if empty th' button will be displayed 'n disabled state regardless o' its rrrambl'n ay'con \u003cempty\u003e Font Awesome ay'con name. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n parameter was set but ends up empty:\n- dis'ble: Th' button be displayed 'n disabled state.\n- hide: Th' button be removed. onwidths show Th' act'n, that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed 'n th' tooltip. title \u003cempty\u003e Arbitrary text fer th' button. rrrambl'n \u003cempty\u003e Arbitrary HTML t' put into th' rrrambl'n overlay. This parameter may be empty. In this case no overlay will be generated. Area-Button Contains th' basic functionality t' display area overlay buttons (layouts/partials/topbar/func/area-button.html).\nCall this from yer own button templates if ye want t' implement a button wit' an area overlay like th' more button (layouts/partials/topbar/button/more.html).\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. area \u003cempty\u003e Mandatory unique area name fer this area. Display'n two areas wit' th' same value fer area be undefined. ay'con \u003cempty\u003e Font Awesome ay'con name. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:\n- dis'ble: Th' button be displayed 'n disabled state.\n- hide: Th' button be removed. onwidths show Th' act'n, that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm show See above. onwidthl show See above. hint \u003cempty\u003e Arbitrary text displayed 'n th' tooltip. title \u003cempty\u003e Arbitrary text fer th' button. Predefined Buttons Th' predefined buttons by th' theme (all other buttons besides th' more an' toc button 'n layouts/partials/topbar/button).\nCall these from yer own redefined area templates if ye want t' use default button behavior.\nTh' \u003cvarying\u003e parameter values be different fer each button an' configured fer standard behavior as seen on this plank.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. onwidths \u003cvarying\u003e Th' act'n, that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. Predefined Overlay-Buttons Th' predefined buttons by th' theme that open an overlay (the more an' toc button 'n layouts/partials/topbar/button).\nCall these from yer own redefined area templates if ye want t' use default button behavior utiliz'n overlay functionality.\nTh' \u003cvarying\u003e parameter values be different fer each button an' configured fer standard behavior as seen on this plank.\nParameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. onempty dis'ble Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:\n- dis'ble: Th' button be displayed 'n disabled state.\n- hide: Th' button be removed. onwidths \u003cvarying\u003e Th' act'n, that should be executed if th' ship be displayed 'n th' given width:\n- show: Th' button be displayed 'n its given area\n- hide: Th' button be removed.\n- area-XXX: Th' button be moved from its given area into th' area XXX. onwidthm \u003cvarying\u003e See above. onwidthl \u003cvarying\u003e See above. ", "description": "Th' theme comes wit' a reasonably configured topbar.\nNevertheless, yer requirements may differ from this configurat'n.", - "tags": null, + "tags": [], "title": "Topbarrr Modificat'n", "uri": "/hugo-theme-relearn/pir/basics/topbar/index.html" }, { "breadcrumb": "Basics", "content": " Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo’s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use .LinkTitle instead o' .Title if avail'ble #816 Fixes [bug] scrollbar: scroll bar 'n side menu gets stuck 'n dragged state on mobile #808 5.26.2 (2024-03-18) Enhancements [feature] ay'cons: use fixed width t' ease layout #812 Fixes [bug] search: broken since version 5.26.1 #813 [bug] search: fix result links fer planks 'n root #810 5.26.1 (2024-03-17) Fixes [bug] mermaid: show reset button after pan #807 [bug] openapi: make it run fer file:// protocol #806 [bug] theme: fix relative path detect'n if relativeURLs=false #804 5.26.0 (2024-03-16) Enhancements [feature] image: add lazy load'n image effect opt'n #803 [feature] render-hook: support Marrrkdown attributes #795 [feature] theme: support full plank width #752 Fixes [bug] clipboard: fix broken style if block code be 'n t'ble #790 [bug] nav: browser back navigat'n does not jump t' th' correct posit'n #509 Maintenance [task] build: update all avail'ble act'ns t' nodejs 20 #802 [task] openapi: update swagger-ui t' 5.11.10 #798 [task] mermaid: update t' 10.9.0 #797 5.25.0 (2024-02-29) Enhancements [feature][change] theme: print out GitInfo 'n plank footer if configured #786 [feature][change] resources: new shortcode t' deprecate attachments shortcode #22 Fixes [bug] swagger: fix compat warning #787 5.24.3 (2024-02-28) Fixes [bug] theme: avoid crash on 404 if author sett'ns want t' warn #785 5.24.2 (2024-02-24) Enhancements [feature] image: adjust t' Cap'n Hugo 0.123 #777 Fixes [bug] link: resolve fragments #775 5.24.1 (2024-02-18) Enhancements [feature] link: make resolut'n report'n configur'ble #774 5.24.0 (2024-02-17) Enhancements [feature] theme: compatibility wit' Cap'n Hugo 0.123 #771 [feature] topbar: support editURL 'n frontmatter #764 [feature] menu: use –MENU-WIDTH-S t' adjust mobile flyout #761 [feature] figure: support built-in shortcode #746 [feature] theme: make head'n a template #744 [feature] taxonomy: make arrow nav browse through terms #742 [feature] theme: switch from config.toml t' hugo.toml #741 [feature] button: make non-interactive if used as mock #740 [feature][change] topbar: allow text fer button #739 [feature] theme: run hugo demo ship without warning #736 [feature] menu: make swipe handler passive #735 [feature] i18n: support standard Cap'n Hugo opt'ns #733 [feature] a11y: show tab focus on images #730 [feature] a11y: improve discover'n links on keyboard navigat'n #726 [feature][change] variant: increase contrast fer light themes #722 [feature] theme: break build if minimum Cap'n Hugo version be not matched #719 [feature] taxonomy: hum'nize term on miss'n term title #713 Fixes [bug] taxonomy: display translated title #772 [bug] highlight: fix codefence rules 'n Hugo \u003e= 0.121.0 #749 [bug] link: fix links t' planks contain'n dots 'n their name #748 [bug] image: get resource images if link be prefixed wit' ./ #747 [bug] theme: switch dependency colors on OS color scheme change #745 [bug] clipboard: fix O(n²) buttons #738 [bug] button: fix whitespac'n 'n FF #737 [bug] i18n: fix warning messages fer zh-CN #732 [bug] mermaid: fix zoom button #725 [bug] theme: fix JS errors on hugo --minifiy #724 [bug] include: fix whitespac'n 'n codefences #723 5.23.2 (2023-11-03) Enhancements [feature] taxonomy: improve taxonomy plank #712 [feature] taxonomy: warn on miss'n term title #709 Fixes [bug] taxonomy: fix sort'n o' terms on rrrambl'n planks #710 5.23.1 (2023-10-30) Enhancements [feature] taxonomy: improve term plank #705 Fixes [bug] variant: fix typo 'n chroma-learn.css #708 [bug] links: ignore local markdown links link'n t' files wit' extension #707 5.23.0 (2023-10-29) Enhancements [feature] taxonomy: allow fer rrrambl'n on term planks #701 [feature] theme: write full file path on warnings #699 [feature] theme: show anchor link an' copy t' clipboard button on mobile #697 [feature][change] config: adjust t' changes 'n Hugo 0.120 #693 [feature] variants: add more contrast t' neon #692 [feature] mermaid: only show zoom reset button if zoomed #691 [feature] menu: add additional sort opt'ns #684 [feature] theme: add social media meta informat'n #683 [feature] theme: simplify additional JS dependencies #682 [feature] links: warn if ref/relref be used falsly #681 [feature] menu: make width configur'ble #677 [feature] tabs: use color fer link o' inactive tabs #675 [feature] taxonomy: modularize term list generat'n #671 [feature] theme: remove warnings wit' hugo --printI18nWarn'ns #670 [feature] theme: implement port'ble link'n #377 Fixes [bug] links: extra space before link text #700 [bug] mermaid: reset zoom correctly #690 [bug] theme: fix mobile layout fer width=48rem #676 [bug] frontmatter: resemble documented shortcode style #672 [bug] taxonomy: display terms 'n planks if removePathAccents=true #669 Maintenance [task] mermaid: update mermaid t' 10.6.0 #703 [task] openapi: update swagger-ui t' 5.9.1 #702 5.22.1 (2023-10-02) Enhancements [feature] i18n: add Swahili translat'n #666 [feature] math: hide unrendered math #663 [feature] tabs: improve a11y by remov'n duplicate hidden title #662 [feature] mermaid: improve zoom UX #659 Fixes [bug] variant: fix sidebar-flyout borders color fer zen #667 [bug] clipboard: fix RTL locat'n o' tooltip #661 [bug] clipboard: ignore RTL fer code #660 [bug] expand: fix aria-controls #658 [bug] theme: fix id generat'n fer markdownified titles #657 [bug] mermaid: avoid graph bomb'n on hugo –minify #656 [bug] mermaid: fix width fer some graphs #655 5.22.0 (2023-09-26) Enhancements [feature] mermaid: add pan\u0026zoom reset #651 [feature] markdown: add interlace color fer tables #648 [feature] search: add breadcrumb t' dedicated search results #647 [feature][change] menu: optionally dis'ble index planks fer sections #642 Fixes [bug] variants: restore generator zoom #650 [bug] clipboard: malused Fontawesome style #649 [bug][change] theme: avoid id collisions between head'ns an' theme #646 [bug] theme: remove HTML validat'n errors #644 [bug] breadcrumb: remove superflous whitespace between items #643 5.21.0 (2023-09-18) Enhancements [feature] topbar: make buttons configur'ble #639 [feature][change] menu: fix footer padd'n #637 Fixes [bug] breadcrumb: don’t ignore spaces fer separator #636 [bug] theme: fix snyk code issues #633 [bug] images: apply image effects t' lightbox images #631 Maintenance [task] openapi: update t' swagger 5.7.2 #641 5.20.0 (2023-08-26) Enhancements [feature][change] theme: support fer colored borders between menu an' rrrambl'n #626 [feature] image: allow opt'n t' apply image effects globally #623 [feature][change] openapi: switch t' light syntaxhighlightn'n whar' applic'ble #621 [feature] images: document usage o' images wit' links #576 Fixes [bug] highlight: fix render'n fer Cap'n Hugo \u003c 0.111 #630 [bug] search: remove link underline on dedicated search plank #627 [bug] highlight: don’t switch t' block view if hl_inline=true #618 [bug] variant: minor adjustments t' zen variants #617 [bug] mermaid: lazy render graph if it be initially hidden #187 Maintenance [task] openapi: update t' swagger 5.4.1 #620 5.19.0 (2023-08-12) Enhancements [feature] highlight: add title parameter #616 [feature] variant: signal variant switch as event #614 [feature] variant: add zen variant 'n light an' dark #613 [feature] i18n: add Hungarian translat'n #604 [feature] mermaid: update t' 10.3.0 #601 Fixes [bug] siteparam: avoid halt if param be a map/slice #611 [bug] mermaid: fix broken zoom since update t' v10 #608 [bug] mermaid: variant generator diagram does not respond t' events #607 [bug] print: avoid chroma leak fer relearn-dark #605 Maintenance [task] mermaid: update t' 10.3.1 #610 5.18.0 (2023-07-27) Enhancements [feature][change] shorrrtcodes: add more deprecat'n warnings #598 [feature][change] shorrrtcodes: change context parameter t' plank if called as partial #595 [feature] siteparam: support nested parameters an' text formatt'n #590 [feature][change] a11y: improve when tabb'n through links #581 Fixes [bug] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n #600 [bug] 404: fix display 'n RTL #597 [bug] highlight: fix posit'n o' copy-to-clipboard button 'n RTL #594 [bug] openapi: fix spell'n #593 [bug] search: fix typo 'n output format #591 [bug] tabs: fix tab select'n by groupid #582 [bug] theme: restore compat wit' Cap'n Hugo 0.95.0 #580 [bug][change] theme: improve display o' links #577 5.17.1 (2023-06-22) Enhancements [feature][change] highlight: make copy t' clipboard appear on hover #574 5.17.0 (2023-06-22) Enhancements [feature] highlight: add configur'ble line breaks #169 Fixes [bug] theme: support Cap'n Hugo 0.114.0 #573 [bug] taxonomy: fix number tags #570 [bug] highlight: improve copy t' clipboard #569 5.16.2 (2023-06-10) Enhancements [feature] theme: revamp 404 plank #566 5.16.1 (2023-06-09) Enhancements [feature] theme: add deprecat'n warnings #565 Fixes [bug] mermaid: allow fer YAML frontmatter inside o' graph #564 [bug] alias: fix redirect URLs 'n case o' empty BaseURL #562 5.16.0 (2023-06-08) Enhancements [feature] tabs: add title an' ay'con opt'n #552 [feature] shorrrtcodes: add style opt'n t' mimic code box color scheme #551 [feature] tabs: support color opt'ns #550 [feature] favicon: add light \u0026 dark opt'n fer OS’s preferred color scheme #549 Fixes [bug] ay'con: remove whitespace on start #560 [bug] shorrrtcodes: avoid superflous margin at start an' end o' rrrambl'n #558 [bug] expand: fix html encod'n o' finish'n rrrambl'n tag #557 [bug] ay'con: fix ouput “raw HTML omitted” wit' goldmark config unsafe=false #555 5.15.2 (2023-05-29) Enhancements [feature] taxonomy: add support fer category default taxonomy #541 Fixes [bug] attachments: work fer Cap'n Hugo \u003c 0.112 #546 5.15.1 (2023-05-25) Fixes [bug] shorrrtcodes: intermediately use random ids instead o' .Ordinal #543 5.15.0 (2023-05-25) Enhancements [feature] tab: new shortcode t' display single tab #538 [feature][change] tabs: treat groupid as unique if not set #537 [feature] expand: indent expanded rrrambl'n #536 [feature] notice: make boxes more prominent #535 Fixes [bug] attachments: fix build error since Cap'n Hugo 0.112 #540 Maintenance [task] chore: update Merrrmaid t' 9.4.3 #534 [task] mermaid: update t' 10.2.0 #499 5.14.3 (2023-05-20) Fixes [bug] tags: show taxonomy toc fer standard installat'n #533 5.14.2 (2023-05-20) Fixes [bug] tags: translate breadcrumb an' title fer taxonomy #532 5.14.1 (2023-05-20) No changelog fer this release.\n5.14.0 (2023-05-19) Enhancements [feature] tags: improve search index fer tags #531 [feature] tags: increase readability o' taxonomy planks #530 [feature] nav: make breadcrumb separator configur'ble #529 [feature] i18n: add translat'n fer default taxonomies #528 [feature] theme: set appropriate defaults fer all theme specific params #516 [feature] theme: allow t' display tags below article #513 Fixes [bug] shortcode: make .context always a plank #527 5.13.2 (2023-05-17) Fixes [bug] print: en'ble print fer planks wit' _build opt'ns #522 5.13.1 (2023-05-16) Fixes [bug] openapi: allow toc t' scroll plank #526 5.13.0 (2023-05-14) Enhancements [feature][change] openapi: replace implementat'n wit' swagger-ui #523 Fixes [bug] variant: avoid leak'n shadows 'n neon print style #524 5.12.6 (2023-05-04) Enhancements [feature] theme: better HTML titles an' breadcrumbs fer search an' tag planks #521 Fixes [bug] menu: avoid hid'n o' expander on hover when active item has children #520 [bug] menu: showVisitedLinks not work'n fer some theme variants #518 [bug] theme: fix resource URLs fer 404 plank on subdirectories #515 5.12.5 (2023-03-28) Fixes [bug] expand: not properly exanded when used 'n bullet point list #508 5.12.4 (2023-03-24) Fixes [bug] theme: disableExplicitIndexURLs param be not work'n as expected #505 5.12.3 (2023-03-14) Fixes [bug] attachments: fix links if only one language be present #503 [bug] shorrrtcodes: allow markdown fer title an' rrrambl'n #502 5.12.2 (2023-03-03) Fixes [bug] menu: fix state fer alwaysopen=false + collapsibleMenu=false #498 5.12.1 (2023-02-26) Enhancements [feature] variant: add relearn bright theme #493 Fixes [bug] generator: fix sett'n o' colors #494 5.12.0 (2023-02-24) Enhancements [feature] frontmatter: support VSCode Front Matter extension #481 [feature] theme: make expand an' image ids st'ble #477 [feature] variant: set scrollbar color t' dark fer dark variants #471 [feature] i18n: add full RTL support #470 [feature] piratify: fix some quirks, arrr #469 [feature][change] theme: optimizat'n fer huge screen sizes #466 Fixes [bug] i18n: write code ltr even fer rtl languages #492 [bug] anchor: fix link 'n FF when served from file system #482 [bug] shorrrtcodes: don’t break build an' render fer invalid parameters #480 [bug] nav: restore scroll posit'n on browser back #476 [bug] variant: avoid style leak fer auto style #473 Maintenance [task] build: add imagebot #485 5.11.2 (2023-02-07) Fixes [bug] tabs: nested tabs rrrambl'n be not displayed #468 5.11.1 (2023-02-06) Fixes [bug] variant: include miss'n theme-auto.css 'n distribut'n #467 5.11.0 (2023-02-05) Enhancements [feature] i18n: add Czech translat'n #455 [feature][change] lightbox: switch t' CSS-only solut'n #451 [feature][change] variant: add support fer prefers-color-scheme #445 [feature][change] expand: refactor fer a11y #339 [feature][change] mermaid: make zoom configur'ble #144 Fixes [bug] swagger: avoid errors when us'n invalid rapi-doc fragment ids #465 [bug] search: fix oddities 'n keyboard handl'n #463 [bug] badge: fix text color fer IE11 #462 [bug] mermaid: rerender graph if search term be present an' variant be switched #460 [bug] tags: show tag on planks when tag has space #459 [bug] edit: remove do'ble slash on root plank link #450 Maintenance [task] build: add mov'n version tags #453 [task][change] theme: remove jQuery #452 [task] build: check fer release notes before release #448 5.10.2 (2023-01-25) Fixes [bug] nav: fix breadcrumb fer huge installat'ns #446 5.10.1 (2023-01-25) Fixes [bug] print: fix image links wit' relative path #444 5.10.0 (2023-01-25) Enhancements [feature] shorrrtcodes: support fer accent color #440 [feature] shorrrtcodes: add color parameter whar' applic'ble #438 [feature] theme: announce translat'ns as alternate links #422 Fixes [bug] nav: fix breadcrumbs fer deeply nested sections #442 [bug] theme: improve whitespac'n 'n tables #441 5.9.4 (2023-01-23) Fixes [bug] variant: fix search ay'con an' text color #437 5.9.3 (2023-01-22) Fixes [bug] nav: fix left/right navigat'n fer horizontal scroll'n #435 [bug][break'n] theme: allow planks on top level #434 Maintenance [task] build: switch t' wildcard version o' act'ns #428 5.9.2 (2022-12-30) Fixes [bug] search: apply dependency scripts fer Hindi an' Japanese #427 5.9.1 (2022-12-23) Enhancements [feature] theme: make external link target configur'ble #426 5.9.0 (2022-12-23) Enhancements [feature][change] theme: open external links 'n separate tab #419 [feature] theme: make it a Cap'n Hugo module #417 Fixes [bug][change] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true #425 5.8.1 (2022-12-11) Fixes [bug] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true #414 5.8.0 (2022-12-08) Enhancements [feature] ay'con: add new shortcode #412 [feature] theme: style an' document markdown extensions #411 [feature] badge: add new shortcode #410 [feature] theme: add accent color #409 Fixes [bug] theme: fix spac'n fer tag flyout 'n FF #413 5.7.0 (2022-11-29) Enhancements [feature] button: refactor fer a11y #372 Fixes [bug] search: don’t freeze browser on long search terms #408 [bug] search: fix searchbox placeholder color 'n FF an' IE #405 [bug][change] i18n: rename Korean translat'n from country t' lang code #404 Maintenance [task] search: update lunr languages t' 1.10.0 #403 5.6.6 (2022-11-23) Enhancements [feature] search: make build an' js forgiv'n against config errors #400 Fixes [bug] variant: minor color adjustments #402 [bug] variant: fix generator fer use o' neon #401 5.6.5 (2022-11-19) Fixes [bug] menu: relax usage o' background color #399 5.6.4 (2022-11-19) Fixes [bug] theme: make alias planks us'ble by file:// protocol #398 5.6.3 (2022-11-19) Fixes [bug] theme: be compat'ble wit' Cap'n Hugo \u003e= 0.95.0 #397 5.6.2 (2022-11-19) Fixes [bug] theme: build breaks sites without “output” section 'n config #396 5.6.1 (2022-11-19) Fixes [bug] theme: fix image distort'n #395 5.6.0 (2022-11-18) Enhancements [feature] toc: improve keyboard handl'n #390 [feature] search: improve keyboard handl'n #387 [feature] search: add dedicated search plank #386 [feature] theme: make creat'n o' generator meta tag configur'ble #383 [feature] theme: increase build performance #380 Fixes [bug] mermaid: avoid lead'n whitespace #394 [bug] theme: fix build errors when referenc'n SVGs 'n markdown #393 [bug] variant: avoid neon t' leak into IE11 fallback #392 [bug] theme: fix urls fer file:// protocol 'n sitemap #385 [bug] theme: add id t' h1 elements #384 [bug] rss: fix display o' hidden subpages #382 [bug] nav: fix key navigat'n when press'n wrong modifiers #379 Maintenance [task] mermaid: update t' version 9.2.2 #391 5.5.3 (2022-11-10) Fixes [bug] tags: fix non-latin tag display on planks #378 5.5.2 (2022-11-08) Fixes [bug] theme: fix typo 'n 404.html #376 [bug] theme: allow menu items an' children t' be served by file:// protocol #375 5.5.1 (2022-11-07) Fixes [bug] theme: fix overflow'n issue wit' anchors an' tooltips #364 5.5.0 (2022-11-06) Enhancements [feature][change] theme: opt'mize plank board fer images #304 Fixes [bug] theme: fix context 'n render hooks #373 [bug] print: make canonical URL absolute #371 5.4.3 (2022-11-05) Enhancements [feature] history: refactor fer a11y #341 Fixes [bug] theme: fix multilang links when ship served from subdirectory #370 5.4.2 (2022-11-05) Maintenance [task] build: change set-output t' env vars #348 5.4.1 (2022-11-05) Fixes [bug] mermaid: fix Gantt chart width #365 5.4.0 (2022-11-01) Enhancements [feature] math: allow pass'n o' parameters wit' codefence rules #363 [feature] i18n: add Finnish translat'n #361 [feature] mermaid: allow pass'n o' parameters wit' codefence rules #360 [feature] i18n: support RTL #357 [feature][change] button: add opt'n fer target #351 [feature][change] theme: allow t' be served by file:// protocol #349 5.3.3 (2022-10-09) Fixes [bug] archetypes: fix frontmatter on home.md template #346 5.3.2 (2022-10-08) Fixes [bug] nav: change defunct keyboard shortcuts #344 5.3.1 (2022-10-08) Enhancements [feature] i18n: update Spanish translat'n #343 [feature] theme: opt'n t' align images #327 5.3.0 (2022-10-07) Enhancements [feature] expander: improve whitespace between label an' rrrambl'n #338 [feature] swagger: improve print version #333 Fixes [bug] print: fix links o' subsections #340 [bug] theme: remove W3C validator errors #337 [bug] children: remove unused plank parameter from docs #336 [bug] print: remove menu placeholder 'n Firefox #335 [bug] swagger: fix download button overflow #334 [bug][change] a11y: remove WCAG errors whar' applic'ble #307 5.2.4 (2022-10-02) Fixes [bug] theme: remove HTML5 validator errors #329 5.2.3 (2022-09-12) Fixes [bug] print: chapter planks overwrite font-size #328 5.2.2 (2022-08-23) Fixes [bug] print: fix urls fer uglyURLs=true #322 5.2.1 (2022-08-05) Enhancements [feature] i18n: improve Japanese translat'n #318 Fixes [bug] nav: prev/next ignores ordersectionby #320 Maintenance [task] task: bump Cap'n Hugo minimum requirement t' 0.95 #319 5.2.0 (2022-08-03) Enhancements [feature][change] menu: expand collapsed menus if search term be found 'n submenus #312 Fixes [bug] print: switch mermaid an' swagger style before print #316 [bug] theme: fix chapter margins on big screens #315 5.1.2 (2022-07-18) Fixes [bug] print: reset mermaid theme t' light #313 [bug] mermaid: header be show'n up 'n FF #311 5.1.1 (2022-07-15) Fixes [bug] tags: don’t count tags if plank be hidden #310 5.1.0 (2022-07-15) Enhancements [feature][change] print: make print url deterministic #309 [feature] theme: allow overrid'n partials fer output formats #308 5.0.3 (2022-07-07) Fixes [bug] ie11: no styles after rework o' archetypes #306 5.0.2 (2022-07-07) Fixes [bug] theme: board CSS if JS be disabled #305 5.0.1 (2022-07-07) Enhancements [feature][break'n] theme: opt'mize load'n o' js an' css #303 5.0.0 (2022-07-05) Enhancements [feature][change] archetypes: modularize render'n #300 [feature] history: don’t reload plank when history gets cleared #299 [feature] menu: replace expander by fontawesome chevrons #296 [feature] theme: align rrrambl'n wit' topbar ay'con limits #290 [feature] button: allow fer empty href #288 [feature] i18n: make Simplified Chinese th' standard language fer th' zn code #287 [feature] clipboard: move head styles t' stylesheet #286 [feature] math: add mathjax render'n #235 [feature] theme: allow fer plank head'n modificat'n #139 Fixes [bug] favicon: fix URL if ship resides 'n subfolder #302 [bug] code: show copy-to-clipboard marker fer blocklevel code #298 [bug] menu: make active expander vis'ble on hover #297 [bug] print: dis'ble arrow navigat'n #294 [bug] print: add miss'n plank break after index or section #292 [bug] theme: use more space on wide screens #291 [bug] theme: fix size o' chapter head'n #289 Maintenance [task] chore: update RapiDoc 9.3.3 #301 [task] chore: update Merrrmaid 9.1.3 #293 4.2.5 (2022-06-23) Fixes [bug] swagger: javascript code does not board 'n documentat'n #285 [bug] children: descript'ns not work'n #284 [bug] print: fix empty plank fer shortcut links #283 4.2.4 (2022-06-23) Fixes [bug] theme: fix url fer logo an' home button #282 4.2.3 (2022-06-23) Fixes [bug][break'n] include: second parameter be ignored #281 4.2.2 (2022-06-23) No changelog fer this release.\n4.2.1 (2022-06-23) No changelog fer this release.\n4.2.0 (2022-06-23) Enhancements [feature][change] tabs: don’t change tab select'n if panel does not contain item #279 [feature] shorrrtcodes: convert t' partials #277 Fixes [bug] swagger: avoid builtin syntax-highlightn'n #280 [bug] search: fix console message fer miss'n lunr translat'ns #278 [bug] tabs: fix wrapp'n when hav'n many tabs #272 4.1.1 (2022-06-18) Fixes [bug] notice: fix layout when rrrambl'n starts wit' head'n #275 4.1.0 (2022-06-12) Enhancements [feature] i18n: support multilang rrrambl'n #271 4.0.5 (2022-06-12) Fixes [bug] i18n: Vietnamese language wit' wrong lang code #270 [bug] i18n: fix search fer non western languages #269 4.0.4 (2022-06-07) Enhancements [feature] theme: improve keyboard navigat'n fer scroll'n #268 Fixes [bug] swagger: adjust font-size fer method buttons #267 [bug] menu: hide expander when only hidden subpages #264 [bug] theme: make compat'ble wit' Cap'n Hugo 0.100.0 #263 Maintenance [task] swagger: update rapidoc t' 9.3.2 #266 [task] mermaid: update t' 9.1.1 #265 4.0.3 (2022-06-05) Enhancements [feature] toc: add scrollbar #262 4.0.2 (2022-06-05) Fixes [bug] theme: let browser scroll plank on CTRL+f #242 4.0.1 (2022-06-05) No changelog fer this release.\n4.0.0 (2022-06-05) Enhancements [feature] shorrrtcodes: add named parameter if miss'n #260 [feature][break'n] theme: remove –MAIN-ANCHOR-color from stylesheet #256 [feature] i18n: add Italian translat'n #254 [feature] attachments: support fer brand colors #252 [feature] notice: support fer brand colors #251 [feature][break'n] config: remove custom_css #248 [feature] theme: use proper file extension fer page-meta.go #246 [feature] variant: add support fer brand color variables #239 [feature] i18n: add Polish translat'n #237 Fixes [bug] shorrrtcodes: accept boolean parameters if given as str'n #261 [bug] print: adjust button an' tab size #259 [bug] print: show Merrrmaid if requested 'n frontmatter #255 [bug] theme: adjust thin scrollbar slider #244 [bug] mobile: fix broken scrollbar #243 [bug] theme: fix display o' tooltip fer head'n anchor #241 3.4.1 (2022-04-03) Fixes [bug] theme: fix IE11 incompatibilities #234 3.4.0 (2022-04-03) Enhancements [feature] i18n: add Traditional Chinese translat'n #233 [feature] menu: expand/collapse menu items without navigat'n #231 [feature] print: add opt'n t' print whole chapter #230 [feature][break'n] theme: apply user supplied rrrambl'n footer below rrrambl'n #229 Fixes [bug] theme: scroll t' head'n on initial board #232 3.3.0 (2022-03-28) Enhancements [feature] theme: add CSS font variables #227 [feature] swagger: add support fer oas/swagger documentat'n #226 Fixes [bug] variant: make variant switch work on slow networks #228 3.2.1 (2022-03-25) Fixes [bug] print: fix minor inconsistencies #225 [bug] print: show more than just th' title plank #224 [bug] theme: align rrrambl'n scrollbar t' th' right on big screens #223 3.2.0 (2022-03-19) Enhancements [feature][change] mermaid: support differ'n themes fer color variant switch #219 [feature] mermaid: board javascript on demand #218 Maintenance [task] mermaid: update t' 8.14.0 #220 3.1.1 (2022-03-16) Enhancements [feature] i18n: add Korean translat'n #217 3.1.0 (2022-03-15) Enhancements [feature] notice: add ay'con parameter #212 [feature] mobile: remove breadcrumb ellipsis #211 Fixes [bug] theme: make storage o' multiple Cap'n Hugo sites on same server distinct #214 [bug] variant: switch breadcrumb color 'n Chrome #213 [bug] mobile: improve behavior o' sidebar menu #210 3.0.4 (2022-02-24) Enhancements [feature] theme: improve font load'n #201 [feature][change] variant: fix inconsistent color vari'ble nam'n #200 Fixes [bug] variant: fix occasional fail when resett'n generator #208 [bug] docs: don’t move header on logo hover 'n IE11 #207 [bug] variant: avoid flash o' menu header when non default variant be active #206 [bug] theme: fix wrong HTML clos'n tag order 'n chapters #205 [bug] theme: adjust breadcrumb an' title fer empty home plank titles #202 3.0.3 (2022-02-23) Enhancements [feature] tags: show tag count 'n taxonomy list #195 Fixes [bug] theme: remove Cap'n Hugo build warning if plank be not file based #197 [bug] tags: adhere t' titleSeparator #196 [bug] theme: hide footer divider an' variant selector 'n IE11 #194 3.0.2 (2022-02-23) Enhancements [feature] tags: sort by name #193 3.0.1 (2022-02-23) Enhancements [feature] children: set containerstyle automatically accord'n t' style #192 Fixes [bug] theme: revert fontawsome t' version 5 fer IE11 compat #191 3.0.0 (2022-02-22) Enhancements [feature] variant: build a variant generator #188 [feature] nav: only show toc if th' plank has head'ns #182 [feature][break'n] theme: change default colors t' Relearrrn defaults #181 [feature] variant: add a variant selector #178 [feature][break'n] menu: rework footer UX #177 [feature] theme: support fer dark mode #175 [feature] docs: use light rules highlightn'n theme #174 [feature] notice: tweak dull colors #173 [feature] theme: rework header UX #151 Fixes [bug] search: remove additional X 'n filled out search box 'n IE11 #190 [bug] clipboard: localize tooltips #186 [bug] print: hide sidebar on Mac #183 [bug] menu: fix scrollbar height #180 [bug][change] search: fix color change fer ay'cons on hover #176 2.9.6 (2022-02-07) Fixes [bug] menu: remove debug output #171 2.9.5 (2022-02-07) Fixes [bug] menu: let arrow navigat'n respect ordersectionsby configurat'n #170 2.9.4 (2022-02-06) Fixes [bug] exampleSite: fix links 'n official documentat'n #168 2.9.3 (2022-02-06) Fixes [bug] menu: invalid URL when th' shortcut be an internal link #163 2.9.2 (2021-11-26) Enhancements [feature] theme: add theme version info t' head #158 Fixes [bug] theme: fix select'n o' *.ico files as favicons #160 2.9.1 (2021-11-22) Fixes [bug] menu: fix significantly low performance fer collect'n o' meta info #157 2.9.0 (2021-11-19) Fixes [bug][break'n] relref: fix inconsistent behavior #156 [bug] search: make dropdown stick t' search field when scroll'n #155 [bug] menu: align long text properly #154 [bug] copyToClipBoard: add miss'n right border fer inline code if disableInlineCopyToClipBoard=true #153 [bug] menu: show hidden sibl'n planks reliably #152 [bug] menu: br'n active item 'n sight fer large menus #149 2.8.3 (2021-11-09) Fixes [bug] mermaid: let zoom reset t' initial size #145 [bug] mermaid: remove whitespace from big graphs #143 2.8.2 (2021-11-08) Fixes [bug] mermaid: always board javascript t' avoid break if code fences be used #142 2.8.1 (2021-11-04) Fixes [bug] search: don’t break JS 'n multilang setup if search be disabled #140 2.8.0 (2021-11-03) Enhancements [feature] toc: make disableTOC globally avail'ble via config.toml #133 [feature] mermaid: only board javascript if necessary #95 [feature][change] theme: switch font #83 [feature] theme: make favicon configur'ble #2 Fixes [bug] mermaid: assert that window.mermaid be actually mermaid #136 [bug] menu: remove usage o' Hugos UniqueID #131 [bug] theme: reduce margin fer children shortcode #130 [bug] theme: left-align h3 'n chapters #129 [bug] theme: align copy link t' clipboard #128 2.7.0 (2021-10-24) Enhancements [feature] notice: support custom titles #124 2.6.0 (2021-10-21) Fixes [bug] theme: generate correct links if theme served from subdirectory #120 2.5.1 (2021-10-12) Fixes [bug] security: fix XSS fer malicious 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 malicious URLs #114 [bug] menu: write correct local shortcut links #112 2.4.1 (2021-10-07) Fixes [bug] theme: remove runtime styles from print #111 2.4.0 (2021-10-07) Enhancements [feature] lang: add vietnamese translat'n #109 [feature][change] theme: simplify stylesheet fer color variants #107 [feature] hidden planks: remove from RSS feed, JSON, taxonomy etc #102 [feature] theme: announce alternative rrrambl'n 'n header #101 [feature] menu: frontmatter opt'n t' change sort predicate #98 [feature] menu: add default sett'n fer menu expansion #97 [feature] theme: improve print style #93 [feature] theme: improve style #92 Fixes [bug] include: don’t generate additional HTML if file should be displayed “as is” #110 [bug] attachments: fix broken links if multilang config be used #105 [bug] theme: fix sticky header t' remove horizontal scrollbar #82 Maintenance [task] chore: update fontawesome #94 2.3.2 (2021-09-20) Fixes [bug] docs: rename history pirate translat'n #91 2.3.1 (2021-09-20) Fixes [bug] docs: rename english pirate translat'n t' avoid crash on render'n #90 2.3.0 (2021-09-13) Fixes [bug] theme: fix usage o' section element #88 Maintenance [task] theme: ensure IE11 compatibility #89 [task] docs: Arrr! showcase multilang featurrre #87 2.2.0 (2021-09-09) Enhancements [feature] sitemap: hide hidden planks from sitemap an' SEO index'n #85 Fixes [bug] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs #86 Maintenance [task] theme: switch from data-vocabulary t' schema #84 2.1.0 (2021-09-07) Enhancements [feature] search: open expand if it contains search term #80 [feature] menu: scroll active item into view #79 [feature] search: dis'ble search 'n hidden planks #76 [feature] search: improve readablility o' index.json #75 [feature] search: increase performance #74 [feature] search: improve search context preview #73 Fixes [bug][change] search: hide non-site rrrambl'n #81 [bug] menu: always hide hidden sub planks #77 2.0.0 (2021-08-28) Enhancements [feature] tabs: enhance styl'n #65 [feature] theme: improve readability #64 [feature] menu: show hidden planks if accessed directly #60 [feature][change] theme: treat planks without title as hidden #59 [feature] search: show search results if field gains focus #58 [feature] theme: add partial templates fer pre/post menu entries #56 [feature] theme: make chapter archetype more read'ble #55 [feature] children: add parameter fer container style #53 [feature] theme: make rrrambl'n a template #50 [feature] menu: control menu expansion wit' alwaysopen parameter #49 [feature] include: new shortcode t' include other files #43 [feature] theme: adjust print styles #35 [feature][change] code highlighter: switch t' standard hugo highlighter #32 Fixes [bug][change] arrow-nav: default sort'n ignores ordersectionsby #63 [bug][change] children: default sort'n ignores ordersectionsby #62 [bug][change] arrow-nav: fix broken links on (and below) hidden planks #61 [bug] theme: remove superfluous singular taxonomy from taxonomy title #46 [bug][change] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n #45 [bug] theme: fix home link when base URL has some path #44 Maintenance [task] docs: include changelog 'n exampleSite #33 1.2.0 (2021-07-26) Enhancements [feature] theme: adjust copy-to-clipboard #29 [feature] attachments: adjust style between notice boxes an' attachments #28 [feature] theme: adjust blockquote contrast #27 [feature] expand: add opt'n t' open on plank board #25 [feature] expand: rework styl'n #24 [feature] attachments: sort output #23 [feature] notice: make restyl'n o' notice boxes more robust #20 [feature] notice: fix contrast issues #19 [feature] notice: align box colors t' common standards #18 [feature] notice: use distinct ay'cons fer notice box type #17 Fixes [bug] attachments: support i18n fer attachment size #21 [bug] notice: support i18n fer box labels #16 [bug] notice: support multiple blocks 'n one box #15 Maintenance [task] dependency: upgrade jquery t' 3.6.0 #30 1.1.1 (2021-07-04) Maintenance [task] theme: prepare fer new hugo theme registrat'n #13 1.1.0 (2021-07-02) Enhancements [feature] mermaid: expose opt'ns 'n config.toml #4 Fixes [bug] mermaid: config opt'n fer CDN url not used #12 [bug] mermaid: only highlight text 'n HTML elements #10 [bug] mermaid: support pan \u0026 zoom fer graphs #9 [bug] mermaid: code fences not always rendered #6 [bug] mermaid: search term on board may bomb chart #5 Maintenance [task] mermaid: update t' 8.10.2 #7 1.0.1 (2021-07-01) Maintenance [task] Prepare fer hugo showcase #3 1.0.0 (2021-07-01) Maintenance [task] Fork project #1 ", - "description": "Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo\u0026rsquo;s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use .", - "tags": null, + "description": "Changelog 5.27.0 (2024-04-07) Enhancements [feature] theme: simplify title generat'n #825 [feature] theme: adjust t' Hugo’s build-in code #824 [feature][change] link: warn if fragment be not found #823 [feature] theme: add styl'n fer selected HTML elements #822 [feature] a11y: improve search box #821 [feature][change] dependencies: make loader more versatile #820 [feature] nav: scroll t' prev/next head'n us'n keyboard shortcut #819 [feature] breadcrumb: use .", + "tags": [], "title": "Historrry", "uri": "/hugo-theme-relearn/pir/basics/history/index.html" }, @@ -210,19 +212,19 @@ var relearn_search_index = [ "content": "This be a demo child plank.\nSubpages o' this plank plank 3-1 ", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 3", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children", - "content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\n", + "content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.", "description": "This be a hidden demo child plank", "tags": [ - "children", - "the hidden" + "Children", + "hush, matey" ], "title": "plank 4 (hidden)", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-4/index.html" @@ -231,15 +233,15 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": " Attachments NoTreasure.txt (26 B) Arrr This shortcode be deprecated 'n favor o' th' new resources shortcode. See migrat'n instruct'ns below.\nTh' attachments shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.\nAttachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Migrat'n While this shortcode will still be avail'ble fer some time, it does not receive support anymore. Start t' migrate early, as it will be removed wit' th' next major update o' th' theme.\nTh' resources shortcode leverages Hugo’s resource feature fer plank bundles. It has all th' same parameter as th' attachments shortcode but applies th' pattern directly on a resources Name attribute.\nT' migrate yer planks apply th' follow'n steps:\nIf a plank be not already a plank bundle convert it Move yer files t' a valid destinat'n inside o' yer plank bundle (depend'n if ye have a branch or a leaf bundle) Change th' calls from th' attachments shortcode t' th' resources shortcode an' adjust th' pattern parameter t' th' new directory layout an' th' resources Name attribute. Multilanguage features be not supported directly by th' shortcode anymore but rely on Hugo’s handl'n fer resource translat'ns.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% attachments sort=\"asc\" /%}} {{ partial \"shortcodes/attachments.html\" (dict \"page\" . \"sort\" \"asc\" )}} Parameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Attachments\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' attachments by file name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Setup Single language Th' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).\nIf yer plank be a leaf bundle, attachments must be placed 'n a nested index.files folder, accordingly.\nrrrambl'n _index.md plank index.md index.files attachment.pdf If yer plank be a branch bundle, attachments must be placed 'n a nested _index.files folder, accordingly.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.112.0\nrrrambl'n _index.md plank _index.md _index.files attachment.pdf For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' .files.\nArrr This be only avail'ble fer Cap'n Hugo \u003c 0.112.0\nrrrambl'n _index.md plank.files attachment.pdf plank.md Multilingual Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages an' th' language code must be part o' th' folder name.\nEg. fer a ship 'n English an' Piratish:\nrrrambl'n index.en.md index.pir.md plank index.en.md index.pir.md index.en.files attachment.pdf index.pir.files attachment.pdf ", "description": "Th' Attachments shorrrtcode displays a list o' files attached t' a plank", - "tags": null, + "tags": [], "title": "Attachments", "uri": "/hugo-theme-relearn/pir/shortcodes/attachments/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Th' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.\nImportant Version6.6.6 Captain AhoiNew Awesome\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default Th' style scheme used fer th' badge.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' badge title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text fer th' badge. Examples Style By Severity {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Break'n{{% /badge %}} AhoiNew AvastChange Smarrrt ArrrseOptional ArrrBreak'n\nBy Brand Colors {{% badge style=\"primary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" ay'con=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" ay'con=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Ay'con an' Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nWithout Ay'con {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}}Version6.6.6 AhoiAwesome RankCaptain\nWithout Title Text {{% badge ay'con=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nAll Set {{% badge ay'con=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nOverride fer Severity {{% badge style=\"info\" ay'con=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title an' Rrrambl'n {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome Wit' Ay'con Rrrambl'n Ye can combine th' badge wit' th' ay'con shortcode t' create even more stunn'n visuals.\nIn this case ye need t' declare {{\u003c badge \u003e}} instead o' {{% badge %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.\n{{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}}\nPirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside o' Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" ay'con=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\n", + "content": "Th' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.\nImportant Version6.6.6 Captain AhoiNew Awesome\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% badge %}}Important{{% /badge %}} {{% badge style=\"primary\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}} {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Awesome{{% /badge %}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"content\" \"Important\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"Version\" \"content\" \"6.6.6\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"red\" \"icon\" \"angle-double-up\" \"content\" \"Captain\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"style\" \"info\" \"content\" \"New\" )}} {{ partial \"shortcodes/badge.html\" (dict \"page\" . \"color\" \"fuchsia\" \"icon\" \"fab fa-hackerrank\" \"content\" \"Awesome\" )}} Parameter Name Default Notes style default Th' style scheme used fer th' badge.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' badge title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text fer th' badge. Examples Style By Severity {{% badge style=\"info\" %}}New{{% /badge %}} {{% badge style=\"note\" %}}Change{{% /badge %}} {{% badge style=\"tip\" %}}Optional{{% /badge %}} {{% badge style=\"warning\" %}}Break'n{{% /badge %}} AhoiNew AvastChange Smarrrt ArrrseOptional ArrrBreak'n\nBy Brand Colors {{% badge style=\"primary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Mandatory{{% /badge %}} {{% badge style=\"secondary\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Optional{{% /badge %}} {{% badge style=\"accent\" ay'con=\"bullhorn\" title=\"Announcement\" %}}Special{{% /badge %}} AnnouncementMandatory AnnouncementOptional AnnouncementSpecial\nBy Color {{% badge style=\"blue\" ay'con=\"palette\" title=\"Color\" %}}Blue{{% /badge %}} {{% badge style=\"green\" ay'con=\"palette\" title=\"Color\" %}}Green{{% /badge %}} {{% badge style=\"grey\" ay'con=\"palette\" title=\"Color\" %}}Grey{{% /badge %}} {{% badge style=\"orange\" ay'con=\"palette\" title=\"Color\" %}}Orange{{% /badge %}} {{% badge style=\"red\" ay'con=\"palette\" title=\"Color\" %}}Red{{% /badge %}} ColorBlue ColorGreen ColorGrey ColorOrange ColorRed\nBy Special Color {{% badge style=\"default\" ay'con=\"palette\" title=\"Color\" %}}Default{{% /badge %}} {{% badge style=\"transparent\" ay'con=\"palette\" title=\"Color\" %}}Transparent{{% /badge %}} ColorDefault ColorTransparent\nVariants Without Ay'con an' Title Text {{% badge %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nWithout Ay'con {{% badge title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" ay'con=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" title=\"Rank\" %}}Captain{{% /badge %}}Version6.6.6 AhoiAwesome RankCaptain\nWithout Title Text {{% badge ay'con=\"star\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" title=\" \" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" %}}Captain{{% /badge %}}6.6.6 Awesome Captain\nAll Set {{% badge ay'con=\"star\" title=\"Version\" %}}6.6.6{{% /badge %}} {{% badge style=\"info\" %}}Awesome{{% /badge %}} {{% badge style=\"red\" ay'con=\"angle-double-up\" title=\"Rank\" %}}Captain{{% /badge %}} Version6.6.6 AhoiAwesome RankCaptain\nOverride fer Severity {{% badge style=\"info\" ay'con=\"rocket\" title=\"Feature\" %}}Awesome{{% /badge %}} FeatureAwesome Other Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title an' Rrrambl'n {{% badge color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" title=\"**Font**\" %}}**Awesome**{{% /badge %}} FontAwesome Wit' Ay'con Rrrambl'n Ye can combine th' badge wit' th' ay'con shortcode t' create even more stunn'n visuals.\nIn this case ye need t' declare {{\u003c badge \u003e}} instead o' {{% badge %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.\n{{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}}{{\u003c /badge \u003e}} {{\u003c badge style=\"primary\" ay'con=\"angle-double-up\" title=\"Rank\" \u003e}}{{% ay'con skull-crossbones %}} Pirate{{\u003c /badge \u003e}}\nPirate\nRank\nRank Pirate\nRank\nRank Pirate\nInside o' Text Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. {{% badge style=\"blue\" ay'con=\"rocket\" %}}Awesome{{% /badge %}} Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Awesome Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.", "description": "Marker badges t' display 'n yer text", - "tags": null, + "tags": [], "title": "Badge", "uri": "/hugo-theme-relearn/pir/shortcodes/badge/index.html" }, @@ -247,7 +249,7 @@ var relearn_search_index = [ "breadcrumb": "Categorrries", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrry :: Basic", "uri": "/hugo-theme-relearn/pir/categories/basic/index.html" }, @@ -255,15 +257,15 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": "Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo\nAy'con Empty {{% button href=\"https://gohugo.io/\" ay'con=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}{{% /button %}} T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" iconposit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Cap'n Hugo 'n same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo 'n new Window/Frame (default){{% /button %}}Get Cap'n Hugo 'n same Window/Frame Get Cap'n Hugo 'n new Window/Frame (default)\nOther Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" %}}Get **Cap'n Hugo**{{% /button %}} Get Cap'n Hugo Severity Style wit' All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse Button t' Internal Plank {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button wit' JavaScript Act'n If yer JavaScript act'n does not change th' focus afterwards, make sure t' call this.blur() 'n th' end t' unselect th' button.\n{{% button style=\"primary\" ay'con=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element T' use native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml\n[marrrkup.goldmark.renderer] unsafe = true\u003cform act'n=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", "description": "Nice buttons on yer plank", - "tags": null, + "tags": [], "title": "Button", "uri": "/hugo-theme-relearn/pir/shortcodes/button/index.html" }, { "breadcrumb": "", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nCap'n Hugo Relearrrn Theme A theme fer Cap'n Hugo designed fer documentat'n.\n★ What’s new 'n th' latest release ★\nMotivat'n Th' Relearrrn theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adapt'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.\nFeatures Wide set o' usage scenarios Responsive design fer mobile usage Looks nice on paper (if it has to) Us'ble offline, no external dependencies Us'ble from yer local file system via file:// protocol Support fer th' VSCode Front Matter extension fer on-premise CMS capabilities Support fer Open Graph, Schema an' Twitter Cards Configur'ble them'n an' visuals Configur'ble brand images Automatic switch fer light/dark variant depend'n on yer OS sett'ns Predefined light, dark an' color variants User select'ble variants Stylesheet generator Configur'ble rules highlight'n Unique theme features Print whole chapters or even th' complete ship In plank search Ship search Dedicated search plank Taxonomy support Configur'ble topbar buttons Unlimited nested menu items Configur'ble shortcut links Hidden planks Multi language support Full support fer languages written right t' left Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support fer mixed language rrrambl'n Additional Marrrkdown features Support fer GFM (GitHub Flavored Markdown) Image effects like siz'n, shadow, border an' alignment Image lightbox Shorrrtcodes galore Display resources contained 'n a plank bundle Marker badges Configur'ble buttons List child planks Expand areas t' reveal rrrambl'n Font Awesome ay'cons Inclusion o' other files Math an' chemical formulae us'n MathJax Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Colorful boxes OpenAPI specificat'ns us'n Swagger UI Reveal ye site’s configurat'n parameter Single tabbed panels an' multiple tabbed panels Installat'n \u0026 Usage For a detailed descript'n o' th' theme’s capabilities visit th' official documentat'n.\nChangelog See th' What’s New plank fer release highlights or th' detailed change history fer a complete list o' changes.\nContribut'ns Ye be most welcome t' contribute bugfixes or new features. Check th' contribut'n guidelines first before start'n.\nLicense Th' Relearrrn theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others.\n", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nCap'n Hugo Relearrrn Theme A theme fer Cap'n Hugo designed fer documentat'n.\n★ What’s new 'n th' latest release ★\nMotivat'n Th' Relearrrn theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adapt'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.\nFeatures Wide set o' usage scenarios Responsive design fer mobile usage Looks nice on paper (if it has to) Us'ble offline, no external dependencies Us'ble from yer local file system via file:// protocol Support fer th' VSCode Front Matter extension fer on-premise CMS capabilities Support fer Open Graph, Schema an' Twitter Cards Configur'ble them'n an' visuals Configur'ble brand images Automatic switch fer light/dark variant depend'n on yer OS sett'ns Predefined light, dark an' color variants User select'ble variants Stylesheet generator Configur'ble rules highlight'n Unique theme features Print whole chapters or even th' complete ship In plank search Ship search Dedicated search plank Taxonomy support Configur'ble topbar buttons Unlimited nested menu items Configur'ble shortcut links Hidden planks Multi language support Full support fer languages written right t' left Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese Search support fer mixed language rrrambl'n Additional Marrrkdown features Support fer GFM (GitHub Flavored Markdown) Image effects like siz'n, shadow, border an' alignment Image lightbox Shorrrtcodes galore Display resources contained 'n a plank bundle Marker badges Configur'ble buttons List child planks Expand areas t' reveal rrrambl'n Font Awesome ay'cons Inclusion o' other files Math an' chemical formulae us'n MathJax Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc. Colorful boxes OpenAPI specificat'ns us'n Swagger UI Reveal ye site’s configurat'n parameter Single tabbed panels an' multiple tabbed panels Installat'n \u0026 Usage For a detailed descript'n o' th' theme’s capabilities visit th' official documentat'n.\nChangelog See th' What’s New plank fer release highlights or th' detailed change history fer a complete list o' changes.\nContribut'ns Ye be most welcome t' contribute bugfixes or new features. Check th' contribut'n guidelines first before start'n.\nLicense Th' Relearrrn theme be licensed under th' MIT License.\nCredits This theme would not be poss'ble without th' work o' many others.", "description": "A theme fer Cap'n Hugo designed fer documentat'n.", - "tags": null, + "tags": [], "title": "Cap'n Hugo Relearrrn Theme", "uri": "/hugo-theme-relearn/pir/index.html" }, @@ -271,7 +273,7 @@ var relearn_search_index = [ "breadcrumb": "", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrries", "uri": "/hugo-theme-relearn/pir/categories/index.html" }, @@ -279,7 +281,7 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Children", "uri": "/hugo-theme-relearn/pir/tags/children/index.html" }, @@ -287,7 +289,7 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": "Th' children shortcode lists th' child planks o' th' current plank an' its descendants.\nplank X plank 1 plank 2 plank 3 Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% children sort=\"weight\" %}} {{ partial \"shortcodes/children.html\" (dict \"page\" . \"sort\" \"weight\" )}} Parameter Name Default Notes containerstyle ul Choose th' style used t' group all children. It could be any HTML tag name. style li Choose th' style used t' display each descendant. It could be any HTML tag name. showhidden false When true, child planks hidden from th' menu will be displayed as well. descript'n false When true shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - read more info about summaries on gohugo.io. depth 1 Th' depth o' descendants t' display. For example, if th' value be 2, th' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. 999. sort auto Th' sort criteria o' th' displayed list.\n- auto defaults t' ordersectionsby o' th' planks frontmatter\nor t' ordersectionsby o' th' ship configurat'n\nor t' weight\n- weight\n- title\n- linktitle\n- modifieddate\n- expirydate\n- publishdate\n- date\n- length\n- default adher'n t' Hugo’s default sort criteria Examples All Default {{% children %}} plank X plank 1 plank 2 plank 3 Wit' Descript'n {{% children descript'n=\"true\" %}} plank XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nInfinite Depth an' Hidden Planks {{% children depth=\"999\" showhidden=\"true\" %}} plank X plank 1 plank 1-1 plank 1-1-1 (hidden) plank 1-1-1-1 plank 1-1-1-1-1 (hidden) plank 1-1-1-1-1-1 plank 1-1-2 (headless) plank 1-1-2-1 plank 1-1-2-2 plank 1-1-3 plank 2 plank 3 plank 3-1 plank 4 (hidden) Head'n Styles fer Container an' Elements {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" descript'n=\"true\" %}} plank XThis be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n... plank 1This be a demo child plank\nplank 1-1This be a demo child plank\nplank 1-1-2 (headless)This be a demo child plank\nplank 1-1-3This be a demo child plank\nplank 2This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n.\nplank 3This be a demo child plank\nplank 3-1This be a plain plank test nested 'n a parent\nDivs fer Group an' Element Styles {{% children containerstyle=\"div\" style=\"div\" depth=\"3\" %}} plank X plank 1 plank 1-1 plank 1-1-2 (headless) plank 1-1-3 plank 2 plank 3 plank 3-1 ", "description": "List th' child planks on a plank", - "tags": null, + "tags": [], "title": "Children", "uri": "/hugo-theme-relearn/pir/shortcodes/children/index.html" }, @@ -295,7 +297,7 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Config", "uri": "/hugo-theme-relearn/pir/tags/config/index.html" }, @@ -303,7 +305,7 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Content", "uri": "/hugo-theme-relearn/pir/tags/content/index.html" }, @@ -311,7 +313,7 @@ var relearn_search_index = [ "breadcrumb": "Categorrries", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrry :: Content", "uri": "/hugo-theme-relearn/pir/categories/content/index.html" }, @@ -319,7 +321,7 @@ var relearn_search_index = [ "breadcrumb": "Development", "content": "Code Quality A new release can happen at any time from th' main branch o' th' GitHub project without further acknowledgment. This makes it necessary that, every pushed set o' changesets into th' main branch must be self-contained an' correct, result'n 'n a releas'ble version.\nStay simple fer th' user by focus'n on th' mantra “convent'n over configuration”.\nAt installat'n th' ship should work reason'ble without (m)any configurat'n.\nStay close t' th' Cap'n Hugo way.\nDon’t use npm or any preprocess'n, our contributors may not be front-end developers.\nDocument new features 'n th' exampleSite. This also contains entries t' th' What’s new plank.\nDon’t break exist'n features if ye don’t have t'.\nRemove reported issue from th' browser’s console.\nCheck fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.\nConventional Commits Write commit messages 'n th' conventional commit format.\nFollow'n be an inpomplete list o' some o' th' used conventional commit types. Be creative.\nCommon Feature Structure Shorrrtcodes build a11y favicon attachments browser archetypes search badge chore alias menu button docs generator history children shorrrtcodes i18n scrollbar expand theme mobile nav ay'con print toc include rss clipboard math variant syntaxhighlight mermaid boxes notice openapi piratify siteparam tabs ", "description": "What to know if you want to contribute", - "tags": null, + "tags": [], "title": "Contributing", "uri": "/hugo-theme-relearn/pir/dev/contributing/index.html" }, @@ -327,7 +329,7 @@ var relearn_search_index = [ "breadcrumb": "", "content": "Contributors Special thanks t' everyone who has contributed t' this project.\nMany thanks t' Mathieu Cornic fer his work on port'n th' Learrrn theme t' Cap'n Hugo.\nMany thanks t' Andy Miller fer initially creat'n th' Learrrn theme fer Grav.\nTheme Dependencies autoComplete - A lightweight an' powerful vanilla JavaScript complet'n suggester clipboard.js - A modern approach t' copy text t' clipboard d3-zoom - Pan an' zoom SVG, HTML or Canvas us'n mouse or touch input - plus dependencies d3-color - Color spaces! RGB, HSL, Cubehelix, CIELAB, an' more d3-dispatch - Register named callbacks an' call them wit' arguments d3-ease - Eas'n funct'ns fer smooth animat'n d3-interpolate - Interpolate numbers, colors, str'ns, arrays, objects, whatever d3-select'n - Transform th' DOM by select'n elements an' join'n t' data d3-timer - An efficient queue fer manag'n thousands o' concurrent animat'ns d3-transit'n - Animated transit'ns fer D3 select'ns d3-drag - Drag an' drop SVG, HTML or Canvas us'n mouse or touch input Font Awesome - Th' internet’s ay'con library an' toolkit js-yaml - JavaScript YAML parser an' dumper Lunr - Enables a great search experience without th' need fer external, server-side, search services Lunr Languages - A collect'n o' languages stemmers an' stopwords fer Lunr Javascript library MathJax - Beautiful math an' chemical formulae 'n all browsers Merrrmaid - Generat'n o' diagram an' flowchart from text 'n a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin SwaggerUI - Generate beautiful documentat'n from a Swagger-compliant API WorkSans - Work Sans be a 9 weight typeface family based loosely on early Grotesques Docs Dependencies github-buttons - Unofficial github:buttons Tool'n Dependencies GitHub - Continuous deployment, test'n an' host'n o' this project’s sources an' its documentat'n Various GitHub Act'ns https://github.com/actions/checkout https://github.com/actions/setup-node https://github.com/Akkjon/close-milestone https://github.com/andstor/file-reader-act'n https://github.com/ashley-taylor/regex-property-act'n https://github.com/Kaven-Universe/github-action-current-date-time https://github.com/mingjun97/file-regex-replace https://github.com/octokit/graphql-act'n https://github.com/peaceiris/actions-gh-pages https://github.com/peaceiris/actions-hugo https://github.com/WyriHaximus/github-action-create-milestone https://github.com/WyriHaximus/github-action-next-semvers gren - A releasenotes generator fer GitHub Cap'n Hugo - Th' static ship generator o' yer choice ", "description": "Contributors Special thanks t' everyone who has contributed t' this project.", - "tags": null, + "tags": [], "title": "Crrredits", "uri": "/hugo-theme-relearn/pir/more/credits/index.html" }, @@ -335,7 +337,7 @@ var relearn_search_index = [ "breadcrumb": "Categorrries", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrry :: Custom", "uri": "/hugo-theme-relearn/pir/categories/custom/index.html" }, @@ -343,15 +345,15 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Documentat'n", "uri": "/hugo-theme-relearn/pir/tags/documentatn/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Th' expand shortcode displays an expandable/collaps'ble section o' text.\nExpand me… Thank ye!\nThat’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank ye!\" )}} Parameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitrary text t' appear next t' th' expand/collapse ay'con. open 2 false When true th' rrrambl'n text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed on expand. Examples All Defaults {{% expand %}}Yes, ye did it!{{% /expand %}} Expand me… Yes, ye did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need t' press ye!{{% /expand %}} Expand me… No need t' press ye! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /expand %}} Show me almost endless possibilities Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\n", + "content": "Th' expand shortcode displays an expandable/collaps'ble section o' text.\nExpand me… Thank ye!\nThat’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% expand title=\"Expand me...\" %}}Thank ye!{{% /expand %}} {{% expand \"Expand me...\" %}}Thank ye!{{% /expand %}} {{ partial \"shortcodes/expand.html\" (dict \"page\" . \"title\" \"Expand me...\" \"content\" \"Thank ye!\" )}} Parameter Name Posit'n Default Notes title 1 \"Expand me...\" Arbitrary text t' appear next t' th' expand/collapse ay'con. open 2 false When true th' rrrambl'n text will be initially shown as expanded. \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed on expand. Examples All Defaults {{% expand %}}Yes, ye did it!{{% /expand %}} Expand me… Yes, ye did it! Initially Expanded {{% expand title=\"Expand me...\" open=\"true\" %}}No need t' press ye!{{% /expand %}} Expand me… No need t' press ye! Arbitrary Text {{% expand title=\"Show me almost **endless** possibilities\" %}} Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /expand %}} Show me almost endless possibilities Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)", "description": "Displays an expand'ble/collaps'ble sect'n o' text on yer plank", - "tags": null, + "tags": [], "title": "Expand", "uri": "/hugo-theme-relearn/pir/shortcodes/expand/index.html" }, @@ -359,15 +361,15 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' highlight shortcode renders yer code wit' a rules highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode be fully compat'ble wit' Hugo’s highlight shortcode but offers some extensions.\nIt be called interchangeably 'n th' same way as Hugo’s own shortcode provid'n positional parameter or by simply us'n codefences.\nYe be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s highlight funct'n rules if ye call this shortcode as a partial us'n compatibility rules.\nWhile th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Posit'n Default Notes type 1 \u003cempty\u003e Th' language o' th' code t' highlight. Choose from one o' th' supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title fer code. This displays th' code like a single tab if hl_inline=false (which be Hugo’s default). wrap see notes Extension. When true th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.\nTh' default value can be set 'n yer hugo.toml an' overwritten via frontmatter. See below. opt'ns 2 \u003cempty\u003e An optional, comma-separated list o' zero or more Cap'n Hugo supported opt'ns as well as extension parameter from this t'ble. \u003coption\u003e \u003cempty\u003e Any o' Hugo’s supported opt'ns. \u003ccontent\u003e \u003cempty\u003e Yer code t' highlight. Configurat'n Default values fer Hugo’s supported opt'ns can be set via goldmark sett'ns 'n yer hugo.toml\nDefault values fer extension opt'ns can be set via params sett'ns 'n yer hugo.toml or be overwritten by frontmatter fer each individual plank.\nGlobal Configurat'n File Ye can configure th' color style used fer code blocks 'n yer color variants stylesheet file.\nRecommended Sett'ns hugo. toml yaml json [marrrkup] [marrrkup.highlight] lineNumbersInT'ble = false noClasses = false marrrkup: highlight: lineNumbersInT'ble: false noClasses: false { \"markup\": { \"highlight\": { \"lineNumbersInTable\": false, \"noClasses\": false } } } Optional Sett'ns hugo. toml yaml json [params] highlightWrap = true params: highlightWrap: true { \"params\": { \"highlightWrap\": true } } Page’s Frontmatter ​ toml yaml json +++ highlightWrap = true +++ --- highlightWrap: true --- { \"highlightWrap\": true } Examples Line Numbers wit' Start'n Offset As mentioned above, line numbers 'n a t'ble layout will shift if code be wrapp'n, so better use inline. T' make th'ns easier fer ye, set lineNumbersInT'ble = false 'n yer hugo.toml an' add lineNos = true when call'n th' shortcode instead o' th' specific values t'ble or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence wit' Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") Wit' Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff ", "description": "Render code with a syntax highlighter", - "tags": null, + "tags": [], "title": "Highlight", "uri": "/hugo-theme-relearn/pir/shortcodes/highlight/index.html" }, { "breadcrumb": "Tag-a-taggs", - "content": "This lists all planks that be hidden from th' home plank. This includes planks that define hidden=true 'n their frontmatter as well as descendents o' hidden planks.\nWhen giv'n term planks, ye should give it a title. Otherwise it will print out a warning an' will use th' urlized title, which may looks weird.\nWhile internally this term be called hidden, it be referenced 'n th' result'n english planks as a secret an' as hush, matey 'n th' piratish translat'n.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.\n", + "content": "This lists all planks that be hidden from th' home plank. This includes planks that define hidden=true 'n their frontmatter as well as descendents o' hidden planks.\nWhen giv'n term planks, ye should give it a title. Otherwise it will print out a warning an' will use th' urlized title, which may looks weird.\nWhile internally this term be called hidden, it be referenced 'n th' result'n english planks as a secret an' as hush, matey 'n th' piratish translat'n.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.", "description": "This lists all planks that be hidden from th' home plank.", - "tags": null, + "tags": [], "title": "Tagga :: hush, matey", "uri": "/hugo-theme-relearn/pir/tags/the-hidden/index.html" }, @@ -375,15 +377,15 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": "Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.\nCustomis'n Ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. 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 HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nT' use these native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true ", "description": "Nice ay'cons fer yer plank", - "tags": null, + "tags": [], "title": "Icon", "uri": "/hugo-theme-relearn/pir/shortcodes/icon/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Th' include shortcode includes other files from yer project inside o' th' current plank.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' file t' be included. Path resolut'n adheres t' Hugo’s build-in readFile funct'n hidefirsthead'n 2 false When true an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Examples Arbitrary Rrrambl'n {{% include \"shortcodes/include/INCLUDE_ME.md\" %}}Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc.1 ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” ↩︎\n", + "content": "Th' include shortcode includes other files from yer project inside o' th' current plank.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% include file=\"shortcodes/include/INCLUDE_ME.md\" %}} {{% include \"shortcodes/include/INCLUDE_ME.md\" %}} {{ partial \"shortcodes/include .html\" (dict \"page\" . \"file\" \"shortcodes/include/INCLUDE_ME.md\" )}} Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.\nParameter Name Posit'n Default Notes file 1 \u003cempty\u003e Th' path t' th' file t' be included. Path resolut'n adheres t' Hugo’s build-in readFile funct'n hidefirsthead'n 2 false When true an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files. Examples Arbitrary Rrrambl'n {{% include \"shortcodes/include/INCLUDE_ME.md\" %}}Ye can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc.1 ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)\nEt Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” ↩︎", "description": "Displays content from other Marrrkdown files", - "tags": null, + "tags": [], "title": "Include", "uri": "/hugo-theme-relearn/pir/shortcodes/include/index.html" }, @@ -391,7 +393,7 @@ var relearn_search_index = [ "breadcrumb": "Development", "content": "Semver This project tries t' follow th' semver policy - although not followed 100% 'n th' past.\nUsually an entry o' Break'n on th' What’s new plank causes a new major release number.\nAll other entries on th' What’s new plank will increase th' minor release number.\nReleases result'n 'n a new major or minor number be called main release.\nReleases contain'n bugfixes only, be only increas'n th' patch release number. Those releases don’t result 'n announcements on th' What’s new plank.\nEntries on th' What’s new plank be checked an' enforced dur'n th' version-release GitHub Act'n.\nManag'n Issues Issues be categorized an' managed by assign'n labels t' it.\nOnce work'n on an issue, assign it t' a fitt'n maintainer.\nWhen done, close th' ticket. Once an issue be closed, it needs t' be assigned t' next release milestone.\nA once released ticket be not allowed t' be reopened an' rereleased 'n a different milestone. This would cause th' changelog t' be changed even fer th' milestone th' issue was previously released 'n. Instead write a new ticket.\nManag'n Pull Requests If a PR be merged an' closed it needs an accompanied issue assigned t'. If there be no issue fer a PR, th' maintainer needs t' create one.\nYe can assign multiple PRs t' one issue as long as they belong together.\nUsually set th' same labels an' milestone fer th' PR as fer th' accompanied issue.\nLabels Kind An issue that results 'n changesets must have exactly one o' th' follow'n labels. This needs t' be assigned latest before release.\nLabel Descript'n Changelog section documentat'n Improvements or addit'ns t' documentat'n - discussion This issue was converted t' a discussion - task Maintenance work Maintenance feature New feature or request Features bug Someth'n isn’t work'n Fixes Impact If th' issue would cause a new main release due t' semver semantics it needs one o' th' accord'n labels an' th' match'n badge on th' What’s new plank.\nLabel Descript'n change Introduces changes wit' exist'n installat'ns break'n Introduces break'n changes wit' exist'n installat'ns Declinat'n If an issue does not result 'n changesets but be closed anyways, it must have exactly one o' th' follow'n labels.\nLabel Descript'n duplicate This issue or pull request already exists invalid This doesn’t seem right support Solved by reconfigur'n th' authors ship unresolved No progress on this issue update A documented change 'n behavior wontfix This will not be worked on Halt Ye can assign one further label out o' th' follow'n list t' signal readers that development on an open issue be currently halted fer different reasons.\nLabel Descript'n blocked Depends on other issue t' be fixed first idea A valu'ble idea that’s currently not worked on undecided No decision was made yet helpwanted Great idea, send 'n a PR needsfeedback Further informat'n be needed 3rd-Party If th' issue be not caused by a programm'n error 'n th' themes own code, ye can label th' caus'n program or library.\nLabel Descript'n browser This be a topic related t' th' browser but not th' theme device This be a topic related t' a certain device hugo This be a topic related t' Cap'n Hugo itself but not th' theme mermaid This be a topic related t' Merrrmaid itself but not th' theme Mak'n Releases A release be based on a milestone named like th' release itself - just th' version number, eg: 1.2.3. It’s 'n th' maintainers responsibility t' check semver semantics o' th' milestone’s name prior t' release an' change it if necessary.\nMak'n releases be automated by th' version-release GitHub Act'n. It requires th' version number o' th' milestone that should be released. Th' release will be created from th' main branch o' th' repository.\nTreat released milestones as immut'ble. Don’t rerelease an already released milestone. An already released milestone may already been consumed by yer users.\nDur'n execut'n o' th' act'n a few th'ns be checked. If a check fails th' act'n fails, result'n 'n no new release. Ye can correct th' errors afterwards an' rerun th' act'n.\nTh' follow'n checks will be enforced\nth' milestone exists there be at least one closed issue assigned t' th' milestone all assigned issues fer this milestone be closed if it’s a main release, there must be a new \u003cmajor\u003e.\u003cminor\u003e at th' beginn'n o' th' What’s new plank if it’s a patch release, there must be th' \u003cmajor\u003e.\u003cminor\u003e from th' previous release at th' beginn'n o' th' What’s new plank Aft a successful run o' th' act'n\nth' History plank be updated, includ'n release version, release date an' text th' What’s new plank be updated, includ'n release version, release date an' text th' version number fer th' \u003cmeta generator\u003e be updated th' updated files be committed th' milestone be closed th' repository be tagged wit' th' version number (eg. 1.2.3), th' main version number (eg. 1.2.x) an' th' major version number (eg. 1.x) a new entry 'n th' GitHub release list wit' th' accord'n changelog will be created th' official documentat'n be built an' deployed th' version number fer th' \u003cmeta generator\u003e be updated t' a temporary an' committed (this helps t' determine if users be runn'n directly on th' main branch or be us'n releases) a new milestone fer th' next patch release be created (this can later be renamed t' a main release if necessary) ", "description": "What to know as a maintainer", - "tags": null, + "tags": [], "title": "Maintaining", "uri": "/hugo-theme-relearn/pir/dev/maintaining/index.html" }, @@ -399,7 +401,7 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' math shortcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Usage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\nMath be also us'ble without enclos'n it 'n a shortcode or codefence but requires configurat'n by ye. In this case no parameter from th' below t'ble be avail'ble.\n​ codefence shortcode partial passthrough ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Parameter Name Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formulae. Configurat'n MathJax be configured wit' default sett'ns but ye can cust'mize MathJax’s default sett'ns fer all o' yer files through a JSON object 'n yer hugo.toml or override these sett'ns per plank through yer planks frontmatter.\nTh' JSON object o' yer hugo.toml / frontmatter be forwarded into MathJax’s configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nGlobal Configurat'n File This example reflects th' default configurat'n also used if ye don’t define mathJaxInitialize\nhugo. toml yaml json [params] mathJaxInitialize = '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' params: mathJaxInitialize: '{ \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"$\", \"$\"]], displayMath: [[\"\\[\", \"\\]\"], [\"$$\", \"$$\"]] }, \"options\": { \"enableMenu\": false }' { \"params\": { \"mathJaxInitialize\": \"{ \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"$\\\", \\\"$\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"$$\\\", \\\"$$\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } } Page’s Frontmatter Usually ye don’t need t' redefine th' global initializat'n sett'ns fer a single plank. But if ye do, ye have repeat all th' values from yer global configurat'n ye want t' keep fer a single plank as well.\nEg. If ye have redefined th' delimiters t' someth'n exotic like @ symbols 'n yer global config, but want t' additionally align yer math t' th' left fer a specific plank, ye have t' put this t' yer frontmatter:\n​ toml yaml json +++ mathJaxInitialize = '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' +++ --- mathJaxInitialize: '{ \"chtml\": { \"displayAlign\": \"left\" }, { \"tex\": { \"inlineMath\": [[\"\\(\", \"\\)\"], [\"@\", \"@\"]], displayMath: [[\"\\[\", \"\\]\"], [\"@@\", \"@@\"]] }, \"options\": { \"enableMenu\": false }' --- { \"mathJaxInitialize\": \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" }, { \\\"tex\\\": { \\\"inlineMath\\\": [[\\\"\\\\(\\\", \\\"\\\\)\\\"], [\\\"@\\\", \\\"@\\\"]], displayMath: [[\\\"\\\\[\\\", \\\"\\\\]\\\"], [\\\"@@\\\", \\\"@@\\\"]] }, \\\"options\\\": { \\\"enableMenu\\\": false }\" } Passthrough Configurat'n Ye can use yer math without enclos'n it 'n a shortcode or codefence by us'n a passthrough configurat'n 'n yer hugo.toml:\nhugo. toml yaml json [marrrkup] [marrrkup.goldmark] [marrrkup.goldmark.extensions] [marrrkup.goldmark.extensions.passthrough] en'ble = true [marrrkup.goldmark.extensions.passthrough.delimiters] block = [['\\[', '\\]'], ['$$', '$$']] inline = [['\\(', '\\)'], ['$', '$']] marrrkup: goldmark: extensions: passthrough: delimiters: block: - - \\[ - \\] - - $$ - $$ inline: - - \\( - \\) - - $ - $ en'ble: true { \"markup\": { \"goldmark\": { \"extensions\": { \"passthrough\": { \"delimiters\": { \"block\": [ [ \"\\\\[\", \"\\\\]\" ], [ \"$$\", \"$$\" ] ], \"inline\": [ [ \"\\\\(\", \"\\\\)\" ], [ \"$\", \"$\" ] ] }, \"enable\": true } } } } } In this case ye have t' tell th' theme that yer plank contains math by sett'n this 'n yer page’s frontmatter:\n​ toml yaml json +++ disableMathJax = false +++ --- disableMathJax: false --- { \"disableMathJax\": false } See th' example on how it makes us'n math really easy.\nExamples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Right Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If ye delimit yer formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence Ye can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Passthrough This works fer block as well as inline math but be only avail'ble if ye be us'n th' passthrough configurat'n.\nWit' passthrough configurat'n ye can just drop yer math without enclosed by shorrrtcodes or codefences but no sett'ns from th' parameter t'ble be avail'ble.\n$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$$$\\left| \\begin{array}{cc} a \u0026 b \\\\ c \u0026 d \\end{array}\\right|$$ Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", "description": "Beaut'fl math and chemical formulae", - "tags": null, + "tags": [], "title": "Math", "uri": "/hugo-theme-relearn/pir/shortcodes/math/index.html" }, @@ -407,7 +409,7 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' mermaid shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Usage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Th' generated graphs can be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nParameter Name Default Notes align center Allowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' th' ship or th' planks frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files through a JSON object 'n yer hugo.toml, override these sett'ns per plank through yer planks frontmatter or override these sett'n per diagramm through diagram directives.\nTh' JSON object o' yer hugo.toml / frontmatter be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n hugo.toml, frontmatter or diagram directives.\nGlobal Configurat'n File hugo. toml yaml json [params] mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true params: mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true { \"params\": { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } } Page’s Frontmatter ​ toml yaml json +++ mermaidInitialize = '{ \"theme\": \"dark\" }' mermaidZoom = true +++ --- mermaidInitialize: '{ \"theme\": \"dark\" }' mermaidZoom: true --- { \"mermaidInitialize\": \"{ \\\"theme\\\": \\\"dark\\\" }\", \"mermaidZoom\": true } Examples Flowchart wit' YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- 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}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram wit' Configurat'n Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! Class Diagram wit' Codefence Rules ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned t' th' Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model wit' Non-Default Merrrmaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::ay'con(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003ean' features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid Timeline {{\u003c mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] Block Diagram {{\u003c mermaid \u003e}} block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one 'n th' middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px {{\u003c /mermaid \u003e}} block-beta columns 1 db((\"DB\")) blockArrowId6\u003c[\"\u0026nbsp;\u0026nbsp;\u0026nbsp;\"]\u003e(down) block:ID A B[\"A wide one 'n th' middle\"] C end space D ID --\u003e D C --\u003e D style B fill:#969,stroke:#333,stroke-width:4px ", "description": "Generrrat'n o' diagrrram an' flowcharrrt frrrom text 'n a similar manner as Marrrkdown", - "tags": null, + "tags": [], "title": "Merrrmaid", "uri": "/hugo-theme-relearn/pir/shortcodes/mermaid/index.html" }, @@ -415,15 +417,15 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Non-Hidden", "uri": "/hugo-theme-relearn/pir/tags/non-hidden/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Th' notice shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It be all about th' boxes.\" )}} Parameter Name Posit'n Default Notes style 1 default Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title 2 see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n box. Examples By Severity Ahoi wit' marrrkup {{% notice style=\"info\" %}} An **informat'n** disclaimer Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Ahoi An informat'n disclaimer\nYe can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\nAvast {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Avast A notice disclaimer\nSmarrrt Arrrse {{% notice style=\"tip\" %}} A **tip** disclaimer {{% /notice %}} Smarrrt Arrrse A tip disclaimer\nArrr {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr A warning disclaimer\nArrr wit' Non-Default Title an' Ay'con {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here be dragons A warning disclaimer\nArrr without a Title an' Ay'con {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary wit' Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary wit' Ay'con only {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen wit' Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey wit' Ay'con only {{% notice style=\"grey\" ay'con=\"bug\" %}} A **grey** disclaimer {{% /notice %}} A grey disclaimer\nOrange wit' Title an' Ay'con {{% notice style=\"orange\" title=\"Orange\" ay'con=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Orange A orange disclaimer\nRed without a Title an' Ay'con {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default wit' Positional Parameter {{% notice default \"Pay Attent'n t' this Avast!\" \"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nTransparent wit' Title an' Ay'con {{% notice style=\"transparent\" title=\"Pay Attent'n t' this Avast!\" ay'con=\"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nWit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% notice color=\"fuchsia\" title=\"**Hugo**\" ay'con=\"fa-fw fab fa-hackerrank\" %}} Victor? Be it ye? {{% /notice %}} Cap'n Hugo Victor? Be it ye?\n", + "content": "Th' notice shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.\nThere may be pirates It be all about th' boxes.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% notice style=\"primary\" title=\"There may be pirates\" ay'con=\"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It be all about th' boxes. {{% /notice %}} {{ partial \"shortcodes/notice.html\" (dict \"page\" . \"style\" \"primary\" \"title\" \"There may be pirates\" \"icon\" \"skull-crossbones\" \"content\" \"It be all about th' boxes.\" )}} Parameter Name Posit'n Default Notes style 1 default Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title 2 see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con 3 see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n box. Examples By Severity Ahoi wit' marrrkup {{% notice style=\"info\" %}} An **informat'n** disclaimer Ye can add standard markdown rules: - multiple paragraphs - bullet point lists - _emphasized_, **bold** an' even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) {{% /notice %}} Ahoi An informat'n disclaimer\nYe can add standard markdown rules:\nmultiple paragraphs bullet point lists emphasized, bold an' even bold emphasized text links etc. ...and even source code th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)\nAvast {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Avast A notice disclaimer\nSmarrrt Arrrse {{% notice style=\"tip\" %}} A **tip** disclaimer {{% /notice %}} Smarrrt Arrrse A tip disclaimer\nArrr {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Arrr A warning disclaimer\nArrr wit' Non-Default Title an' Ay'con {{% notice style=\"warning\" title=\"Here be dragons\" ay'con=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Here be dragons A warning disclaimer\nArrr without a Title an' Ay'con {{% notice style=\"warning\" title=\" \" ay'con=\" \" %}} A **warning** disclaimer {{% /notice %}} A warning disclaimer\nBy Brand Colors Primary wit' Title only {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Primary A primary disclaimer\nSecondary wit' Ay'con only {{% notice style=\"secondary\" ay'con=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} A secondary disclaimer\nAccent {{% notice style=\"accent\" %}} An **accent** disclaimer {{% /notice %}} An accent disclaimer\nBy Color Blue without a Title an' Ay'con {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} A blue disclaimer\nGreen wit' Title only {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Green A green disclaimer\nGrey wit' Ay'con only {{% notice style=\"grey\" ay'con=\"bug\" %}} A **grey** disclaimer {{% /notice %}} A grey disclaimer\nOrange wit' Title an' Ay'con {{% notice style=\"orange\" title=\"Orange\" ay'con=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Orange A orange disclaimer\nRed without a Title an' Ay'con {{% notice style=\"red\" %}} A **red** disclaimer {{% /notice %}} A red disclaimer\nBy Special Color Default wit' Positional Parameter {{% notice default \"Pay Attent'n t' this Avast!\" \"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nTransparent wit' Title an' Ay'con {{% notice style=\"transparent\" title=\"Pay Attent'n t' this Avast!\" ay'con=\"skull-crossbones\" %}} Some serious informat'n. {{% /notice %}} Pay Attent'n t' this Avast! Some serious informat'n.\nWit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% notice color=\"fuchsia\" title=\"**Hugo**\" ay'con=\"fa-fw fab fa-hackerrank\" %}} Victor? Be it ye? {{% /notice %}} Cap'n Hugo Victor? Be it ye?", "description": "Disclaimerrrs t' help ye strrructurrre yer plank", - "tags": null, + "tags": [], "title": "Notice", "uri": "/hugo-theme-relearn/pir/shortcodes/notice/index.html" }, @@ -431,7 +433,7 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": "Th' openapi shortcode uses th' Swagger UI library t' display yer OpenAPI / Swagger specificat'ns.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{\u003c openapi src=\"https://petstore3.openapi.io/api/v3/openapi.json\" \u003e}} {{ partial \"shortcodes/openapi.html\" (dict \"page\" . \"src\" \"https://petstore3.openapi.io/api/v3/openapi.json\" )}} Parameter Name Default Notes src \u003cempty\u003e Th' URL t' th' OpenAPI specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle. Avast If ye want t' print out (or generate a PDF) from yer OpenAPI documentat'n, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.\nInstead, open th' print preview 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.\nExample Us'n Local File {{\u003c openapi src=\"petstore.json\" \u003e}} ", "description": "Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns", - "tags": null, + "tags": [], "title": "OpenAPI", "uri": "/hugo-theme-relearn/pir/shortcodes/openapi/index.html" }, @@ -440,8 +442,8 @@ var relearn_search_index = [ "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 (headless) plank 1-1-3 ", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 1-1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html" @@ -451,8 +453,8 @@ var relearn_search_index = [ "content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1 ", "description": "This be a hidden demo child plank", "tags": [ - "children", - "the hidden" + "Children", + "hush, matey" ], "title": "plank 1-1-1 (hidden)", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" @@ -462,8 +464,8 @@ var relearn_search_index = [ "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": "This be a non-hidden demo child plank o' a hidden parrrent plank", "tags": [ - "children", - "the hidden" + "Children", + "hush, matey" ], "title": "plank 1-1-1-1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html" @@ -473,96 +475,96 @@ var relearn_search_index = [ "content": "This be a hidden demo child plank. This plank an' all its children be hidden 'n th' menu, arrow navigat'n an' children shortcode as long as ye aren’t view'n this plank or its children directly.\nSubpages o' this plank plank 1-1-1-1-1-1 ", "description": "This be a hidden demo child plank", "tags": [ - "children", - "the hidden" + "Children", + "hush, matey" ], "title": "plank 1-1-1-1-1 (hidden)", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-1 (hidden) \u003e plank 1-1-1-1 \u003e plank 1-1-1-1-1 (hidden)", - "content": "This be a non-hidden demo child plank o' a hidden parent plank.\n", + "content": "This be a non-hidden demo child plank o' a hidden parent plank.", "description": "This be a non-hidden demo child plank on a hidden parrrent plank", "tags": [ - "children", - "the hidden" + "Children", + "hush, matey" ], "title": "plank 1-1-1-1-1-1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-2 (headless)", - "content": "This be a plain demo child plank.\n", + "content": "This be a plain demo child plank.", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 1-1-2-1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1 \u003e plank 1-1-2 (headless)", - "content": "This be a plain demo child plank.\n", + "content": "This be a plain demo child plank.", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 1-1-2-2", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 1 \u003e plank 1-1", - "content": "This be a plain demo child plank.\n", + "content": "This be a plain demo child plank.", "description": "This be a demo child plank", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 1-1-3", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" }, { "breadcrumb": "Shorrrtcodes \u003e Children \u003e plank 3", - "content": "This be a plain demo child plank.\n", + "content": "This be a plain demo child plank.", "description": "This be a plain plank test nested 'n a parrrent", "tags": [ - "children", - "non-hidden" + "Children", + "Non-Hidden" ], "title": "plank 3-1", "uri": "/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": " Attachments hugo.png (17 KB) MaybeTreasure.txt (31 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Th' resources shortcode displays th' titles o' resources contained 'n a plank bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features be not supported directly by th' shortcode but rely on Hugo’s handl'n fer resource translat'ns applied when th' theme iterates over all avail'ble resources.\nParameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Resources\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' resources by name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Examples Custom Title, List o' Resources End'n 'n png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Ahoi Styled Box, Descend'n Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Ahoi Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% resources color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title an' Ay'cons For further examples fer style, color, title an' ay'con, see th' notice shortcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.\n", + "content": " Attachments hugo.png (17 KB) MaybeTreasure.txt (31 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Th' resources shortcode displays th' titles o' resources contained 'n a plank bundle.\nAttachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% resources sort=\"asc\" /%}} {{ partial \"shortcodes/resources.html\" (dict \"page\" . \"sort\" \"asc\" )}} Multilanguage features be not supported directly by th' shortcode but rely on Hugo’s handl'n fer resource translat'ns applied when th' theme iterates over all avail'ble resources.\nParameter Name Default Notes style transparent Th' style scheme used fer th' box.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary text fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: Resources\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: paperclip\nIf ye want no ay'con, ye have t' set this parameter t' \" \" (a non empty d wit' spaces) sort asc Sort'n th' output 'n ascend'n or descend'n order. pattern .* A regular expressions, used t' filter th' resources by name. For example:\n- t' match a file suffix o' ‘jpg’, use .*\\.jpg (not *.\\.jpg)\n- t' match file names end'n 'n jpg or png, use .*\\.(jpg|png) Examples Custom Title, List o' Resources End'n 'n png, jpg or gif {{% resources title=\"Related **files**\" pattern=\".*\\.(png|jpg|gif)\" /%}} Related files hugo.png (17 KB) Ahoi Styled Box, Descend'n Sort Order {{% resources style=\"info\" sort=\"desc\" /%}} Ahoi Treasure.pir.txt (31 B) NoTreasure.en.txt (23 B) MaybeTreasure.txt (23 B) hugo.png (17 KB) Wit' User-Defined Color an' Font Awesome Brand Ay'con {{% resources color=\"fuchsia\" ay'con=\"fa-fw fab fa-hackerrank\" /%}} Attachments hugo.png (17 KB) MaybeTreasure.txt (23 B) NoTreasure.en.txt (23 B) Treasure.pir.txt (31 B) Style, Color, Title an' Ay'cons For further examples fer style, color, title an' ay'con, see th' notice shortcode documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.", "description": "List Rrresources shorrrtcode contained in a plank bundle", - "tags": null, + "tags": [], "title": "Resources", "uri": "/hugo-theme-relearn/pir/shortcodes/resources/index.html" }, { "breadcrumb": "Development", - "content": "Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns\nCommon Creat'n:\nUse English translat'n Empty search Remove history checkmarks but leave it on th' plank thats used fer th' screenshot Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n Demo Screenshot Rrrambl'n:\nA meaningful full-screen screenshot o' an interest'n plank.\nTh' rrrambl'n should be:\ntimeless: not show'n any dates or often edited rrrambl'n interest'n: show a bunch o' interest'n elements like head'ns, code, etc balanced: no clutter'n wit' overpresent elements or color'n aligned: aligned outlines Used by:\nCap'n Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Plank URL: Screenshot Link\nCreat'n:\nsave as images/screenshot.png Remarks:\nTh' locat'n be mandatory due t' Hugo’s theme ship builder.\nPreview images/screenshot.png:\nHero Image Rrrambl'n:\nShow th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.\nTh' rrrambl'n should be:\nconsistent: always use th' same plank fer all devices pleas'n: use a delightful background Used by:\nCap'n Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Cap'n Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project ship: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/sett'ns 1280 x 640 Plank URL: Hero Image Link\nCreat'n:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize t' 2700 x 1800 centered, scale t' 900 x 600 an' save as images/tn.png From original template size resize t' 3000 x 1500 offset y: -330, scale t' 1280 x 640 an' save as images/hero.png Remarks:\nTh' locat'n o' images/tn.png be mandatory due t' Hugo’s theme ship builder.\nPreview images/hero.png:\nPreview images/tn.png:\n", + "content": "Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns\nCommon Creat'n:\nUse English translat'n Empty search Remove history checkmarks but leave it on th' plank thats used fer th' screenshot Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n Demo Screenshot Rrrambl'n:\nA meaningful full-screen screenshot o' an interest'n plank.\nTh' rrrambl'n should be:\ntimeless: not show'n any dates or often edited rrrambl'n interest'n: show a bunch o' interest'n elements like head'ns, code, etc balanced: no clutter'n wit' overpresent elements or color'n aligned: aligned outlines Used by:\nCap'n Hugo Themes info: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1000 x 1500 @ 1 Plank URL: Screenshot Link\nCreat'n:\nsave as images/screenshot.png Remarks:\nTh' locat'n be mandatory due t' Hugo’s theme ship builder.\nPreview images/screenshot.png:\nHero Image Rrrambl'n:\nShow th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.\nTh' rrrambl'n should be:\nconsistent: always use th' same plank fer all devices pleas'n: use a delightful background Used by:\nCap'n Hugo Themes gallery: https://themes.gohugo.io/tags/docs/ 900 x 600 Cap'n Hugo Themes notes: https://themes.gohugo.io/themes/hugo-theme-relearn/ 1280 x 640 GitHub project ship: https://github.com/McShelby/hugo-theme-relearn 1280 x 640 GitHub social media preview: https://github.com/McShelby/hugo-theme-relearn/sett'ns 1280 x 640 Plank URL: Hero Image Link\nCreat'n:\nTemplate: http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase Desktop: light theme 1440 x 900 @ 1 Tablet: light theme 778 x 1038 @ 1 Phone: dark theme 450 x 801 @ .666 From original template size resize t' 2700 x 1800 centered, scale t' 900 x 600 an' save as images/tn.png From original template size resize t' 3000 x 1500 offset y: -330, scale t' 1280 x 640 an' save as images/hero.png Remarks:\nTh' locat'n o' images/tn.png be mandatory due t' Hugo’s theme ship builder.\nPreview images/hero.png:\nPreview images/tn.png:", "description": "Recipe t' create various documentat'n scrrreenshots", - "tags": null, + "tags": [], "title": "Scrrrenshots", "uri": "/hugo-theme-relearn/pir/dev/screenshots/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Th' siteparam shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested parameter wit' Marrrkdown an' HTML formatt'n T' use formatted parameter, add this 'n yer hugo.toml:\nhugo. toml yaml json [marrrkup] [marrrkup.goldmark] [marrrkup.goldmark.renderer] unsafe = true marrrkup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values contain'n Marrrkdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatt'n { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n\n", + "content": "Th' siteparam shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}\nNested parameter wit' Marrrkdown an' HTML formatt'n T' use formatted parameter, add this 'n yer hugo.toml:\nhugo. toml yaml json [marrrkup] [marrrkup.goldmark] [marrrkup.goldmark.renderer] unsafe = true marrrkup: goldmark: renderer: unsafe: true { \"markup\": { \"goldmark\": { \"renderer\": { \"unsafe\": true } } } } Now values contain'n Marrrkdown will be formatted correctly.\nhugo. toml yaml json [params] [params.siteparam] [params.siteparam.test] text = 'A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting' params: siteparam: test: text: A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatt'n { \"params\": { \"siteparam\": { \"test\": { \"text\": \"A **nested** parameter \\u003cb\\u003ewith\\u003c/b\\u003e formatting\" } } } } Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n", "description": "Get value o' ship parrrams varrriables 'n yer plank", - "tags": null, + "tags": [], "title": "SiteParam", "uri": "/hugo-theme-relearn/pir/shortcodes/siteparam/index.html" }, { "breadcrumb": "Shorrrtcodes", - "content": "Ye can use a tab shortcode t' display a single tab.\nThis be especially useful if ye want t' flag yer code example wit' an explicit language.\nIf ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs shortcode.\n​ c printf(\"Hello World!\"); Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) )}} Parameter Name Default Notes style see notes Th' style scheme used fer th' tab. If ye don’t set a style an' ye display a single code block inside o' th' tab, its default styl'n will adapt t' that o' a code block. Otherwise default be used.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary title fer th' tab. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n th' tab. Examples Single Code Block wit' Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Marrrkdown Rrrambl'n {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **an'** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text an' code will get a margin.\nprintf(\"Hello World!\"); Understand'n style an' color Behavior Th' style parameter affects how th' color parameter be applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} Th' `style` parameter be set t' a color style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only th' `color` parameter be set. This will set th' background t' a lighter version o' th' chosen CSS color value. {{% /tab %}} {{% tab title=\"default style an' color\" style=\"default\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. Th' `default` style will set th' background t' yer `--MAIN-BG-color` as configured fer yer theme variant resembl'n th' default style but wit' different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} Th' `style` parameter be set t' a severity style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con. {{% /tab %}} {{% tab title=\"severity style an' color\" style=\"info\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. This will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style an' color just severity style severity style an' color Th' style parameter be set t' a color style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant.\nOnly th' color parameter be set.\nThis will set th' background t' a lighter version o' th' chosen CSS color value.\nTh' style parameter affects how th' color parameter be applied.\nTh' default style will set th' background t' yer --MAIN-BG-color as configured fer yer theme variant resembl'n th' default style but wit' different color.\nTh' style parameter be set t' a severity style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con.\nTh' style parameter affects how th' color parameter be applied.\nThis will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con.\n", + "content": "Ye can use a tab shortcode t' display a single tab.\nThis be especially useful if ye want t' flag yer code example wit' an explicit language.\nIf ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs shortcode.\n​ c printf(\"Hello World!\"); Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% tab title=\"c\" %}} ```c printf(\"Hello World!\"); ``` {{% /tab %}} {{ partial \"shortcodes/tab.html\" (dict \"page\" . \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) )}} Parameter Name Default Notes style see notes Th' style scheme used fer th' tab. If ye don’t set a style an' ye display a single code block inside o' th' tab, its default styl'n will adapt t' that o' a code block. Otherwise default be used.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color title see notes Arbitrary title fer th' tab. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) \u003ccontent\u003e \u003cempty\u003e Arbitrary text t' be displayed 'n th' tab. Examples Single Code Block wit' Collapsed Margins {{% tab title=\"Code\" %}} ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Code printf(\"Hello World!\"); Mixed Marrrkdown Rrrambl'n {{% tab title=\"_**Mixed**_\" %}} A tab can not only contain code but arbitrary text. In this case text **an'** code will get a margin. ```python printf(\"Hello World!\"); ``` {{% /tab %}} ​ Mixed A tab can not only contain code but arbitrary text. In this case text an' code will get a margin.\nprintf(\"Hello World!\"); Understand'n style an' color Behavior Th' style parameter affects how th' color parameter be applied.\n{{\u003c tabs \u003e}} {{% tab title=\"just colored style\" style=\"blue\" %}} Th' `style` parameter be set t' a color style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant. {{% /tab %}} {{% tab title=\"just color\" color=\"blue\" %}} Only th' `color` parameter be set. This will set th' background t' a lighter version o' th' chosen CSS color value. {{% /tab %}} {{% tab title=\"default style an' color\" style=\"default\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. Th' `default` style will set th' background t' yer `--MAIN-BG-color` as configured fer yer theme variant resembl'n th' default style but wit' different color. {{% /tab %}} {{% tab title=\"just severity style\" style=\"info\" %}} Th' `style` parameter be set t' a severity style. This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con. {{% /tab %}} {{% tab title=\"severity style an' color\" style=\"info\" color=\"blue\" %}} Th' `style` parameter affects how th' `color` parameter be applied. This will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con. {{% /tab %}} {{\u003c /tabs \u003e}} ​ just colored style just color default style an' color just severity style severity style an' color Th' style parameter be set t' a color style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant.\nOnly th' color parameter be set.\nThis will set th' background t' a lighter version o' th' chosen CSS color value.\nTh' style parameter affects how th' color parameter be applied.\nTh' default style will set th' background t' yer --MAIN-BG-color as configured fer yer theme variant resembl'n th' default style but wit' different color.\nTh' style parameter be set t' a severity style.\nThis will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con.\nTh' style parameter affects how th' color parameter be applied.\nThis will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con.", "description": "Show rrrambl'n 'n a single tab", - "tags": null, + "tags": [], "title": "Tab", "uri": "/hugo-theme-relearn/pir/shortcodes/tab/index.html" }, @@ -570,15 +572,15 @@ var relearn_search_index = [ "breadcrumb": "Shorrrtcodes", "content": "Th' tabs shortcode displays arbitrary rrrambl'n 'n an unlimited number o' tabs.\nThis comes 'n handy eg. fer provid'n code snippets fer multiple languages.\nIf ye just want a single tab ye can instead call th' tab shortcode standalone.\nhello. py sh c print(\"Hello World!\") echo \"Hello World!\" printf(\"Hello World!\"); Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\nSee th' tab shortcode fer a descript'n o' th' parameter fer nested tabs.\n​ shortcode partial {{\u003c tabs title=\"hello.\" \u003e}} {{% tab title=\"py\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"sh\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{% tab title=\"c\" %}} ```c printf\"Hello World!\"); ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{ partial \"shortcodes/tabs.html\" (dict \"page\" . \"title\" \"hello.\" \"content\" (slice (dict \"title\" \"py\" \"content\" (\"```python\\nprint(\\\"Hello World!\\\")\\n```\" | .RenderStr'n) ) (dict \"title\" \"sh\" \"content\" (\"```bash\\necho \\\"Hello World!\\\"\\n```\" | .RenderStr'n) ) (dict \"title\" \"c\" \"content\" (\"```c\\nprintf(\\\"Hello World!\\\");\\n```\" | .RenderStr'n) ) ) )}} Parameter Name Default Notes groupid \u003crandom\u003e Arbitrary name o' th' group th' tab view belongs t'.\nTab views wit' th' same groupid sychr'nize their selected tab. Th' tab select'n be restored automatically based on th' groupid fer tab view. If th' selected tab can not be found 'n a tab group th' first tab be selected instead.\nThis sychronizat'n applies t' th' whole ship! style \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. color \u003cempty\u003e Sets a default value fer every contained tab. Can be overridden by each tab. See th' tab shortcode fer poss'ble values. title \u003cempty\u003e Arbitrary title written 'n front o' th' tab view. ay'con \u003cempty\u003e Font Awesome ay'con name set t' th' left o' th' title. \u003ccontent\u003e \u003cempty\u003e Arbitrary number o' tabs defined wit' th' tab sub-shortcode. Examples Behavior o' th' groupid See what happens t' th' tab views while ye select different tabs.\nWhile press'n a tab o' Group A switches all tab views o' Group A 'n sync (if th' tab be available), th' tabs o' Group B be left untouched.\n​ Group A, Tab View 1 Group A, Tab View 2 Group B {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"_**XML**_ stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab title=\"text\" %}} Hello World {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"a\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c tabs groupid=\"b\" \u003e}} {{% tab title=\"json\" %}} {{\u003c highlight json \"linenos=true\" \u003e}} { \"Hello\": \"World\" } {{\u003c /highlight \u003e}} {{% /tab %}} {{% tab title=\"XML stuff\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{\u003c /tabs \u003e}} Group A, Tab View 1 ​ json XML stuff text 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello World Group A, Tab View 2 ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Group B ​ json XML stuff 1{ \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Nested Tab Views an' Color In case ye want t' nest tab views, th' parent tab that contains nested tab views needs t' be declared wit' {{\u003c tab \u003e}} instead o' {{% tab %}}. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' parent tab.\nYe can also set style an' color parameter fer all tabs an' overwrite them on tab level. See th' tab shortcode fer poss'ble values.\n{{\u003c tabs groupid=\"main\" style=\"primary\" title=\"Rationale\" ay'con=\"thumbtack\" \u003e}} {{\u003c tab title=\"Text\" \u003e}} Simple text be poss'ble here... {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} Python be **super** easy. - most o' th' time. - if ye don't want t' output unicode {{% /tab %}} {{% tab title=\"bash\" %}} Bash be fer **hackers**. {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c tab title=\"Code\" style=\"default\" color=\"darkorchid\" \u003e}} ...but no markdown {{\u003c tabs groupid=\"tabs-example-language\" \u003e}} {{% tab title=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab title=\"bash\" %}} ```bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} {{\u003c /tab \u003e}} {{\u003c /tabs \u003e}} Rationale Text Code Simple text be poss'ble here... ​ python bash Python be super easy.\nmost o' th' time. if ye don’t want t' output unicode Bash be fer hackers.\n...but no markdown ​ python bash print(\"Hello World!\") echo \"Hello World!\" ", "description": "Synchr'nize select'n o' content 'n different tabbed views", - "tags": null, + "tags": [], "title": "Tabs", "uri": "/hugo-theme-relearn/pir/shortcodes/tabs/index.html" }, { "breadcrumb": "", - "content": "Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.\n", + "content": "Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.", "description": "Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo.", - "tags": null, + "tags": [], "title": "Tag-a-taggs", "uri": "/hugo-theme-relearn/pir/tags/index.html" }, @@ -586,7 +588,7 @@ var relearn_search_index = [ "breadcrumb": "Categorrries", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrry :: Taxonomy", "uri": "/hugo-theme-relearn/pir/categories/taxonomy/index.html" }, @@ -594,7 +596,7 @@ var relearn_search_index = [ "breadcrumb": "Categorrries", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Categorrry :: Theming", "uri": "/hugo-theme-relearn/pir/categories/theming/index.html" }, @@ -602,7 +604,7 @@ var relearn_search_index = [ "breadcrumb": "Tag-a-taggs", "content": "", "description": "", - "tags": null, + "tags": [], "title": "Tagga :: Tutorrrial", "uri": "/hugo-theme-relearn/pir/tags/tutorrrial/index.html" } diff --git a/pir/index.xml b/pir/index.xml index e9776b7c5e..c0e36e44ea 100644 --- a/pir/index.xml +++ b/pir/index.xml @@ -3,7 +3,7 @@ Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/index.html - Recent content on Cap'n Hugo Relearrrn Theme + A theme fer Cap'n Hugo designed fer documentat'n. Hugo art-pir diff --git a/pir/more/credits/index.html b/pir/more/credits/index.html index 8ecb9d423c..e26eb90e4e 100644 --- a/pir/more/credits/index.html +++ b/pir/more/credits/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/more/credits/index.print.html b/pir/more/credits/index.print.html index 45b49e04a4..3be4099a5b 100644 --- a/pir/more/credits/index.print.html +++ b/pir/more/credits/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/more/credits/index.xml b/pir/more/credits/index.xml index 1a2c601e79..2ff7b670bf 100644 --- a/pir/more/credits/index.xml +++ b/pir/more/credits/index.xml @@ -1,9 +1,9 @@ - Crrredits on Cap'n Hugo Relearrrn Theme + Crrredits :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/more/credits/index.html - Recent content in Crrredits on Cap'n Hugo Relearrrn Theme + Contributors Special thanks t' everyone who has contributed t' this project. Hugo art-pir diff --git a/pir/search.html b/pir/search.html index 34a0b3c52f..1d4ff2d433 100644 --- a/pir/search.html +++ b/pir/search.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index b9a18a6764..8901401923 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.print.html b/pir/shortcodes/attachments/index.print.html index fcca881433..37f116f687 100644 --- a/pir/shortcodes/attachments/index.print.html +++ b/pir/shortcodes/attachments/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/attachments/index.xml b/pir/shortcodes/attachments/index.xml index a04d137d4e..4f34d46cff 100644 --- a/pir/shortcodes/attachments/index.xml +++ b/pir/shortcodes/attachments/index.xml @@ -1,9 +1,9 @@ - Attachments on Cap'n Hugo Relearrrn Theme + Attachments :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/index.html - Recent content in Attachments on Cap'n Hugo Relearrrn Theme + Th' Attachments shorrrtcode displays a list o' files attached t' a plank Hugo art-pir diff --git a/pir/shortcodes/badge/index.html b/pir/shortcodes/badge/index.html index 1aa96b1cd1..8131efe2fc 100644 --- a/pir/shortcodes/badge/index.html +++ b/pir/shortcodes/badge/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/badge/index.print.html b/pir/shortcodes/badge/index.print.html index 600f80cb39..e093c67774 100644 --- a/pir/shortcodes/badge/index.print.html +++ b/pir/shortcodes/badge/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/badge/index.xml b/pir/shortcodes/badge/index.xml index e2f796a56b..d04638f853 100644 --- a/pir/shortcodes/badge/index.xml +++ b/pir/shortcodes/badge/index.xml @@ -1,9 +1,9 @@ - Badge on Cap'n Hugo Relearrrn Theme + Badge :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/badge/index.html - Recent content in Badge on Cap'n Hugo Relearrrn Theme + Marker badges t' display 'n yer text Hugo art-pir diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index 4af4fc64e2..5d56219e5d 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/button/index.print.html b/pir/shortcodes/button/index.print.html index d25e6820f1..48421b3ef2 100644 --- a/pir/shortcodes/button/index.print.html +++ b/pir/shortcodes/button/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/button/index.xml b/pir/shortcodes/button/index.xml index 11db438fdc..af2315fb33 100644 --- a/pir/shortcodes/button/index.xml +++ b/pir/shortcodes/button/index.xml @@ -1,9 +1,9 @@ - Button on Cap'n Hugo Relearrrn Theme + Button :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/button/index.html - Recent content in Button on Cap'n Hugo Relearrrn Theme + Nice buttons on yer plank Hugo art-pir 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 6d767f8914..1b274f5ee9 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index 0a3a304157..6bde03cef6 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.print.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.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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.xml 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.xml index 8668d1420d..e4c5fdea94 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.xml +++ 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.xml @@ -1,9 +1,9 @@ - plank 1-1-1-1-1-1 on Cap'n Hugo Relearrrn Theme + plank 1-1-1-1-1-1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html - Recent content in plank 1-1-1-1-1-1 on Cap'n Hugo Relearrrn Theme + This be a non-hidden demo child plank on a hidden parrrent plank Hugo art-pir 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 4c10e63b91..b2dbeccc33 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index 2a0e64ded5..2505e5a196 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.print.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.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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.xml 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.xml index cd219719c4..e7771578ad 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.xml +++ 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.xml @@ -1,9 +1,9 @@ - plank 1-1-1-1-1 (hidden) on Cap'n Hugo Relearrrn Theme + plank 1-1-1-1-1 (hidden) :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html - Recent content in plank 1-1-1-1-1 (hidden) on Cap'n Hugo Relearrrn Theme + This be a hidden demo child plank Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html - This be a non-hidden demo child plank o' a hidden parent plank. + This be a non-hidden demo child plank on a hidden parrrent plank \ 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 b82f6221f9..5c155b1c69 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html index a93c28d55e..c03b47f450 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml index 8637d79823..47f3fd4007 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml @@ -1,9 +1,9 @@ - plank 1-1-1-1 on Cap'n Hugo Relearrrn Theme + plank 1-1-1-1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html - Recent content in plank 1-1-1-1 on Cap'n Hugo Relearrrn Theme + This be a non-hidden demo child plank o' a hidden parrrent plank Hugo art-pir 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 908c52fbd8..f404fdcd4c 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html index 71b3269fc3..91475fe52b 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml index 01fe39e5bc..fccd4f6410 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml @@ -1,9 +1,9 @@ - plank 1-1-1 (hidden) on Cap'n Hugo Relearrrn Theme + plank 1-1-1 (hidden) :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html - Recent content in plank 1-1-1 (hidden) on Cap'n Hugo Relearrrn Theme + This be a hidden demo child plank Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html - This be a non-hidden demo child plank o' a hidden parent plank wit' a hidden child. + This be a non-hidden demo child plank o' a hidden parrrent plank \ 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 df0e2ca880..fd829431c7 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html index 3e3f74b40d..c8138419db 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml index e66bffb64e..ce0ab037d0 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml @@ -1,9 +1,9 @@ - plank 1-1-2-1 on Cap'n Hugo Relearrrn Theme + plank 1-1-2-1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - Recent content in plank 1-1-2-1 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir 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 74c7713319..cefd75f40b 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html index c8dc90d965..0130cedfd6 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml index 8e273c1fd1..b6f28734eb 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml @@ -1,9 +1,9 @@ - plank 1-1-2-2 on Cap'n Hugo Relearrrn Theme + plank 1-1-2-2 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - Recent content in plank 1-1-2-2 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir 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 a4db6e9403..3736fb5d6f 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html index 73b43d24f9..c0e6ebacba 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml index cde23e46bf..cc8e8b6662 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml @@ -1,9 +1,9 @@ - plank 1-1-3 on Cap'n Hugo Relearrrn Theme + plank 1-1-3 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - Recent content in plank 1-1-3 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir 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 3dc6031557..6569eb5756 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/index.print.html index 6f489c31fb..818d002528 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.xml b/pir/shortcodes/children/children-1/children-1-1/index.xml index 6567c9c478..c60133a9d9 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.xml +++ b/pir/shortcodes/children/children-1/children-1-1/index.xml @@ -1,9 +1,9 @@ - plank 1-1 on Cap'n Hugo Relearrrn Theme + plank 1-1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html - Recent content in plank 1-1 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This be a plain demo child plank. + This be a demo child plank \ 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 fcffea3d11..8c2214b117 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/index.print.html b/pir/shortcodes/children/children-1/index.print.html index dc79232f70..f5cf412bac 100644 --- a/pir/shortcodes/children/children-1/index.print.html +++ b/pir/shortcodes/children/children-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/index.xml b/pir/shortcodes/children/children-1/index.xml index a8501b7bbd..5803608695 100644 --- a/pir/shortcodes/children/children-1/index.xml +++ b/pir/shortcodes/children/children-1/index.xml @@ -1,9 +1,9 @@ - plank 1 on Cap'n Hugo Relearrrn Theme + plank 1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html - Recent content in plank 1 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html - This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search. + This be a demo child plank \ 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 99250b3d66..22b1c52cc6 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -33,18 +33,18 @@ So its rrrambl'n be used as descript'n."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-2/index.print.html b/pir/shortcodes/children/children-2/index.print.html index e17a115282..d73d4f2aa4 100644 --- a/pir/shortcodes/children/children-2/index.print.html +++ b/pir/shortcodes/children/children-2/index.print.html @@ -33,19 +33,19 @@ So its rrrambl'n be used as descript'n."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-2/index.xml b/pir/shortcodes/children/children-2/index.xml index 2f828004bd..36713be3df 100644 --- a/pir/shortcodes/children/children-2/index.xml +++ b/pir/shortcodes/children/children-2/index.xml @@ -1,9 +1,9 @@ - plank 2 on Cap'n Hugo Relearrrn Theme + plank 2 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-2/index.html - Recent content in plank 2 on Cap'n Hugo Relearrrn Theme + This be a demo child plank wit' no descript'n. So its rrrambl'n be used as descript'n. Hugo art-pir diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 555faab0f2..2bdf8269df 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/index.print.html b/pir/shortcodes/children/children-3/index.print.html index 30671dbe13..5d5c2d1f96 100644 --- a/pir/shortcodes/children/children-3/index.print.html +++ b/pir/shortcodes/children/children-3/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/index.xml b/pir/shortcodes/children/children-3/index.xml index 0d3950549a..99b9e99a64 100644 --- a/pir/shortcodes/children/children-3/index.xml +++ b/pir/shortcodes/children/children-3/index.xml @@ -1,9 +1,9 @@ - plank 3 on Cap'n Hugo Relearrrn Theme + plank 3 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html - Recent content in plank 3 on Cap'n Hugo Relearrrn Theme + This be a demo child plank Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html - This be a plain demo child plank. + This be a plain plank test nested 'n a parrrent \ 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 3a90962cb8..4671534e2c 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -17,7 +17,7 @@ - + @@ -32,18 +32,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.print.html b/pir/shortcodes/children/children-3/test3/index.print.html index 840a97e61b..83143cc572 100644 --- a/pir/shortcodes/children/children-3/test3/index.print.html +++ b/pir/shortcodes/children/children-3/test3/index.print.html @@ -17,7 +17,7 @@ - + @@ -32,19 +32,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.xml b/pir/shortcodes/children/children-3/test3/index.xml index ca509b8ca0..197da5a001 100644 --- a/pir/shortcodes/children/children-3/test3/index.xml +++ b/pir/shortcodes/children/children-3/test3/index.xml @@ -1,9 +1,9 @@ - plank 3-1 on Cap'n Hugo Relearrrn Theme + plank 3-1 :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html - Recent content in plank 3-1 on Cap'n Hugo Relearrrn Theme + This be a plain plank test nested 'n a parrrent Hugo art-pir diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index cbba4dd507..9ef5138ba6 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-4/index.print.html b/pir/shortcodes/children/children-4/index.print.html index e2d2880183..225b07f1e3 100644 --- a/pir/shortcodes/children/children-4/index.print.html +++ b/pir/shortcodes/children/children-4/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-4/index.xml b/pir/shortcodes/children/children-4/index.xml index 5b4d812754..6555408e9a 100644 --- a/pir/shortcodes/children/children-4/index.xml +++ b/pir/shortcodes/children/children-4/index.xml @@ -1,9 +1,9 @@ - plank 4 (hidden) on Cap'n Hugo Relearrrn Theme + plank 4 (hidden) :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-4/index.html - Recent content in plank 4 (hidden) on Cap'n Hugo Relearrrn Theme + This be a hidden demo child plank Hugo art-pir diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index 93d1829f7e..fc0b352b11 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/index.print.html b/pir/shortcodes/children/index.print.html index d56e56cf65..233ddeda90 100644 --- a/pir/shortcodes/children/index.print.html +++ b/pir/shortcodes/children/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/index.xml b/pir/shortcodes/children/index.xml index 45352a7f34..d72ef0e637 100644 --- a/pir/shortcodes/children/index.xml +++ b/pir/shortcodes/children/index.xml @@ -1,9 +1,9 @@ - Children on Cap'n Hugo Relearrrn Theme + Children :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/index.html - Recent content in Children on Cap'n Hugo Relearrrn Theme + List th' child planks on a plank Hugo art-pir @@ -12,14 +12,14 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/test/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/test/index.html - This be a plain demo child plank. + This be a plain plank test, an' th' beginn'n o' a YAML multiline description… plank 1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html - This be a demo child plank. Subpages o' this plank plank 1-1 + This be a demo child plank plank 2 @@ -33,7 +33,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html - This be a demo child plank. Subpages o' this plank plank 3-1 + This be a demo child plank \ No newline at end of file diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index 1f4c41cefd..47272d9fba 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -5,27 +5,23 @@ - + - + - + - + - + @@ -35,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/test/index.print.html b/pir/shortcodes/children/test/index.print.html index 8449ce968e..498264aff0 100644 --- a/pir/shortcodes/children/test/index.print.html +++ b/pir/shortcodes/children/test/index.print.html @@ -5,27 +5,23 @@ - + - + - + - + - + @@ -35,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/test/index.xml b/pir/shortcodes/children/test/index.xml index 1bf9f3a697..44aff0a44f 100644 --- a/pir/shortcodes/children/test/index.xml +++ b/pir/shortcodes/children/test/index.xml @@ -1,9 +1,9 @@ - plank X on Cap'n Hugo Relearrrn Theme + plank X :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/test/index.html - Recent content in plank X on Cap'n Hugo Relearrrn Theme + This be a plain plank test, an' th' beginn'n o' a YAML multiline description… Hugo art-pir diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index 72d3837445..ab4732c93d 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/pir/shortcodes/expand/index.print.html b/pir/shortcodes/expand/index.print.html index 39c1004d1d..295e6603d2 100644 --- a/pir/shortcodes/expand/index.print.html +++ b/pir/shortcodes/expand/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/expand/index.xml b/pir/shortcodes/expand/index.xml index f79664617e..630a57edfe 100644 --- a/pir/shortcodes/expand/index.xml +++ b/pir/shortcodes/expand/index.xml @@ -1,9 +1,9 @@ - Expand on Cap'n Hugo Relearrrn Theme + Expand :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/index.html - Recent content in Expand on Cap'n Hugo Relearrrn Theme + Displays an expand'ble/collaps'ble sect'n o' text on yer plank Hugo art-pir diff --git a/pir/shortcodes/highlight/index.html b/pir/shortcodes/highlight/index.html index 6efb927cff..b72c461b85 100644 --- a/pir/shortcodes/highlight/index.html +++ b/pir/shortcodes/highlight/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/highlight/index.print.html b/pir/shortcodes/highlight/index.print.html index f6f2f05992..63a59b05b6 100644 --- a/pir/shortcodes/highlight/index.print.html +++ b/pir/shortcodes/highlight/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/highlight/index.xml b/pir/shortcodes/highlight/index.xml index 1af0ecdcd9..6ef195bcdd 100644 --- a/pir/shortcodes/highlight/index.xml +++ b/pir/shortcodes/highlight/index.xml @@ -1,9 +1,9 @@ - Highlight on Cap'n Hugo Relearrrn Theme + Highlight :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html - Recent content in Highlight on Cap'n Hugo Relearrrn Theme + Render code with a syntax highlighter Hugo art-pir diff --git a/pir/shortcodes/icon/index.html b/pir/shortcodes/icon/index.html index 5cc8676b0e..ddaa97bf36 100644 --- a/pir/shortcodes/icon/index.html +++ b/pir/shortcodes/icon/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/icon/index.print.html b/pir/shortcodes/icon/index.print.html index ab93f308fe..4286ab9556 100644 --- a/pir/shortcodes/icon/index.print.html +++ b/pir/shortcodes/icon/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/icon/index.xml b/pir/shortcodes/icon/index.xml index 06aa5ca331..0a3884629d 100644 --- a/pir/shortcodes/icon/index.xml +++ b/pir/shortcodes/icon/index.xml @@ -1,9 +1,9 @@ - Icon on Cap'n Hugo Relearrrn Theme + Icon :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/icon/index.html - Recent content in Icon on Cap'n Hugo Relearrrn Theme + Nice ay'cons fer yer plank Hugo art-pir diff --git a/pir/shortcodes/include/index.html b/pir/shortcodes/include/index.html index e00dae22f2..d363c4857e 100644 --- a/pir/shortcodes/include/index.html +++ b/pir/shortcodes/include/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/include/index.print.html b/pir/shortcodes/include/index.print.html index d4a4dd8703..04391a5cec 100644 --- a/pir/shortcodes/include/index.print.html +++ b/pir/shortcodes/include/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/include/index.xml b/pir/shortcodes/include/index.xml index 41086ce013..6a34156a4e 100644 --- a/pir/shortcodes/include/index.xml +++ b/pir/shortcodes/include/index.xml @@ -1,9 +1,9 @@ - Include on Cap'n Hugo Relearrrn Theme + Include :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/include/index.html - Recent content in Include on Cap'n Hugo Relearrrn Theme + Displays content from other Marrrkdown files Hugo art-pir diff --git a/pir/shortcodes/index.html b/pir/shortcodes/index.html index 766e9921db..c4e539266c 100644 --- a/pir/shortcodes/index.html +++ b/pir/shortcodes/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/index.print.html b/pir/shortcodes/index.print.html index 0f2ba0a42d..3c2fd9c3a5 100644 --- a/pir/shortcodes/index.print.html +++ b/pir/shortcodes/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - + - - + + - + diff --git a/pir/shortcodes/index.xml b/pir/shortcodes/index.xml index 78b23ddc53..9c1935d82d 100644 --- a/pir/shortcodes/index.xml +++ b/pir/shortcodes/index.xml @@ -1,9 +1,9 @@ - Shorrrtcodes on Cap'n Hugo Relearrrn Theme + Shorrrtcodes :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/index.html - Recent content in Shorrrtcodes on Cap'n Hugo Relearrrn Theme + Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Hugo art-pir @@ -12,105 +12,105 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/badge/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/badge/index.html - Th' badge shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con. + Marker badges t' display 'n yer text Button https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/button/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/button/index.html - Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con. + Nice buttons on yer plank Children https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/index.html - Th' children shortcode lists th' child planks o' th' current plank an' its descendants. + List th' child planks on a plank Expand https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/index.html - Th' expand shortcode displays an expandable/collaps'ble section o' text. Expand me… Thank ye! + Displays an expand'ble/collaps'ble sect'n o' text on yer plank Highlight https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html - Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. + Render code with a syntax highlighter Icon https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/icon/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/icon/index.html - Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library. + Nice ay'cons fer yer plank Include https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/include/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/include/index.html - Th' include shortcode includes other files from yer project inside o' th' current plank. + Displays content from other Marrrkdown files Math https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/math/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/math/index.html - Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. + Beaut'fl math and chemical formulae Merrrmaid https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/index.html - Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. + Generrrat'n o' diagrrram an' flowcharrrt frrrom text 'n a similar manner as Marrrkdown Notice https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/notice/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/notice/index.html - Th' notice shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank. + Disclaimerrrs t' help ye strrructurrre yer plank OpenAPI https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html - Th' openapi shortcode uses th' Swagger UI library t' display yer OpenAPI / Swagger specificat'ns. + Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns Resources https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html - Attachments hugo.png (17 KB) MaybeTreasure.txt (31 B) NoTreasure.en.txt (23 B) Treasure. + List Rrresources shorrrtcode contained in a plank bundle SiteParam https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html - Th' siteparam shortcode prints values o' ship params. Usage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or call this shortcode from yer own partials. + Get value o' ship parrrams varrriables 'n yer plank Tab https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tab/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tab/index.html - Ye can use a tab shortcode t' display a single tab. + Show rrrambl'n 'n a single tab Tabs https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tabs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tabs/index.html - Th' tabs shortcode displays arbitrary rrrambl'n 'n an unlimited number o' tabs. + Synchr'nize select'n o' content 'n different tabbed views \ No newline at end of file diff --git a/pir/shortcodes/math/index.html b/pir/shortcodes/math/index.html index 75a18b3a48..7f384bfdd8 100644 --- a/pir/shortcodes/math/index.html +++ b/pir/shortcodes/math/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + diff --git a/pir/shortcodes/math/index.print.html b/pir/shortcodes/math/index.print.html index 0330e5fdb7..89da042754 100644 --- a/pir/shortcodes/math/index.print.html +++ b/pir/shortcodes/math/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - + + diff --git a/pir/shortcodes/math/index.xml b/pir/shortcodes/math/index.xml index 56032422ee..c02d5a7ef9 100644 --- a/pir/shortcodes/math/index.xml +++ b/pir/shortcodes/math/index.xml @@ -1,9 +1,9 @@ - Math on Cap'n Hugo Relearrrn Theme + Math :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/math/index.html - Recent content in Math on Cap'n Hugo Relearrrn Theme + Beaut'fl math and chemical formulae Hugo art-pir diff --git a/pir/shortcodes/mermaid/index.html b/pir/shortcodes/mermaid/index.html index c95ab2de72..743d18822e 100644 --- a/pir/shortcodes/mermaid/index.html +++ b/pir/shortcodes/mermaid/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/shortcodes/mermaid/index.print.html b/pir/shortcodes/mermaid/index.print.html index 993513c353..02f92e8ab7 100644 --- a/pir/shortcodes/mermaid/index.print.html +++ b/pir/shortcodes/mermaid/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/shortcodes/mermaid/index.xml b/pir/shortcodes/mermaid/index.xml index 9f57556635..71c138034b 100644 --- a/pir/shortcodes/mermaid/index.xml +++ b/pir/shortcodes/mermaid/index.xml @@ -1,9 +1,9 @@ - Merrrmaid on Cap'n Hugo Relearrrn Theme + Merrrmaid :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/index.html - Recent content in Merrrmaid on Cap'n Hugo Relearrrn Theme + Generrrat'n o' diagrrram an' flowcharrrt frrrom text 'n a similar manner as Marrrkdown Hugo art-pir diff --git a/pir/shortcodes/notice/index.html b/pir/shortcodes/notice/index.html index e44699a891..4b6856517d 100644 --- a/pir/shortcodes/notice/index.html +++ b/pir/shortcodes/notice/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/notice/index.print.html b/pir/shortcodes/notice/index.print.html index 9aed5571eb..b9a173a062 100644 --- a/pir/shortcodes/notice/index.print.html +++ b/pir/shortcodes/notice/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/notice/index.xml b/pir/shortcodes/notice/index.xml index 003cc4a736..06876c8d32 100644 --- a/pir/shortcodes/notice/index.xml +++ b/pir/shortcodes/notice/index.xml @@ -1,9 +1,9 @@ - Notice on Cap'n Hugo Relearrrn Theme + Notice :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/notice/index.html - Recent content in Notice on Cap'n Hugo Relearrrn Theme + Disclaimerrrs t' help ye strrructurrre yer plank Hugo art-pir diff --git a/pir/shortcodes/openapi/index.html b/pir/shortcodes/openapi/index.html index 546d671b55..fe10f5dab3 100644 --- a/pir/shortcodes/openapi/index.html +++ b/pir/shortcodes/openapi/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + - - + + - + diff --git a/pir/shortcodes/openapi/index.print.html b/pir/shortcodes/openapi/index.print.html index 06291435e0..004bcdbd5b 100644 --- a/pir/shortcodes/openapi/index.print.html +++ b/pir/shortcodes/openapi/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + - - + + - + diff --git a/pir/shortcodes/openapi/index.xml b/pir/shortcodes/openapi/index.xml index a6112bbc7b..369024d6d8 100644 --- a/pir/shortcodes/openapi/index.xml +++ b/pir/shortcodes/openapi/index.xml @@ -1,9 +1,9 @@ - OpenAPI on Cap'n Hugo Relearrrn Theme + OpenAPI :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html - Recent content in OpenAPI on Cap'n Hugo Relearrrn Theme + Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns Hugo art-pir diff --git a/pir/shortcodes/resources/index.html b/pir/shortcodes/resources/index.html index fef38d99f5..65c8b58d9f 100644 --- a/pir/shortcodes/resources/index.html +++ b/pir/shortcodes/resources/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/resources/index.print.html b/pir/shortcodes/resources/index.print.html index e9c0fbf463..37677da4a8 100644 --- a/pir/shortcodes/resources/index.print.html +++ b/pir/shortcodes/resources/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/resources/index.xml b/pir/shortcodes/resources/index.xml index 1c5d425fc2..6f953fe880 100644 --- a/pir/shortcodes/resources/index.xml +++ b/pir/shortcodes/resources/index.xml @@ -1,9 +1,9 @@ - Resources on Cap'n Hugo Relearrrn Theme + Resources :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/resources/index.html - Recent content in Resources on Cap'n Hugo Relearrrn Theme + List Rrresources shorrrtcode contained in a plank bundle Hugo art-pir diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index 9861e477e4..d0d7098e10 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/siteparam/index.print.html b/pir/shortcodes/siteparam/index.print.html index 76f20b5bad..e52f1fdf29 100644 --- a/pir/shortcodes/siteparam/index.print.html +++ b/pir/shortcodes/siteparam/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/siteparam/index.xml b/pir/shortcodes/siteparam/index.xml index 14b477cf73..f4c21e757d 100644 --- a/pir/shortcodes/siteparam/index.xml +++ b/pir/shortcodes/siteparam/index.xml @@ -1,9 +1,9 @@ - SiteParam on Cap'n Hugo Relearrrn Theme + SiteParam :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html - Recent content in SiteParam on Cap'n Hugo Relearrrn Theme + Get value o' ship parrrams varrriables 'n yer plank Hugo art-pir diff --git a/pir/shortcodes/tab/index.html b/pir/shortcodes/tab/index.html index 28b7a21b29..5233e8a45f 100644 --- a/pir/shortcodes/tab/index.html +++ b/pir/shortcodes/tab/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/tab/index.print.html b/pir/shortcodes/tab/index.print.html index 3faa00eadb..f1c9904259 100644 --- a/pir/shortcodes/tab/index.print.html +++ b/pir/shortcodes/tab/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/tab/index.xml b/pir/shortcodes/tab/index.xml index 047f600c77..6357bf8389 100644 --- a/pir/shortcodes/tab/index.xml +++ b/pir/shortcodes/tab/index.xml @@ -1,9 +1,9 @@ - Tab on Cap'n Hugo Relearrrn Theme + Tab :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tab/index.html - Recent content in Tab on Cap'n Hugo Relearrrn Theme + Show rrrambl'n 'n a single tab Hugo art-pir diff --git a/pir/shortcodes/tabs/index.html b/pir/shortcodes/tabs/index.html index 0007f57248..d277982c67 100644 --- a/pir/shortcodes/tabs/index.html +++ b/pir/shortcodes/tabs/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/tabs/index.print.html b/pir/shortcodes/tabs/index.print.html index 957a54f0c9..59fb4fac5f 100644 --- a/pir/shortcodes/tabs/index.print.html +++ b/pir/shortcodes/tabs/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/tabs/index.xml b/pir/shortcodes/tabs/index.xml index 8e3be5f7cc..445c425918 100644 --- a/pir/shortcodes/tabs/index.xml +++ b/pir/shortcodes/tabs/index.xml @@ -1,9 +1,9 @@ - Tabs on Cap'n Hugo Relearrrn Theme + Tabs :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tabs/index.html - Recent content in Tabs on Cap'n Hugo Relearrrn Theme + Synchr'nize select'n o' content 'n different tabbed views Hugo art-pir diff --git a/pir/showcase/index.html b/pir/showcase/index.html index 502a032a6c..bd821b192e 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/showcase/index.print.html b/pir/showcase/index.print.html index 8f28d331f3..9624c308e9 100644 --- a/pir/showcase/index.print.html +++ b/pir/showcase/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/showcase/index.xml b/pir/showcase/index.xml index 0ded0989c3..8586c640c8 100644 --- a/pir/showcase/index.xml +++ b/pir/showcase/index.xml @@ -1,9 +1,9 @@ - Showcase on Cap'n Hugo Relearrrn Theme + Showcase :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/showcase/index.html - Recent content in Showcase on Cap'n Hugo Relearrrn Theme + Poésieland by Barbara Post A collect'n o' poems wit' requirements fer improved taxonomy support, adjusted menu width an' additional JavaScript dependencies. Hugo art-pir diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index 7be2c6ba03..7c56e8682e 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/children/index.xml b/pir/tags/children/index.xml index 9e6f8f1d47..8634843eed 100644 --- a/pir/tags/children/index.xml +++ b/pir/tags/children/index.xml @@ -1,9 +1,9 @@ - Children on Cap'n Hugo Relearrrn Theme + Children :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/children/index.html - Recent content in Children on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,14 +12,14 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/test/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/test/index.html - This be a plain demo child plank. + This be a plain plank test, an' th' beginn'n o' a YAML multiline description… plank 1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html - This be a demo child plank. Subpages o' this plank plank 1-1 + This be a demo child plank plank 2 @@ -33,42 +33,42 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html - This be a demo child plank. Subpages o' this plank plank 3-1 + This be a demo child plank plank 1-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html - This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search. + This be a demo child plank plank 1-1-2-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - This be a plain demo child plank. + This be a demo child plank plank 1-1-2-2 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - This be a plain demo child plank. + This be a demo child plank plank 1-1-3 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This be a plain demo child plank. + This be a demo child plank plank 3-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html - This be a plain demo child plank. + This be a plain plank test nested 'n a parrrent \ No newline at end of file diff --git a/pir/tags/config/index.html b/pir/tags/config/index.html index 993c0c97a3..8c50b4c452 100644 --- a/pir/tags/config/index.html +++ b/pir/tags/config/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/config/index.xml b/pir/tags/config/index.xml index 73901eb273..ee465c217a 100644 --- a/pir/tags/config/index.xml +++ b/pir/tags/config/index.xml @@ -1,9 +1,9 @@ - Config on Cap'n Hugo Relearrrn Theme + Config :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/config/index.html - Recent content in Config on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html - On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo. + On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo. \ No newline at end of file diff --git a/pir/tags/content/index.html b/pir/tags/content/index.html index d05314d1ad..daa9b50583 100644 --- a/pir/tags/content/index.html +++ b/pir/tags/content/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/content/index.xml b/pir/tags/content/index.xml index b1f3abf9d4..af6a20d462 100644 --- a/pir/tags/content/index.xml +++ b/pir/tags/content/index.xml @@ -1,9 +1,9 @@ - Content on Cap'n Hugo Relearrrn Theme + Content :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/content/index.html - Recent content in Content on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html - Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks. + Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks. \ No newline at end of file diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index 11ea2ae5b7..35652c84f0 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ Documentat'n :: Tagga :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/documentatn/index.xml b/pir/tags/documentatn/index.xml index 231f55b825..f0776c3de3 100644 --- a/pir/tags/documentatn/index.xml +++ b/pir/tags/documentatn/index.xml @@ -1,9 +1,9 @@ - Documentat'n on Cap'n Hugo Relearrrn Theme + Documentat'n :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/documentatn/index.html - Recent content in Documentat'n on Cap'n Hugo Relearrrn Theme + Hugo art-pir diff --git a/pir/tags/index.html b/pir/tags/index.html index 69344f851c..673a5c2019 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/index.xml b/pir/tags/index.xml index a7af91729c..b63d2bb36a 100644 --- a/pir/tags/index.xml +++ b/pir/tags/index.xml @@ -1,56 +1,56 @@ - Tag-a-taggs on Cap'n Hugo Relearrrn Theme + Tag-a-taggs :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/index.html - Recent content in Tag-a-taggs on Cap'n Hugo Relearrrn Theme + Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. As well ye can define optional title an' singulartitle that will override th' values from yer hugo. Hugo art-pir - Children + Tagga :: Children https://mcshelby.github.io/hugo-theme-relearn/pir/tags/children/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/children/index.html - Config + Tagga :: Config https://mcshelby.github.io/hugo-theme-relearn/pir/tags/config/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/config/index.html - Content + Tagga :: Content https://mcshelby.github.io/hugo-theme-relearn/pir/tags/content/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/content/index.html - Documentat'n + Tagga :: Documentat'n https://mcshelby.github.io/hugo-theme-relearn/pir/tags/documentatn/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/documentatn/index.html - hush, matey + Tagga :: hush, matey https://mcshelby.github.io/hugo-theme-relearn/pir/tags/the-hidden/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/the-hidden/index.html This lists all planks that be hidden from th' home plank. - Non-Hidden + Tagga :: Non-Hidden https://mcshelby.github.io/hugo-theme-relearn/pir/tags/non-hidden/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/non-hidden/index.html - Tutorrrial + Tagga :: Tutorrrial https://mcshelby.github.io/hugo-theme-relearn/pir/tags/tutorrrial/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/tags/tutorrrial/index.html diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index 83622fe4f4..584710d596 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/non-hidden/index.xml b/pir/tags/non-hidden/index.xml index d67a51264f..7eec558f47 100644 --- a/pir/tags/non-hidden/index.xml +++ b/pir/tags/non-hidden/index.xml @@ -1,9 +1,9 @@ - Non-Hidden on Cap'n Hugo Relearrrn Theme + Non-Hidden :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/non-hidden/index.html - Recent content in Non-Hidden on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/index.html - This be a demo child plank. Subpages o' this plank plank 1-1 + This be a demo child plank plank 2 @@ -26,42 +26,42 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/index.html - This be a demo child plank. Subpages o' this plank plank 3-1 + This be a demo child plank plank 1-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/index.html - This be a demo child plank wit' a hidden child. Ye can still access th' hidden child directly or via th' search. + This be a demo child plank plank 1-1-2-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - This be a plain demo child plank. + This be a demo child plank plank 1-1-2-2 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - This be a plain demo child plank. + This be a demo child plank plank 1-1-3 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This be a plain demo child plank. + This be a demo child plank plank 3-1 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/index.html - This be a plain demo child plank. + This be a plain plank test nested 'n a parrrent \ No newline at end of file diff --git a/pir/tags/the-hidden/index.html b/pir/tags/the-hidden/index.html index fc5b979666..b413cc3e63 100644 --- a/pir/tags/the-hidden/index.html +++ b/pir/tags/the-hidden/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/the-hidden/index.xml b/pir/tags/the-hidden/index.xml index 2eec731e62..c12dec36e1 100644 --- a/pir/tags/the-hidden/index.xml +++ b/pir/tags/the-hidden/index.xml @@ -1,9 +1,9 @@ - hush, matey on Cap'n Hugo Relearrrn Theme + hush, matey :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/the-hidden/index.html - Recent content in hush, matey on Cap'n Hugo Relearrrn Theme + This lists all planks that be hidden from th' home plank. Hugo art-pir diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index 2661eb8670..6ecf47507a 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ Tutorrrial :: Tagga :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/tutorrrial/index.xml b/pir/tags/tutorrrial/index.xml index 6f5e83cd4a..853b5283a5 100644 --- a/pir/tags/tutorrrial/index.xml +++ b/pir/tags/tutorrrial/index.xml @@ -1,9 +1,9 @@ - Tutorrrial on Cap'n Hugo Relearrrn Theme + Tutorrrial :: Tagga :: Cap'n Hugo Relearrrn Theme https://mcshelby.github.io/hugo-theme-relearn/pir/tags/tutorrrial/index.html - Recent content in Tutorrrial on Cap'n Hugo Relearrrn Theme + Hugo art-pir @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/pir/cont/taxonomy/index.html - Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. + Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box. \ No newline at end of file diff --git a/search.html b/search.html index 6af1ccb8bb..0237b02720 100644 --- a/search.html +++ b/search.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index 259a260273..dc9f01c37a 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.print.html b/shortcodes/attachments/index.print.html index e2c3bb56ce..05f7e09658 100644 --- a/shortcodes/attachments/index.print.html +++ b/shortcodes/attachments/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/attachments/index.xml b/shortcodes/attachments/index.xml index 328810714d..34014eff87 100644 --- a/shortcodes/attachments/index.xml +++ b/shortcodes/attachments/index.xml @@ -1,9 +1,9 @@ - Attachments on Hugo Relearn Theme + Attachments :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/attachments/index.html - Recent content in Attachments on Hugo Relearn Theme + List of files attached to a page Hugo en diff --git a/shortcodes/badge/index.html b/shortcodes/badge/index.html index 724dfecd0b..5c8fabae05 100644 --- a/shortcodes/badge/index.html +++ b/shortcodes/badge/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/badge/index.print.html b/shortcodes/badge/index.print.html index e67b9816ea..6219339f53 100644 --- a/shortcodes/badge/index.print.html +++ b/shortcodes/badge/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/badge/index.xml b/shortcodes/badge/index.xml index 91f9976d9d..0b4e14cde6 100644 --- a/shortcodes/badge/index.xml +++ b/shortcodes/badge/index.xml @@ -1,9 +1,9 @@ - Badge on Hugo Relearn Theme + Badge :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge/index.html - Recent content in Badge on Hugo Relearn Theme + Marker badges to display in your text Hugo en diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index 1b41cf2305..e09a16ed28 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/button/index.print.html b/shortcodes/button/index.print.html index e11cb81574..f109965112 100644 --- a/shortcodes/button/index.print.html +++ b/shortcodes/button/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/button/index.xml b/shortcodes/button/index.xml index d4ce1e14d4..cbcbfc588c 100644 --- a/shortcodes/button/index.xml +++ b/shortcodes/button/index.xml @@ -1,9 +1,9 @@ - Button on Hugo Relearn Theme + Button :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button/index.html - Recent content in Button on Hugo Relearn Theme + Clickable buttons Hugo en 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 52048e0915..0f289474e2 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index ad000a3495..c6ebc7b133 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.print.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.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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.xml 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.xml index d3b2145e45..72764f92ea 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.xml +++ 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.xml @@ -1,9 +1,9 @@ - page 1-1-1-1-1-1 on Hugo Relearn Theme + page 1-1-1-1-1-1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/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 - Recent content in page 1-1-1-1-1-1 on Hugo Relearn Theme + This is a non-hidden demo child page of a hidden parent page Hugo en 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 de45437536..901b567bb4 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index 34abaea6e7..31438b7eec 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.print.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.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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.xml b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.xml index 37f3fc177d..0c858a460d 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.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.xml @@ -1,9 +1,9 @@ - page 1-1-1-1-1 (hidden) on Hugo Relearn Theme + page 1-1-1-1-1 (hidden) :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html - Recent content in page 1-1-1-1-1 (hidden) on Hugo Relearn Theme + This is a hidden demo child page Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/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 Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/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 - This is a non-hidden demo child page of a hidden parent page. + This is a non-hidden demo child page of a hidden parent page \ 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 3cb53b3f51..52ca9db711 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html index 4d329750ef..d81dd2b818 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml index 2fefba95fb..d7f22665a1 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.xml @@ -1,9 +1,9 @@ - page 1-1-1-1 on Hugo Relearn Theme + page 1-1-1-1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html - Recent content in page 1-1-1-1 on Hugo Relearn Theme + This is a non-hidden demo child page of a hidden parent page Hugo en 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 32681a7905..5dbcebafd5 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 @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html index 9465fbb52e..0da1640520 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml index 89e8c39d88..9de2f1304c 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.xml @@ -1,9 +1,9 @@ - page 1-1-1 (hidden) on Hugo Relearn Theme + page 1-1-1 (hidden) :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html - Recent content in page 1-1-1 (hidden) on Hugo Relearn Theme + This is a hidden demo child page Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html - This is a non-hidden demo child page of a hidden parent page with a hidden child. + This is a non-hidden demo child page of a hidden parent page \ 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 4c91ff471e..ef3b801e03 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html index e427923296..ff1a866b28 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml index da08b147f4..b387d46d69 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.xml @@ -1,9 +1,9 @@ - page 1-1-2-1 on Hugo Relearn Theme + page 1-1-2-1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - Recent content in page 1-1-2-1 on Hugo Relearn Theme + This is a demo child page Hugo en 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 4d01d5ab10..1d239bed98 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html index d41ee39839..f42ea5a589 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml index 9036ebc489..19cca9d321 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.xml @@ -1,9 +1,9 @@ - page 1-1-2-2 on Hugo Relearn Theme + page 1-1-2-2 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - Recent content in page 1-1-2-2 on Hugo Relearn Theme + This is a demo child page Hugo en 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 7708131978..623ca35009 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 @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html index 1bb7e4f203..909eb1ea9f 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml index cd15fb6c2c..173ad85886 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.xml @@ -1,9 +1,9 @@ - page 1-1-3 on Hugo Relearn Theme + page 1-1-3 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - Recent content in page 1-1-3 on Hugo Relearn Theme + This is a demo child page Hugo en diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index b7c1d80f02..a8186945b1 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/index.print.html index 6da70f57bb..7a32bb61f8 100644 --- a/shortcodes/children/children-1/children-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/index.xml b/shortcodes/children/children-1/children-1-1/index.xml index c479cf2030..ed08b6367f 100644 --- a/shortcodes/children/children-1/children-1-1/index.xml +++ b/shortcodes/children/children-1/children-1-1/index.xml @@ -1,9 +1,9 @@ - page 1-1 on Hugo Relearn Theme + page 1-1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html - Recent content in page 1-1 on Hugo Relearn Theme + This is a demo child page Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This is a plain demo child page. + This is a demo child page \ No newline at end of file diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index d044122cdc..391e844850 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/index.print.html b/shortcodes/children/children-1/index.print.html index 33a7b7b6e5..876abff4cd 100644 --- a/shortcodes/children/children-1/index.print.html +++ b/shortcodes/children/children-1/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/index.xml b/shortcodes/children/children-1/index.xml index 3652c38f9f..bd6fd0f643 100644 --- a/shortcodes/children/children-1/index.xml +++ b/shortcodes/children/children-1/index.xml @@ -1,9 +1,9 @@ - page 1 on Hugo Relearn Theme + page 1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html - Recent content in page 1 on Hugo Relearn Theme + This is a demo child page Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html - This is a demo child page with a hidden child. You can still access the hidden child directly or via the search. + This is a demo child page \ No newline at end of file diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index 64d067febc..01db071314 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -33,18 +33,18 @@ So its content is used as description."> - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-2/index.print.html b/shortcodes/children/children-2/index.print.html index 1346bd43a4..0ad4e2d8ac 100644 --- a/shortcodes/children/children-2/index.print.html +++ b/shortcodes/children/children-2/index.print.html @@ -33,19 +33,19 @@ So its content is used as description."> - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-2/index.xml b/shortcodes/children/children-2/index.xml index 6a0f1f7513..b0abd06348 100644 --- a/shortcodes/children/children-2/index.xml +++ b/shortcodes/children/children-2/index.xml @@ -1,9 +1,9 @@ - page 2 on Hugo Relearn Theme + page 2 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-2/index.html - Recent content in page 2 on Hugo Relearn Theme + This is a demo child page with no description. So its content is used as description. Hugo en diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index 90de4eefff..412ea7b165 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/index.print.html b/shortcodes/children/children-3/index.print.html index befafbcab3..c34799efc4 100644 --- a/shortcodes/children/children-3/index.print.html +++ b/shortcodes/children/children-3/index.print.html @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/index.xml b/shortcodes/children/children-3/index.xml index 822e263c45..352fbbbf4d 100644 --- a/shortcodes/children/children-3/index.xml +++ b/shortcodes/children/children-3/index.xml @@ -1,9 +1,9 @@ - page 3 on Hugo Relearn Theme + page 3 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html - Recent content in page 3 on Hugo Relearn Theme + This is a demo child page Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html - This is a plain demo child page. + This is a plain page test nested in a parent \ 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 5591c02e56..9c8e8bb352 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -17,7 +17,7 @@ - + @@ -32,18 +32,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/test3/index.print.html b/shortcodes/children/children-3/test3/index.print.html index d53f6543fc..15607740b1 100644 --- a/shortcodes/children/children-3/test3/index.print.html +++ b/shortcodes/children/children-3/test3/index.print.html @@ -17,7 +17,7 @@ - + @@ -32,19 +32,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/test3/index.xml b/shortcodes/children/children-3/test3/index.xml index e560309b08..0a21c57dcd 100644 --- a/shortcodes/children/children-3/test3/index.xml +++ b/shortcodes/children/children-3/test3/index.xml @@ -1,9 +1,9 @@ - page 3-1 on Hugo Relearn Theme + page 3-1 :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html - Recent content in page 3-1 on Hugo Relearn Theme + This is a plain page test nested in a parent Hugo en diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index 8f4809a58a..7d4db1b031 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-4/index.print.html b/shortcodes/children/children-4/index.print.html index d8c6df7be8..bed83e2d15 100644 --- a/shortcodes/children/children-4/index.print.html +++ b/shortcodes/children/children-4/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-4/index.xml b/shortcodes/children/children-4/index.xml index 6d88580784..7173c57cc3 100644 --- a/shortcodes/children/children-4/index.xml +++ b/shortcodes/children/children-4/index.xml @@ -1,9 +1,9 @@ - page 4 (hidden) on Hugo Relearn Theme + page 4 (hidden) :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-4/index.html - Recent content in page 4 (hidden) on Hugo Relearn Theme + This is a hidden demo child page Hugo en diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index d3d253031e..0fa079818c 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/index.print.html b/shortcodes/children/index.print.html index bad251882e..6a11db012f 100644 --- a/shortcodes/children/index.print.html +++ b/shortcodes/children/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/index.xml b/shortcodes/children/index.xml index e6d046fc0a..dfeeb3b880 100644 --- a/shortcodes/children/index.xml +++ b/shortcodes/children/index.xml @@ -1,9 +1,9 @@ - Children on Hugo Relearn Theme + Children :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/index.html - Recent content in Children on Hugo Relearn Theme + List the child pages of a page Hugo en @@ -12,14 +12,14 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/test/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/test/index.html - This is a plain demo child page. + This is a plain page test, and the beginning of a YAML multiline description... page 1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html - This is a demo child page. Subpages of this page page 1-1 + This is a demo child page page 2 @@ -33,7 +33,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html - This is a demo child page. Subpages of this page page 3-1 + This is a demo child page \ No newline at end of file diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index 559b19c867..8574781957 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -5,27 +5,23 @@ - + - + - + - + - + @@ -35,18 +31,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/test/index.print.html b/shortcodes/children/test/index.print.html index ee692d89a9..b7c1cdf233 100644 --- a/shortcodes/children/test/index.print.html +++ b/shortcodes/children/test/index.print.html @@ -5,27 +5,23 @@ - + - + - + - + - + @@ -35,19 +31,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/test/index.xml b/shortcodes/children/test/index.xml index a952cacead..671f68ccf9 100644 --- a/shortcodes/children/test/index.xml +++ b/shortcodes/children/test/index.xml @@ -1,9 +1,9 @@ - page X on Hugo Relearn Theme + page X :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/test/index.html - Recent content in page X on Hugo Relearn Theme + This is a plain page test, and the beginning of a YAML multiline description... Hugo en diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index 740b1530d5..b7fe02b73d 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/shortcodes/expand/index.print.html b/shortcodes/expand/index.print.html index 535dfcaacf..551c0b6218 100644 --- a/shortcodes/expand/index.print.html +++ b/shortcodes/expand/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/expand/index.xml b/shortcodes/expand/index.xml index 1c9f21268b..b7f093bc55 100644 --- a/shortcodes/expand/index.xml +++ b/shortcodes/expand/index.xml @@ -1,9 +1,9 @@ - Expand on Hugo Relearn Theme + Expand :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html - Recent content in Expand on Hugo Relearn Theme + Expandable/collapsible sections of text Hugo en diff --git a/shortcodes/highlight/index.html b/shortcodes/highlight/index.html index 7e27605031..31d8168acc 100644 --- a/shortcodes/highlight/index.html +++ b/shortcodes/highlight/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/highlight/index.print.html b/shortcodes/highlight/index.print.html index d2a8e6a233..5c5c17c6b7 100644 --- a/shortcodes/highlight/index.print.html +++ b/shortcodes/highlight/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/highlight/index.xml b/shortcodes/highlight/index.xml index cdb02b6eca..bc4c942463 100644 --- a/shortcodes/highlight/index.xml +++ b/shortcodes/highlight/index.xml @@ -1,9 +1,9 @@ - Highlight on Hugo Relearn Theme + Highlight :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight/index.html - Recent content in Highlight on Hugo Relearn Theme + Render code with a syntax highlighter Hugo en diff --git a/shortcodes/icon/index.html b/shortcodes/icon/index.html index 8fba40a4ca..bae1b6bfdd 100644 --- a/shortcodes/icon/index.html +++ b/shortcodes/icon/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/icon/index.print.html b/shortcodes/icon/index.print.html index 03a6b80cfc..ae6f28c928 100644 --- a/shortcodes/icon/index.print.html +++ b/shortcodes/icon/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/icon/index.xml b/shortcodes/icon/index.xml index 779b358181..a0ecbf23e4 100644 --- a/shortcodes/icon/index.xml +++ b/shortcodes/icon/index.xml @@ -1,9 +1,9 @@ - Icon on Hugo Relearn Theme + Icon :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html - Recent content in Icon on Hugo Relearn Theme + Nice icons for your page Hugo en diff --git a/shortcodes/include/include_me/index.html b/shortcodes/include/include_me/index.html index 885df9cd76..27aaa61d37 100644 --- a/shortcodes/include/include_me/index.html +++ b/shortcodes/include/include_me/index.html @@ -11,35 +11,33 @@ multiple paragraphs bullet point lists emphasized, bold and even bold emphasized - - - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/include/include_me/index.print.html b/shortcodes/include/include_me/index.print.html index 43c75bc35d..96e0f74e44 100644 --- a/shortcodes/include/include_me/index.print.html +++ b/shortcodes/include/include_me/index.print.html @@ -11,36 +11,34 @@ multiple paragraphs bullet point lists emphasized, bold and even bold emphasized - - - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include/include_me/index.xml b/shortcodes/include/include_me/index.xml index 60ca5a15fc..06c6b0e22b 100644 --- a/shortcodes/include/include_me/index.xml +++ b/shortcodes/include/include_me/index.xml @@ -1,9 +1,9 @@ - Hugo Relearn Theme + https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include/include_me/index.html - Recent content on Hugo Relearn Theme + You can add standard markdown syntax: multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. Hugo en diff --git a/shortcodes/include/index.html b/shortcodes/include/index.html index e4cd89de83..5ea31a66d7 100644 --- a/shortcodes/include/index.html +++ b/shortcodes/include/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/include/index.print.html b/shortcodes/include/index.print.html index c8b5ff272f..a1a97c67f8 100644 --- a/shortcodes/include/index.print.html +++ b/shortcodes/include/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include/index.xml b/shortcodes/include/index.xml index 0149384969..fa3ee7036b 100644 --- a/shortcodes/include/index.xml +++ b/shortcodes/include/index.xml @@ -1,9 +1,9 @@ - Include on Hugo Relearn Theme + Include :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include/index.html - Recent content in Include on Hugo Relearn Theme + Displays content from other files Hugo en diff --git a/shortcodes/index.html b/shortcodes/index.html index 371f50dd2e..0ea6e2b358 100644 --- a/shortcodes/index.html +++ b/shortcodes/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/index.print.html b/shortcodes/index.print.html index 063537dfda..826376ff28 100644 --- a/shortcodes/index.print.html +++ b/shortcodes/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - + - - + + - + diff --git a/shortcodes/index.xml b/shortcodes/index.xml index 980d2d1b3f..0289afc7f5 100644 --- a/shortcodes/index.xml +++ b/shortcodes/index.xml @@ -1,9 +1,9 @@ - Shortcodes on Hugo Relearn Theme + Shortcodes :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/index.html - Recent content in Shortcodes on Hugo Relearn Theme + Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. Hugo en @@ -12,105 +12,105 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge/index.html - The badge shortcode displays little markers in your text with adjustable color, title and icon. + Marker badges to display in your text Button https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button/index.html - The button shortcode displays a clickable button with adjustable color, title and icon. + Clickable buttons Children https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/index.html - The children shortcode lists the child pages of the current page and its descendants. + List the child pages of a page Expand https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand/index.html - The expand shortcode displays an expandable/collapsible section of text. Expand me… Thank you! + Expandable/collapsible sections of text Highlight https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/highlight/index.html - The highlight shortcode renders your code with a syntax highlighter. + Render code with a syntax highlighter Icon https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html - The icon shortcode displays icons using the Font Awesome library. + Nice icons for your page Include https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include/index.html - The include shortcode includes other files from your project inside of the current page. + Displays content from other files Math https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math/index.html - The math shortcode generates beautiful formatted math and chemical formulae using the MathJax library. + Beautiful math and chemical formulae Mermaid https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html - The mermaid shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library. + Generate diagrams and flowcharts from text Notice https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice/index.html - The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page. + Disclaimers to help you structure your page OpenAPI https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html - The openapi shortcode uses the Swagger UI library to display your OpenAPI / Swagger specifications. + UI for your OpenAPI / Swagger specifications Resources https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html - The resources shortcode displays the titles of resources contained in a page bundle. + List resources contained in a page bundle SiteParam https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html - The siteparam shortcode prints values of site params. Usage While the examples are using shortcodes with named parameter you are free to use positional as well or call this shortcode from your own partials. + Get value of site params Tab https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab/index.html - You can use a tab shortcode to display a single tab. + Show content in a single tab Tabs https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs/index.html - The tabs shortcode displays arbitrary content in an unlimited number of tabs. + Show content in tabbed views \ No newline at end of file diff --git a/shortcodes/math/index.html b/shortcodes/math/index.html index d1b4790455..085f759abb 100644 --- a/shortcodes/math/index.html +++ b/shortcodes/math/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + diff --git a/shortcodes/math/index.print.html b/shortcodes/math/index.print.html index b3e0830a4e..47b739eddd 100644 --- a/shortcodes/math/index.print.html +++ b/shortcodes/math/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - + + diff --git a/shortcodes/math/index.xml b/shortcodes/math/index.xml index 8770274354..7474d9f7b7 100644 --- a/shortcodes/math/index.xml +++ b/shortcodes/math/index.xml @@ -1,9 +1,9 @@ - Math on Hugo Relearn Theme + Math :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math/index.html - Recent content in Math on Hugo Relearn Theme + Beautiful math and chemical formulae Hugo en diff --git a/shortcodes/mermaid/index.html b/shortcodes/mermaid/index.html index 2bcaafef68..6f71e9258d 100644 --- a/shortcodes/mermaid/index.html +++ b/shortcodes/mermaid/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/mermaid/index.print.html b/shortcodes/mermaid/index.print.html index 25cedbf2ad..5fc81f433e 100644 --- a/shortcodes/mermaid/index.print.html +++ b/shortcodes/mermaid/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/mermaid/index.xml b/shortcodes/mermaid/index.xml index d3b77c3148..79ab404422 100644 --- a/shortcodes/mermaid/index.xml +++ b/shortcodes/mermaid/index.xml @@ -1,9 +1,9 @@ - Mermaid on Hugo Relearn Theme + Mermaid :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html - Recent content in Mermaid on Hugo Relearn Theme + Generate diagrams and flowcharts from text Hugo en diff --git a/shortcodes/notice/index.html b/shortcodes/notice/index.html index a15b1c5afc..1385a9f3ae 100644 --- a/shortcodes/notice/index.html +++ b/shortcodes/notice/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/notice/index.print.html b/shortcodes/notice/index.print.html index 4962d1f332..2abb56b766 100644 --- a/shortcodes/notice/index.print.html +++ b/shortcodes/notice/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/notice/index.xml b/shortcodes/notice/index.xml index f24a5d7053..03f81d7c45 100644 --- a/shortcodes/notice/index.xml +++ b/shortcodes/notice/index.xml @@ -1,9 +1,9 @@ - Notice on Hugo Relearn Theme + Notice :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice/index.html - Recent content in Notice on Hugo Relearn Theme + Disclaimers to help you structure your page Hugo en diff --git a/shortcodes/openapi/index.html b/shortcodes/openapi/index.html index 6e10daf970..46cd08cab8 100644 --- a/shortcodes/openapi/index.html +++ b/shortcodes/openapi/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + - - + + - + diff --git a/shortcodes/openapi/index.print.html b/shortcodes/openapi/index.print.html index 25153b92ab..16df16d1f3 100644 --- a/shortcodes/openapi/index.print.html +++ b/shortcodes/openapi/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + - - + + - + diff --git a/shortcodes/openapi/index.xml b/shortcodes/openapi/index.xml index 6a5886c722..19a8be8292 100644 --- a/shortcodes/openapi/index.xml +++ b/shortcodes/openapi/index.xml @@ -1,9 +1,9 @@ - OpenAPI on Hugo Relearn Theme + OpenAPI :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html - Recent content in OpenAPI on Hugo Relearn Theme + UI for your OpenAPI / Swagger specifications Hugo en diff --git a/shortcodes/resources/index.html b/shortcodes/resources/index.html index 217f3780f5..faecd733c7 100644 --- a/shortcodes/resources/index.html +++ b/shortcodes/resources/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/resources/index.print.html b/shortcodes/resources/index.print.html index 93468579dd..47e5f9d58b 100644 --- a/shortcodes/resources/index.print.html +++ b/shortcodes/resources/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/resources/index.xml b/shortcodes/resources/index.xml index c333d6208c..46aacfac8a 100644 --- a/shortcodes/resources/index.xml +++ b/shortcodes/resources/index.xml @@ -1,9 +1,9 @@ - Resources on Hugo Relearn Theme + Resources :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources/index.html - Recent content in Resources on Hugo Relearn Theme + List resources contained in a page bundle Hugo en diff --git a/shortcodes/siteparam/index.html b/shortcodes/siteparam/index.html index bf130215be..5c26ee4842 100644 --- a/shortcodes/siteparam/index.html +++ b/shortcodes/siteparam/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/siteparam/index.print.html b/shortcodes/siteparam/index.print.html index c70563c7f0..b1e2e819f8 100644 --- a/shortcodes/siteparam/index.print.html +++ b/shortcodes/siteparam/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/siteparam/index.xml b/shortcodes/siteparam/index.xml index 66be5ac1d2..59cfd95293 100644 --- a/shortcodes/siteparam/index.xml +++ b/shortcodes/siteparam/index.xml @@ -1,9 +1,9 @@ - SiteParam on Hugo Relearn Theme + SiteParam :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html - Recent content in SiteParam on Hugo Relearn Theme + Get value of site params Hugo en diff --git a/shortcodes/tab/index.html b/shortcodes/tab/index.html index 61772c2df8..bb27a277f0 100644 --- a/shortcodes/tab/index.html +++ b/shortcodes/tab/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tab/index.print.html b/shortcodes/tab/index.print.html index ea53c58dc9..48e9c4a631 100644 --- a/shortcodes/tab/index.print.html +++ b/shortcodes/tab/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tab/index.xml b/shortcodes/tab/index.xml index 4f7a94c4cd..e0760aae8f 100644 --- a/shortcodes/tab/index.xml +++ b/shortcodes/tab/index.xml @@ -1,9 +1,9 @@ - Tab on Hugo Relearn Theme + Tab :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab/index.html - Recent content in Tab on Hugo Relearn Theme + Show content in a single tab Hugo en diff --git a/shortcodes/tabs/index.html b/shortcodes/tabs/index.html index e663fda8b6..92780f28aa 100644 --- a/shortcodes/tabs/index.html +++ b/shortcodes/tabs/index.html @@ -17,7 +17,7 @@ - + @@ -29,18 +29,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tabs/index.print.html b/shortcodes/tabs/index.print.html index 797cff0fc3..08221c11b3 100644 --- a/shortcodes/tabs/index.print.html +++ b/shortcodes/tabs/index.print.html @@ -17,7 +17,7 @@ - + @@ -29,19 +29,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tabs/index.xml b/shortcodes/tabs/index.xml index fcc6e5c43e..49ce9208d6 100644 --- a/shortcodes/tabs/index.xml +++ b/shortcodes/tabs/index.xml @@ -1,9 +1,9 @@ - Tabs on Hugo Relearn Theme + Tabs :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs/index.html - Recent content in Tabs on Hugo Relearn Theme + Show content in tabbed views Hugo en diff --git a/showcase/index.html b/showcase/index.html index 00d2e5878a..6a2ebab61e 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/showcase/index.print.html b/showcase/index.print.html index 736cae423d..cdc0731746 100644 --- a/showcase/index.print.html +++ b/showcase/index.print.html @@ -28,19 +28,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/showcase/index.xml b/showcase/index.xml index bbebdb0928..f358abaf44 100644 --- a/showcase/index.xml +++ b/showcase/index.xml @@ -1,9 +1,9 @@ - Showcase on Hugo Relearn Theme + Showcase :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/showcase/index.html - Recent content in Showcase on Hugo Relearn Theme + Poésieland by Barbara Post A collection of poems with requirements for improved taxonomy support, adjusted menu width and additional JavaScript dependencies. Hugo en diff --git a/tags/children/index.html b/tags/children/index.html index e3417912dd..9d995a9c84 100644 --- a/tags/children/index.html +++ b/tags/children/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/children/index.xml b/tags/children/index.xml index 04df997c52..68a100c42e 100644 --- a/tags/children/index.xml +++ b/tags/children/index.xml @@ -1,9 +1,9 @@ - Children on Hugo Relearn Theme + Children :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/children/index.html - Recent content in Children on Hugo Relearn Theme + Hugo en @@ -12,14 +12,14 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/test/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/test/index.html - This is a plain demo child page. + This is a plain page test, and the beginning of a YAML multiline description... page 1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html - This is a demo child page. Subpages of this page page 1-1 + This is a demo child page page 2 @@ -33,42 +33,42 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html - This is a demo child page. Subpages of this page page 3-1 + This is a demo child page page 1-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html - This is a demo child page with a hidden child. You can still access the hidden child directly or via the search. + This is a demo child page page 1-1-2-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - This is a plain demo child page. + This is a demo child page page 1-1-2-2 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - This is a plain demo child page. + This is a demo child page page 1-1-3 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This is a plain demo child page. + This is a demo child page page 3-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html - This is a plain demo child page. + This is a plain page test nested in a parent \ No newline at end of file diff --git a/tags/config/index.html b/tags/config/index.html index dbff465bf6..d75cf5df36 100644 --- a/tags/config/index.html +++ b/tags/config/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/config/index.xml b/tags/config/index.xml index 99f90819f3..e2fe518729 100644 --- a/tags/config/index.xml +++ b/tags/config/index.xml @@ -1,9 +1,9 @@ - Config on Hugo Relearn Theme + Config :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/config/index.html - Recent content in Config on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/configuration/index.html - On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo. + On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo. \ No newline at end of file diff --git a/tags/content/index.html b/tags/content/index.html index 5eed7a0705..8f7ecc7600 100644 --- a/tags/content/index.html +++ b/tags/content/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/content/index.xml b/tags/content/index.xml index e48c9fde6a..ecea44038c 100644 --- a/tags/content/index.xml +++ b/tags/content/index.xml @@ -1,9 +1,9 @@ - Content on Hugo Relearn Theme + Content :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/content/index.html - Recent content in Content on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html - 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. + 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. \ No newline at end of file diff --git a/tags/documentation/index.html b/tags/documentation/index.html index 7f88de06f4..aa40dc9ddc 100644 --- a/tags/documentation/index.html +++ b/tags/documentation/index.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ Documentation :: Tag :: Hugo Relearn Theme - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/documentation/index.xml b/tags/documentation/index.xml index 3759e9f3ab..52f0df4bf1 100644 --- a/tags/documentation/index.xml +++ b/tags/documentation/index.xml @@ -1,9 +1,9 @@ - Documentation on Hugo Relearn Theme + Documentation :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/documentation/index.html - Recent content in Documentation on Hugo Relearn Theme + Hugo en diff --git a/tags/index.html b/tags/index.html index 9bccc53bb7..f192ef1054 100644 --- a/tags/index.html +++ b/tags/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/index.xml b/tags/index.xml index efaf43617a..658d09435f 100644 --- a/tags/index.xml +++ b/tags/index.xml @@ -1,56 +1,56 @@ - Hugo Relearn Theme + Tags :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/index.html - Recent content on Hugo Relearn Theme + You can define optional content in your overridden taxonomy page. As well you can define optional title and singulartitle that will override the values from your hugo. Hugo en - a secret + Tag :: a secret https://mcshelby.github.io/hugo-theme-relearn/tags/the-hidden/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/the-hidden/index.html This lists all pages that are hidden from the home page. - Children + Tag :: Children https://mcshelby.github.io/hugo-theme-relearn/tags/children/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/children/index.html - Config + Tag :: Config https://mcshelby.github.io/hugo-theme-relearn/tags/config/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/config/index.html - Content + Tag :: Content https://mcshelby.github.io/hugo-theme-relearn/tags/content/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/content/index.html - Documentation + Tag :: Documentation https://mcshelby.github.io/hugo-theme-relearn/tags/documentation/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/documentation/index.html - Non-Hidden + Tag :: Non-Hidden https://mcshelby.github.io/hugo-theme-relearn/tags/non-hidden/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/non-hidden/index.html - Tutorial + Tag :: Tutorial https://mcshelby.github.io/hugo-theme-relearn/tags/tutorial/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/tags/tutorial/index.html diff --git a/tags/non-hidden/index.html b/tags/non-hidden/index.html index 6208d155f2..e08164bf93 100644 --- a/tags/non-hidden/index.html +++ b/tags/non-hidden/index.html @@ -10,7 +10,6 @@ - @@ -24,18 +23,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/non-hidden/index.xml b/tags/non-hidden/index.xml index 8c1c7ef1e3..e691f06b2c 100644 --- a/tags/non-hidden/index.xml +++ b/tags/non-hidden/index.xml @@ -1,9 +1,9 @@ - Non-Hidden on Hugo Relearn Theme + Non-Hidden :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/non-hidden/index.html - Recent content in Non-Hidden on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/index.html - This is a demo child page. Subpages of this page page 1-1 + This is a demo child page page 2 @@ -26,42 +26,42 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/index.html - This is a demo child page. Subpages of this page page 3-1 + This is a demo child page page 1-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html - This is a demo child page with a hidden child. You can still access the hidden child directly or via the search. + This is a demo child page page 1-1-2-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html - This is a plain demo child page. + This is a demo child page page 1-1-2-2 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html - This is a plain demo child page. + This is a demo child page page 1-1-3 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html - This is a plain demo child page. + This is a demo child page page 3-1 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html - This is a plain demo child page. + This is a plain page test nested in a parent \ No newline at end of file diff --git a/tags/the-hidden/index.html b/tags/the-hidden/index.html index 3239ba6613..6aa03d8823 100644 --- a/tags/the-hidden/index.html +++ b/tags/the-hidden/index.html @@ -27,18 +27,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/the-hidden/index.xml b/tags/the-hidden/index.xml index 0b66bbe944..76edd7676a 100644 --- a/tags/the-hidden/index.xml +++ b/tags/the-hidden/index.xml @@ -1,9 +1,9 @@ - a secret on Hugo Relearn Theme + a secret :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/the-hidden/index.html - Recent content in a secret on Hugo Relearn Theme + This lists all pages that are hidden from the home page. Hugo en diff --git a/tags/tutorial/index.html b/tags/tutorial/index.html index 4f73934a5b..4ddf68eac7 100644 --- a/tags/tutorial/index.html +++ b/tags/tutorial/index.html @@ -10,7 +10,6 @@ - @@ -21,18 +20,18 @@ Tutorial :: Tag :: Hugo Relearn Theme - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/tutorial/index.xml b/tags/tutorial/index.xml index 7722edcb46..fd5f8c31c9 100644 --- a/tags/tutorial/index.xml +++ b/tags/tutorial/index.xml @@ -1,9 +1,9 @@ - Tutorial on Hugo Relearn Theme + Tutorial :: Tag :: Hugo Relearn Theme https://mcshelby.github.io/hugo-theme-relearn/tags/tutorial/index.html - Recent content in Tutorial on Hugo Relearn Theme + Hugo en @@ -12,7 +12,7 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/taxonomy/index.html - The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. + The Relearn theme supports Hugo’s default taxonomies tag and category out of the box. \ No newline at end of file