diff --git a/404.html b/404.html index dd6ca1c880..73082e71cd 100644 --- a/404.html +++ b/404.html @@ -5,37 +5,34 @@ - + - + - - 404 Page not found :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/branding/index.print.html b/basics/branding/index.print.html index 415f8681be..620dbb84a0 100644 --- a/basics/branding/index.print.html +++ b/basics/branding/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/index.html b/basics/configuration/index.html index b13e25b8b3..833c258ee5 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -20,7 +20,7 @@ - + Configuration :: Hugo Relearn Theme @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/configuration/index.print.html b/basics/configuration/index.print.html index 93ea31809b..fa7b26756b 100644 --- a/basics/configuration/index.print.html +++ b/basics/configuration/index.print.html @@ -20,7 +20,7 @@ - + Configuration :: Hugo Relearn Theme @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/customization/index.html b/basics/customization/index.html index 9c7ae368d7..e2ba3f390b 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/customization/index.print.html b/basics/customization/index.print.html index c96c8854ad..84a466faff 100644 --- a/basics/customization/index.print.html +++ b/basics/customization/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/generator/index.html b/basics/generator/index.html index 877ff944ce..d9026898b8 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.print.html b/basics/generator/index.print.html index 267012ec94..eaccfc4a02 100644 --- a/basics/generator/index.print.html +++ b/basics/generator/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index 787a4f232e..93837603c1 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -5,21 +5,21 @@ - + - + - + - + History :: Hugo Relearn Theme @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/history/index.print.html b/basics/history/index.print.html index 405a03eb4d..f84ea42179 100644 --- a/basics/history/index.print.html +++ b/basics/history/index.print.html @@ -5,21 +5,21 @@ - + - + - + - + History :: Hugo Relearn Theme @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/index.html b/basics/index.html index f37749607b..36eb3fbb28 100644 --- a/basics/index.html +++ b/basics/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/index.print.html b/basics/index.print.html index 38333487a6..b909006d78 100644 --- a/basics/index.print.html +++ b/basics/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/index.xml b/basics/index.xml index 2d3dd29575..7c074a4ca2 100644 --- a/basics/index.xml +++ b/basics/index.xml @@ -61,14 +61,14 @@ https://mcshelby.github.io/hugo-theme-relearn/basics/topbar/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/basics/topbar/index.html - The theme comes with a reasonably configured topbar. + The theme comes with a reasonably configured topbar. Nevertheless, your requirements may differ from this configuration. History 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. + 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 8178ac1579..bece82e80f 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/installation/index.print.html b/basics/installation/index.print.html index bc7ea24e9d..beafb4c574 100644 --- a/basics/installation/index.print.html +++ b/basics/installation/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/migration/index.html b/basics/migration/index.html index 514bbef0bf..54c4b81da4 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -20,7 +20,7 @@ - + What's New :: Hugo Relearn Theme @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/migration/index.print.html b/basics/migration/index.print.html index efa4a73f89..ed9d86b492 100644 --- a/basics/migration/index.print.html +++ b/basics/migration/index.print.html @@ -20,7 +20,7 @@ - + What's New :: Hugo Relearn Theme @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 91b784f613..11c21085e6 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/requirements/index.print.html b/basics/requirements/index.print.html index b2103cf572..7632fc00c0 100644 --- a/basics/requirements/index.print.html +++ b/basics/requirements/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/topbar/index.html b/basics/topbar/index.html index ae59aa54f8..beb0791fe3 100644 --- a/basics/topbar/index.html +++ b/basics/topbar/index.html @@ -5,21 +5,25 @@ - + - + - + - + Topbar Modification :: Hugo Relearn Theme @@ -28,19 +32,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/topbar/index.print.html b/basics/topbar/index.print.html index 57b1cf190f..96bac22bf1 100644 --- a/basics/topbar/index.print.html +++ b/basics/topbar/index.print.html @@ -5,21 +5,25 @@ - + - + - + - + Topbar Modification :: Hugo Relearn Theme @@ -28,20 +32,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/categories/basic/index.html b/categories/basic/index.html index 489fcb5db3..b06bd246fb 100644 --- a/categories/basic/index.html +++ b/categories/basic/index.html @@ -5,40 +5,37 @@ - + - + - - Basic :: Category :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/content/index.html b/categories/content/index.html index da0c37c529..7fea63fdb4 100644 --- a/categories/content/index.html +++ b/categories/content/index.html @@ -5,40 +5,37 @@ - + - + - - Content :: Category :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.html b/categories/custom/index.html index f0aa979dab..376a909112 100644 --- a/categories/custom/index.html +++ b/categories/custom/index.html @@ -5,40 +5,37 @@ - + - + - - Custom :: Category :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/index.html b/categories/index.html index 2a0b5dd65a..4236213296 100644 --- a/categories/index.html +++ b/categories/index.html @@ -5,40 +5,37 @@ - + - + - - Categories :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/taxonomy/index.html b/categories/taxonomy/index.html index 52c00c5eeb..a8d6794438 100644 --- a/categories/taxonomy/index.html +++ b/categories/taxonomy/index.html @@ -5,40 +5,37 @@ - + - + - - Taxonomy :: Category :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.html b/categories/theming/index.html index 8a0abbcda6..6d84ae3af7 100644 --- a/categories/theming/index.html +++ b/categories/theming/index.html @@ -5,40 +5,37 @@ - + - + - - Theming :: Category :: Hugo Relearn Theme - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index 23d100295b..cbc529ffff 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.print.html b/cont/archetypes/index.print.html index 8a4985291f..9397c2d2c5 100644 --- a/cont/archetypes/index.print.html +++ b/cont/archetypes/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/frontmatter/index.html b/cont/frontmatter/index.html index 0a30f88705..a72380c1c1 100644 --- a/cont/frontmatter/index.html +++ b/cont/frontmatter/index.html @@ -5,21 +5,25 @@ - + - + - + - + Frontmatter :: Hugo Relearn Theme @@ -28,19 +32,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/frontmatter/index.print.html b/cont/frontmatter/index.print.html index c78081148d..d74dd3cc61 100644 --- a/cont/frontmatter/index.print.html +++ b/cont/frontmatter/index.print.html @@ -5,21 +5,25 @@ - + - + - + - + Frontmatter :: Hugo Relearn Theme @@ -28,20 +32,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 9b5cf327ed..50f761317d 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/i18n/index.print.html b/cont/i18n/index.print.html index 338b6a3324..ac4780f9b2 100644 --- a/cont/i18n/index.print.html +++ b/cont/i18n/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/imageeffects/index.html b/cont/imageeffects/index.html index 5a78d2d68b..2935698ddd 100644 --- a/cont/imageeffects/index.html +++ b/cont/imageeffects/index.html @@ -5,22 +5,26 @@ - + - + - + - + Image Effects :: Hugo Relearn Theme @@ -29,19 +33,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/imageeffects/index.print.html b/cont/imageeffects/index.print.html index 29352e0539..0cca0a71dd 100644 --- a/cont/imageeffects/index.print.html +++ b/cont/imageeffects/index.print.html @@ -5,22 +5,26 @@ - + - + - + - + Image Effects :: Hugo Relearn Theme @@ -29,20 +33,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/index.html b/cont/index.html index aed11dca96..d1b37ba5d4 100644 --- a/cont/index.html +++ b/cont/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/index.print.html b/cont/index.print.html index 5c48dd268c..0f8a40c6c8 100644 --- a/cont/index.print.html +++ b/cont/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/index.xml b/cont/index.xml index 04e512baee..75fdd58114 100644 --- a/cont/index.xml +++ b/cont/index.xml @@ -12,14 +12,14 @@ https://mcshelby.github.io/hugo-theme-relearn/cont/pages/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/pages/index.html - In Hugo, pages are the core of your site. + In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site. Frontmatter https://mcshelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html - Each Hugo page has to define a frontmatter. + Each Hugo page has to define a frontmatter. All Frontmatter Options The values reflect example options. Archetypes @@ -33,14 +33,14 @@ 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. + 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 https://mcshelby.github.io/hugo-theme-relearn/cont/imageeffects/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/cont/imageeffects/index.html - The theme supports non-standard image effects. + 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. Menu extra shortcuts diff --git a/cont/markdown/index.html b/cont/markdown/index.html index f4b1366f3a..dc2c83c438 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -5,23 +5,23 @@ - + - + - + - + @@ -31,19 +31,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/markdown/index.print.html b/cont/markdown/index.print.html index d14453d7f5..80b385322c 100644 --- a/cont/markdown/index.print.html +++ b/cont/markdown/index.print.html @@ -5,23 +5,23 @@ - + - + - + - + @@ -31,20 +31,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index f6e1ab812f..f864cdf5dc 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/menushortcuts/index.print.html b/cont/menushortcuts/index.print.html index a7fea06757..8607f4e4f2 100644 --- a/cont/menushortcuts/index.print.html +++ b/cont/menushortcuts/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/index.html b/cont/pages/index.html index 6c71ca98bd..59a13d7093 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -5,22 +5,22 @@ - + - + - + - + Pages organization :: Hugo Relearn Theme @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/pages/index.print.html b/cont/pages/index.print.html index 28f4426ac8..13ea852863 100644 --- a/cont/pages/index.print.html +++ b/cont/pages/index.print.html @@ -5,22 +5,22 @@ - + - + - + - + Pages organization :: Hugo Relearn Theme @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/taxonomy/index.html b/cont/taxonomy/index.html index b7d18d1f27..814ec4d9b6 100644 --- a/cont/taxonomy/index.html +++ b/cont/taxonomy/index.html @@ -31,19 +31,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/taxonomy/index.print.html b/cont/taxonomy/index.print.html index b18c57a3d9..cd347a31a2 100644 --- a/cont/taxonomy/index.print.html +++ b/cont/taxonomy/index.print.html @@ -31,20 +31,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 63fc8e5dc5..9d882c570d 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -27,19 +27,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/contributing/index.print.html b/dev/contributing/index.print.html index 07661145a7..983582e807 100644 --- a/dev/contributing/index.print.html +++ b/dev/contributing/index.print.html @@ -27,20 +27,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/index.html b/dev/index.html index ebe70d88e0..d096c85ef5 100644 --- a/dev/index.html +++ b/dev/index.html @@ -27,19 +27,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/index.print.html b/dev/index.print.html index 07836feaba..3fb3f42f65 100644 --- a/dev/index.print.html +++ b/dev/index.print.html @@ -27,20 +27,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/index.xml b/dev/index.xml index 5b87e491a2..f9c12ec426 100644 --- a/dev/index.xml +++ b/dev/index.xml @@ -26,7 +26,7 @@ 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. + Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings \ No newline at end of file diff --git a/dev/maintaining/index.html b/dev/maintaining/index.html index 247af5fe54..3b588c6779 100644 --- a/dev/maintaining/index.html +++ b/dev/maintaining/index.html @@ -27,19 +27,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/maintaining/index.print.html b/dev/maintaining/index.print.html index b0a8319d0b..5aa3b67f04 100644 --- a/dev/maintaining/index.print.html +++ b/dev/maintaining/index.print.html @@ -27,20 +27,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/screenshots/index.html b/dev/screenshots/index.html index 8f97fb2ad5..6d38c5a856 100644 --- a/dev/screenshots/index.html +++ b/dev/screenshots/index.html @@ -27,19 +27,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/screenshots/index.print.html b/dev/screenshots/index.print.html index 0185597437..d6553a365a 100644 --- a/dev/screenshots/index.print.html +++ b/dev/screenshots/index.print.html @@ -27,20 +27,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/index.html b/index.html index a79bfea67c..c4e964644b 100644 --- a/index.html +++ b/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/index.print.html b/index.print.html index 2f3f13e702..6235a9d5b0 100644 --- a/index.print.html +++ b/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - + - - + + - + diff --git a/index.search.js b/index.search.js index 7032b8ac70..cdf167f668 100644 --- a/index.search.js +++ b/index.search.js @@ -20,7 +20,7 @@ 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", - "description": "In Hugo, pages are the core of your site.", + "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, "title": "Pages organization", "uri": "/hugo-theme-relearn/cont/pages/index.html" @@ -36,14 +36,14 @@ 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.", + "description": "Each Hugo page has to define a frontmatter.\nAll Frontmatter Options The values reflect example options.", "tags": null, "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 frontmatter option menuTitle is now unsupported in favor for Hugo’s own linkTitle.\nAdditionally, if set linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange Removing support for Internet Explorer 11 allowed to upgrade Font Awesome 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.\nIn addition, all places where descriptions are printed, now behave in the same way.\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", + "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 been ignored.\nWith the newly introduces 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 The frontmatter option menuTitle is now unsupported in favor for Hugo’s own linkTitle.\nAdditionally, if set linkTitle will now be used instead of title to generate the breadcrumb.\nBreaking Support for Internet Explorer 11 was finally dropped.\nChange Removing support for Internet Explorer 11 allowed to upgrade Font Awesome 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, "title": "What's New", @@ -60,7 +60,7 @@ var relearn_search_index = [ { "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", - "description": "Hugo uses Markdown for its simple content format.", + "description": "Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well.", "tags": null, "title": "Shortcodes", "uri": "/hugo-theme-relearn/shortcodes/index.html" @@ -76,7 +76,7 @@ var relearn_search_index = [ { "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.", + "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.", "tags": [ "Content" ], @@ -86,7 +86,7 @@ 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", - "description": "The theme supports non-standard image effects.", + "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, "title": "Image Effects", "uri": "/hugo-theme-relearn/cont/imageeffects/index.html" @@ -146,7 +146,7 @@ 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 = '' description = 'Documentation for Hugo Relearn Theme' 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: \"\" description: Documentation for Hugo Relearn Theme 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\": \"\", \"description\": \"Documentation for Hugo Relearn Theme\", \"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\" ] # The description of your site. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # This can be overridden in the page's frontmatter. description = \"Documentation for Hugo Relearn Theme\" # 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\" ", + "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.", "tags": [ "config" @@ -157,7 +157,7 @@ var relearn_search_index = [ { "breadcrumb": "Shortcodes \u003e Children", "content": "This is a demo child page with no description.\nSo its content is used as description.\n", - "description": "This is a demo child page with no description.", + "description": "This is a demo child page with no description.\nSo its content is used as description.", "tags": [ "children", "non-hidden" @@ -192,7 +192,7 @@ 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.", + "description": "The theme comes with a reasonably configured topbar.\nNevertheless, your requirements may differ from this configuration.", "tags": null, "title": "Topbar Modification", "uri": "/hugo-theme-relearn/basics/topbar/index.html" @@ -200,7 +200,7 @@ var relearn_search_index = [ { "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.", + "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, "title": "History", "uri": "/hugo-theme-relearn/basics/history/index.html" @@ -237,7 +237,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The 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) Warning This shortcode is deprecated in favor of the new resources shortcode. See migration instructions below.\nMigration 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 Examples Custom Title, List of Attachments Ending in pdf or mp4 {{% attachments title=\"Related **files**\" pattern=\".*\\.(pdf|mp4)\" /%}} Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Info Styled Box, Descending Sort Order {{% attachments style=\"info\" sort=\"desc\" /%}} Info movieselectricsheep-flock-244-32500-2.mp4 (340 KB) hugo.txt (20 B) hugo.png (17 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) BachGavotteShort.mp3 (357 KB) adivorciarsetoca00cape.pdf (361 KB) With User-Defined Color and Font Awesome Brand Icon {{% attachments color=\"fuchsia\" icon=\"fa-fw fab fa-hackerrank\" /%}} Attachments 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) 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": " 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, "title": "Attachments", @@ -254,7 +254,7 @@ var relearn_search_index = [ { "breadcrumb": "Categories", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Category :: Basic", "uri": "/hugo-theme-relearn/categories/basic/index.html" @@ -270,7 +270,7 @@ var relearn_search_index = [ { "breadcrumb": "", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Categories", "uri": "/hugo-theme-relearn/categories/index.html" @@ -278,14 +278,14 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Children", "uri": "/hugo-theme-relearn/tags/children/index.html" }, { "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.\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.\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 ", + "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, "title": "Children", @@ -294,7 +294,7 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Config", "uri": "/hugo-theme-relearn/tags/config/index.html" @@ -302,7 +302,7 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Content", "uri": "/hugo-theme-relearn/tags/content/index.html" @@ -310,7 +310,7 @@ var relearn_search_index = [ { "breadcrumb": "Categories", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Category :: Content", "uri": "/hugo-theme-relearn/categories/content/index.html" @@ -334,7 +334,7 @@ var relearn_search_index = [ { "breadcrumb": "Categories", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Category :: Custom", "uri": "/hugo-theme-relearn/categories/custom/index.html" @@ -342,7 +342,7 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Documentation", "uri": "/hugo-theme-relearn/tags/documentation/index.html" @@ -414,7 +414,7 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Non-Hidden", "uri": "/hugo-theme-relearn/tags/non-hidden/index.html" @@ -577,7 +577,7 @@ var relearn_search_index = [ { "breadcrumb": "Categories", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Category :: Taxonomy", "uri": "/hugo-theme-relearn/categories/taxonomy/index.html" @@ -585,7 +585,7 @@ var relearn_search_index = [ { "breadcrumb": "Categories", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Category :: Theming", "uri": "/hugo-theme-relearn/categories/theming/index.html" @@ -593,7 +593,7 @@ var relearn_search_index = [ { "breadcrumb": "Tags", "content": "", - "description": "Documentation for Hugo Relearn Theme", + "description": "", "tags": null, "title": "Tag :: Tutorial", "uri": "/hugo-theme-relearn/tags/tutorial/index.html" diff --git a/index.xml b/index.xml index eee76db7a3..3898a61a25 100644 --- a/index.xml +++ b/index.xml @@ -26,7 +26,7 @@ https://mcshelby.github.io/hugo-theme-relearn/shortcodes/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://mcshelby.github.io/hugo-theme-relearn/shortcodes/index.html - Hugo uses Markdown for its simple content format. + Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. \ No newline at end of file diff --git a/more/credits/index.html b/more/credits/index.html index 7c2394737b..9f8a9a42aa 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/more/credits/index.print.html b/more/credits/index.print.html index fc43b3bbbf..61a3061b3b 100644 --- a/more/credits/index.print.html +++ b/more/credits/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/404.html b/pir/404.html index 54f91689d3..ec206b4995 100644 --- a/pir/404.html +++ b/pir/404.html @@ -5,37 +5,34 @@ - + - + - - 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 8886aac196..4b4360f090 100644 --- a/pir/basics/branding/index.print.html +++ b/pir/basics/branding/index.print.html @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index 4d4f8e1808..25f9f819ac 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -20,7 +20,7 @@ - + Configurrrat'n :: Cap'n Hugo Relearrrn Theme @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/configuration/index.print.html b/pir/basics/configuration/index.print.html index 64d2150981..c6f6a80adb 100644 --- a/pir/basics/configuration/index.print.html +++ b/pir/basics/configuration/index.print.html @@ -20,7 +20,7 @@ - + Configurrrat'n :: Cap'n Hugo Relearrrn Theme @@ -29,20 +29,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index b1db1b80a0..e55c0eac7f 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -28,19 +28,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/customization/index.print.html b/pir/basics/customization/index.print.html index 7e861c5e98..4476955771 100644 --- a/pir/basics/customization/index.print.html +++ b/pir/basics/customization/index.print.html @@ -28,20 +28,19 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index 7bd43db11b..51f7bb3275 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -29,19 +29,18 @@ - - - - - - - - - - - - - + + + + + + + + + + + + - +