diff --git a/404.html b/404.html index 66c1845d46..3b6e70e894 100644 --- a/404.html +++ b/404.html @@ -19,21 +19,21 @@ 404 Page not found :: Hugo Relearn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/branding/index.print.html b/basics/branding/index.print.html index 5c6cb18292..cc688b9bf5 100644 --- a/basics/branding/index.print.html +++ b/basics/branding/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/changelog/index.html b/basics/changelog/index.html index 189422ab5d..cec657ee34 100644 --- a/basics/changelog/index.html +++ b/basics/changelog/index.html @@ -20,21 +20,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/changelog/index.print.html b/basics/changelog/index.print.html index ce949f438c..4094b0cf82 100644 --- a/basics/changelog/index.print.html +++ b/basics/changelog/index.print.html @@ -20,22 +20,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/index.html b/basics/configuration/index.html index 671864e88f..002cee6fea 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/configuration/index.print.html b/basics/configuration/index.print.html index 7adf11a20f..df06b93071 100644 --- a/basics/configuration/index.print.html +++ b/basics/configuration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/customization/index.html b/basics/customization/index.html index 6d9e949eca..92589fc4ca 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/customization/index.print.html b/basics/customization/index.print.html index f93b863fc5..40fdd907f9 100644 --- a/basics/customization/index.print.html +++ b/basics/customization/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/generator/index.html b/basics/generator/index.html index 5f9813afb9..1c413b9ffa 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.print.html b/basics/generator/index.print.html index e1b3f85468..5ebcbabe81 100644 --- a/basics/generator/index.print.html +++ b/basics/generator/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index 491c1639a2..8f19a5d556 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/history/index.print.html b/basics/history/index.print.html index 431e4e33b1..79e0f4e962 100644 --- a/basics/history/index.print.html +++ b/basics/history/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/index.html b/basics/index.html index 97c73a81b8..b88ea00636 100644 --- a/basics/index.html +++ b/basics/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/index.print.html b/basics/index.print.html index d72200f73a..27580d6cb9 100644 --- a/basics/index.print.html +++ b/basics/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/index.xml b/basics/index.xml index 02b8334b68..63713e2f1f 100644 --- a/basics/index.xml +++ b/basics/index.xml @@ -40,9 +40,9 @@ This theme’s repository is: https://github.com/McShelby/hugo-theme-rel https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html - On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your config.toml. The defaults are written in the comments of each option. + On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml. The defaults are written in the comments of each option. Note that some of these options are explained in detail in other sections of this documentation. -​ config.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. +​ hugo.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. Branding @@ -50,16 +50,16 @@ Note that some of these options are explained in detail in other sections of thi Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants. -A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your config. +A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo. Customization https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html - Serving your page from a subfolder If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml + Serving your page from a subfolder If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your hugo.toml baseURL = "https://example.com/mysite/" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226. -Serving your page from the filesystem If you want your page served from the filesystem by using URLs starting with file:// you’ll need the following configuration in your config. +Serving your page from the filesystem If you want your page served from the filesystem by using URLs starting with file:// you’ll need the following configuration in your hugo. Stylesheet generator diff --git a/basics/installation/index.html b/basics/installation/index.html index 343a6f47b4..5ca281ce2a 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/installation/index.print.html b/basics/installation/index.print.html index 07c1487540..b8a37cc45e 100644 --- a/basics/installation/index.print.html +++ b/basics/installation/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/migration/index.html b/basics/migration/index.html index 268fb8e0e1..5bc7d6d810 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/migration/index.print.html b/basics/migration/index.print.html index c82c46f30e..4a240e1fb6 100644 --- a/basics/migration/index.print.html +++ b/basics/migration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 3ad07a4f39..014adedaed 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/requirements/index.print.html b/basics/requirements/index.print.html index 309af5aa32..e9265e112b 100644 --- a/basics/requirements/index.print.html +++ b/basics/requirements/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/topbar/index.html b/basics/topbar/index.html index 6f934ac127..43b5913940 100644 --- a/basics/topbar/index.html +++ b/basics/topbar/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/topbar/index.print.html b/basics/topbar/index.print.html index 03ef17e5f0..913e6110f2 100644 --- a/basics/topbar/index.print.html +++ b/basics/topbar/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/categories/basic/index.html b/categories/basic/index.html index 6ec7621cc2..2521e12f52 100644 --- a/categories/basic/index.html +++ b/categories/basic/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/content/index.html b/categories/content/index.html index 86d97fe3db..6a8db4f6ad 100644 --- a/categories/content/index.html +++ b/categories/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.html b/categories/custom/index.html index 91e7300615..8f63ff388e 100644 --- a/categories/custom/index.html +++ b/categories/custom/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.xml b/categories/custom/index.xml index 031cd22b99..bcb7f81af2 100644 --- a/categories/custom/index.xml +++ b/categories/custom/index.xml @@ -13,7 +13,7 @@ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants. -A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your config. +A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo. \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index ba214b904e..5c41940ce1 100644 --- a/categories/index.html +++ b/categories/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/taxonomy/index.html b/categories/taxonomy/index.html index 9a6b66890f..7d5a0517fc 100644 --- a/categories/taxonomy/index.html +++ b/categories/taxonomy/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.html b/categories/theming/index.html index d24a4e02f8..509af65613 100644 --- a/categories/theming/index.html +++ b/categories/theming/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.xml b/categories/theming/index.xml index 6d4ec97ffb..426ae70739 100644 --- a/categories/theming/index.xml +++ b/categories/theming/index.xml @@ -13,7 +13,7 @@ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants. -A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your config. +A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo. Stylesheet generator diff --git a/config/_default/config.toml b/config/_default/hugo.toml similarity index 100% rename from config/_default/config.toml rename to config/_default/hugo.toml diff --git a/config/_default/params.toml b/config/_default/params.toml index 8c65dd2ce3..c8d63069df 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -114,7 +114,7 @@ disableRandomIds = false additionalContentLanguage = [ "en" ] # Additional code dependencies. -# Default: See config.toml of the theme +# 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. diff --git a/config/testing/config.toml b/config/testing/hugo.toml similarity index 100% rename from config/testing/config.toml rename to config/testing/hugo.toml diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index 4a2da376fa..ee3fda99cf 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.print.html b/cont/archetypes/index.print.html index 78357d53fd..999f334230 100644 --- a/cont/archetypes/index.print.html +++ b/cont/archetypes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/frontmatter/index.html b/cont/frontmatter/index.html index 1b53b96ec9..b206a45ca0 100644 --- a/cont/frontmatter/index.html +++ b/cont/frontmatter/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/frontmatter/index.print.html b/cont/frontmatter/index.print.html index 32d54f7ead..011d981a82 100644 --- a/cont/frontmatter/index.print.html +++ b/cont/frontmatter/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 74207521ad..5e1ec71f77 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/i18n/index.print.html b/cont/i18n/index.print.html index 661ba01843..fc9961825f 100644 --- a/cont/i18n/index.print.html +++ b/cont/i18n/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/imageeffects/index.html b/cont/imageeffects/index.html index 0e95448636..5bfe69fc22 100644 --- a/cont/imageeffects/index.html +++ b/cont/imageeffects/index.html @@ -12,15 +12,15 @@ +Without any settings in your hugo.toml this defaults to"> +Without any settings in your hugo.toml this defaults to"> @@ -32,21 +32,21 @@ Without any settings in your config.toml this defaults to"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/imageeffects/index.print.html b/cont/imageeffects/index.print.html index a54f17b4d4..02e5319f73 100644 --- a/cont/imageeffects/index.print.html +++ b/cont/imageeffects/index.print.html @@ -12,15 +12,15 @@ +Without any settings in your hugo.toml this defaults to"> +Without any settings in your hugo.toml this defaults to"> @@ -32,22 +32,22 @@ Without any settings in your config.toml this defaults to"> - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/index.html b/cont/index.html index 3a8b4f1fee..f75a973485 100644 --- a/cont/index.html +++ b/cont/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/index.print.html b/cont/index.print.html index 151015a7c3..e61c3faf31 100644 --- a/cont/index.print.html +++ b/cont/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/index.xml b/cont/index.xml index ed9d72e123..f9d77f6cb8 100644 --- a/cont/index.xml +++ b/cont/index.xml @@ -49,9 +49,9 @@ Markdown is simple to learn, with minimal extra characters so it’s als https://McShelby.github.io/hugo-theme-relearn/cont/imageeffects/index.html The theme supports non-standard image effects. As described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page. -Instead, you can configure the defaults in your config.toml aswell as overriding these default in the pages frontmatter. +Instead, you can configure the defaults in your hugo.toml aswell as overriding these default in the pages frontmatter. Explicitly set URL query parameter will override the defaults in effect for a page. -Without any settings in your config.toml this defaults to +Without any settings in your hugo.toml this defaults to Menu extra shortcuts @@ -59,7 +59,7 @@ Without any settings in your config.toml this defaults to Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/cont/menushortcuts/index.html You can define additional menu entries or shortcuts in the navigation menu without any link to content. -Basic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add. +Basic configuration Edit the website configuration hugo.toml and add a [[menu.shortcuts]] entry for each link your want to add. Example from the current website: [[menu.shortcuts]] name = "<i class='fab fa-fw fa-github'></i> GitHub repo" identifier = "ds" url = "https://github.com/McShelby/hugo-theme-relearn" weight = 10 [[menu.shortcuts]] name = "<i class='fas fa-fw fa-camera'></i> Showcases" url = "showcase/" weight = 11 [[menu. @@ -69,7 +69,7 @@ Example from the current website: Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/cont/i18n/index.html The Relearn theme is fully compatible with Hugo multilingual mode. -Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute! Full support for languages written right to left Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config. +Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute! Full support for languages written right to left Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your hugo. Taxonomy diff --git a/cont/markdown/index.html b/cont/markdown/index.html index fda86e6d3d..c4d6b499f1 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -30,21 +30,21 @@ Markdown is simple to learn, with minimal extra characters so it’s also qu - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/markdown/index.print.html b/cont/markdown/index.print.html index 85c69c5a44..c722eee938 100644 --- a/cont/markdown/index.print.html +++ b/cont/markdown/index.print.html @@ -30,22 +30,22 @@ Markdown is simple to learn, with minimal extra characters so it’s also qu - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index b6c47684be..48093c531b 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -11,12 +11,12 @@ @@ -30,21 +30,21 @@ Example from the current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/menushortcuts/index.print.html b/cont/menushortcuts/index.print.html index 98b426ea24..f2ad61ca68 100644 --- a/cont/menushortcuts/index.print.html +++ b/cont/menushortcuts/index.print.html @@ -11,12 +11,12 @@ @@ -30,22 +30,22 @@ Example from the current website: - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/index.html b/cont/pages/index.html index 310ba7978c..16a2211259 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/pages/index.print.html b/cont/pages/index.print.html index 96f87e3ee1..fa09de2cd0 100644 --- a/cont/pages/index.print.html +++ b/cont/pages/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/taxonomy/index.html b/cont/taxonomy/index.html index 399d33486a..37fc5ecd41 100644 --- a/cont/taxonomy/index.html +++ b/cont/taxonomy/index.html @@ -30,21 +30,21 @@ The categories are displayed at the bottom of the page in alphabetical order in - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/taxonomy/index.print.html b/cont/taxonomy/index.print.html index d1aaef3914..5a36866767 100644 --- a/cont/taxonomy/index.print.html +++ b/cont/taxonomy/index.print.html @@ -30,22 +30,22 @@ The categories are displayed at the bottom of the page in alphabetical order in - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/css/theme-neon.css b/css/theme-neon.css index 92f2c56da6..a919997758 100644 --- a/css/theme-neon.css +++ b/css/theme-neon.css @@ -24,9 +24,9 @@ --CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */ --BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-HEADER-BG-color: rgba( 0, 0, 0, 0 ); /* background color of menu header */ diff --git a/css/theme-relearn-bright.css b/css/theme-relearn-bright.css index ece28ad43a..60f43bdb58 100644 --- a/css/theme-relearn-bright.css +++ b/css/theme-relearn-bright.css @@ -17,9 +17,9 @@ --CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */ --BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-HEADER-BG-color: rgba( 0, 0, 0, 0 ); /* background color of menu header */ --MENU-HEADER-SEPARATOR-color: rgba( 96, 96, 96, 1 ); /* separator color between menu header and menu */ diff --git a/css/theme-relearn-dark.css b/css/theme-relearn-dark.css index b6106ffbf9..2a19c2b963 100644 --- a/css/theme-relearn-dark.css +++ b/css/theme-relearn-dark.css @@ -17,9 +17,9 @@ --CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */ --BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */ --MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */ diff --git a/css/theme-relearn-light.css b/css/theme-relearn-light.css index 4d6b67ddc2..69cff98c22 100644 --- a/css/theme-relearn-light.css +++ b/css/theme-relearn-light.css @@ -17,9 +17,9 @@ --CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */ --BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */ --MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */ diff --git a/css/theme-zen-dark.css b/css/theme-zen-dark.css index 860bffa3d6..3844a458ee 100644 --- a/css/theme-zen-dark.css +++ b/css/theme-zen-dark.css @@ -17,9 +17,9 @@ --CODE-INLINE-BORDER-color: rgba( 71, 71, 71, 1 ); /* border color of inline code */ --BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-BORDER-color: rgba( 71, 71, 71, 1 ); /* border color between menu and content */ --MENU-TOPBAR-BORDER-color: rgba( 39, 39, 39, 1 ); /* separator color of vertical line between menu and topbar */ diff --git a/css/theme-zen-light.css b/css/theme-zen-light.css index d9d0c3cf8a..e56ed58904 100644 --- a/css/theme-zen-light.css +++ b/css/theme-zen-light.css @@ -17,9 +17,9 @@ --CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */ --BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */ - --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */ - --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */ + --MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ + --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ --MENU-BORDER-color: rgba( 210, 210, 210, 1 ); /* border color between menu and content */ --MENU-TOPBAR-BORDER-color: rgba( 247, 247, 247, 1 ); /* border color of vertical line between menu and topbar */ diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 83965ffb87..5831d26e38 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/contributing/index.print.html b/dev/contributing/index.print.html index 2a521a46b3..ac4391ae37 100644 --- a/dev/contributing/index.print.html +++ b/dev/contributing/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/index.html b/dev/index.html index 4526a53ea7..42f951c91d 100644 --- a/dev/index.html +++ b/dev/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/index.print.html b/dev/index.print.html index 38b94f6ed8..2f6b3510ed 100644 --- a/dev/index.print.html +++ b/dev/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/maintaining/index.html b/dev/maintaining/index.html index 5a25366671..e3aa01bd9d 100644 --- a/dev/maintaining/index.html +++ b/dev/maintaining/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/maintaining/index.print.html b/dev/maintaining/index.print.html index 62e5f3ed8f..096ba0d549 100644 --- a/dev/maintaining/index.print.html +++ b/dev/maintaining/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/screenshots/index.html b/dev/screenshots/index.html index 51948d1f1c..272681d5ec 100644 --- a/dev/screenshots/index.html +++ b/dev/screenshots/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/screenshots/index.print.html b/dev/screenshots/index.print.html index a64a9dcfbb..9750ac7437 100644 --- a/dev/screenshots/index.print.html +++ b/dev/screenshots/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/index.html b/index.html index 6647cf8cf1..a106c493a5 100644 --- a/index.html +++ b/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/index.print.html b/index.print.html index aa225701d1..7f9fb8d5a0 100644 --- a/index.print.html +++ b/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/index.search.js b/index.search.js index 2e9fa96cb6..3a57c5a3d0 100644 --- a/index.search.js +++ b/index.search.js @@ -35,7 +35,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml for documentation in all cases.\n+++ # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # 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 config.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 config.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 config.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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # The title in main menu. # Default: \u003ctitle\u003e # If set, this will be used for the page's menu entry instead of the `title` # option. menuTitle = \"\" # 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. 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 config.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 config.toml and can be # overridden thru URL parameter given to the image. See the documentation for # details. # Default: false imageEffects.border = 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 config.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 config.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 config.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 config.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 config.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 config.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 config.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 config.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 config.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+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering Sibling Menu/Page Entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ title = \"My page\" weight = 5 +++Using a Custom Title for Menu Entries By default, the Relearn theme will use a page’s title attribute for the menu item (or linkTitle if defined).\nBut a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the menuTitle parameter for that purpose:\nFor example (for a page named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++Override Expand State Rules for Menu Entries You can change how the theme expands menu entries on the side of the content with the alwaysopen setting on a per page basis. If alwaysopen=false for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.\nThe theme generates the menu based on the following rules:\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 hierachical 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+++ collapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml [_build] render = \"never\" # no page will be generated so the page does not have a url +++", + "content": "Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml for documentation in all cases.\n+++ # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # The title in main menu. # Default: \u003ctitle\u003e # If set, this will be used for the page's menu entry instead of the `title` # option. menuTitle = \"\" # 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. 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 thru URL parameter given to the image. See the documentation for # details. # Default: false imageEffects.border = 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+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering Sibling Menu/Page Entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ title = \"My page\" weight = 5 +++Using a Custom Title for Menu Entries By default, the Relearn theme will use a page’s title attribute for the menu item (or linkTitle if defined).\nBut a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the menuTitle parameter for that purpose:\nFor example (for a page named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++Override Expand State Rules for Menu Entries You can change how the theme expands menu entries on the side of the content with the alwaysopen setting on a per page basis. If alwaysopen=false for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.\nThe theme generates the menu based on the following rules:\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 hierachical 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+++ collapsibleMenu = true # this adds the expander to the menu entry if not already set in your hugo.toml [_build] render = \"never\" # no page will be generated so the page does not have a url +++", "description": "", "tags": null, "title": "Frontmatter", @@ -43,7 +43,7 @@ var relearn_search_index = [ }, { "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.112.4 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.\n5.24.0.beta 0.112.4 This release requires a newer Hugo version.\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 syntaxhighlightning 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 You now can configure additional options for every theme variant in your config.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, set different colors (if you are using monochrome SVGs) or even different icons (handy if you want to adjust colors for PNGs, GIFs or JPGs) and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\n5.23.0 (2023-11-03) Change With 0.120.0 the author settings move into the [params] array in your config.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\n[params] author = \"Hugo\"to\n[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 config.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 independend 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 independend 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 config.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 config.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 syntaxhighlightning 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 syntaxhighlightning 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 config.toml or for each page thru 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 aswell 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 aswell 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 config.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 documenation.\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 compatiblity 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 config.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 config.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.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 dependend 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\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 config.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 aswell.\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.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true 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).\n# title = \"More\" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn 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.\ntitle = \"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 unnessessary 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 compatiblity.\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 config.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 highlightning 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 thru large number of results.\nTo activate this feature, you need to configure it in your config.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 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 config.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 config.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 config.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 config.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 config.tomlto:\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' 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 config.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 config.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 config.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 config.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your config.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 config.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 Hugos 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 Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard 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 config.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 and canonifyURLs=true in your config.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 Hugos 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 config.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\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 config.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 config.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 config.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.112.4 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.\n5.24.0.beta 0.112.4 This release requires a newer Hugo version.\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 syntaxhighlightning 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 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, set different colors (if you are using monochrome SVGs) or even different icons (handy if you want to adjust colors for PNGs, GIFs or JPGs) and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\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\n[params] author = \"Hugo\"to\n[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 independend 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 independend 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 syntaxhighlightning 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 syntaxhighlightning 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 thru 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 aswell 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 aswell 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 documenation.\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 compatiblity 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.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 dependend 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\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 aswell.\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.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true 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).\n# title = \"More\" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn 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.\ntitle = \"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 unnessessary 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 compatiblity.\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 highlightning 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 thru 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 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:\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' 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 Hugos 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 Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard 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 and canonifyURLs=true 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 Hugos 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": "", "tags": null, "title": "What's New", @@ -51,7 +51,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter A Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number or delete the whole weight parameter entirely.\nSelf defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your config.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.\n", + "content": "Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter A Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number or delete the whole weight parameter entirely.\nSelf defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your hugo.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.\n", "description": "", "tags": null, "title": "Archetypes", @@ -75,7 +75,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\nWithout further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nTip Bookmark this page and the official Commonmark reference for easy future reference!\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 In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitution This Markdown dialect supports an extension to 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.\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 In GFM (GitHub Flavored Markdown) 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 This Markdown dialect supports an extension to add definition lists. 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.\nIn GFM (GitHub Flavored Markdown) 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 grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Result grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables In GFM (GitHub Flavored Markdown) 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 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 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 In GFM (GitHub Flavored Markdown) 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 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 This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable thru your config.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", + "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\nWithout further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nTip Bookmark this page and the official Commonmark reference for easy future reference!\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 In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitution This Markdown dialect supports an extension to 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.\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 In GFM (GitHub Flavored Markdown) 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 This Markdown dialect supports an extension to add definition lists. 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.\nIn GFM (GitHub Flavored Markdown) 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 grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Result grunt.initConfig({ assemble: { options: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, pages: { options: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables In GFM (GitHub Flavored Markdown) 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 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 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 In GFM (GitHub Flavored Markdown) 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 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 This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable thru 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": "", "tags": [ "Content" @@ -85,7 +85,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "The theme supports non-standard image effects.\nAs described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page.\nInstead, you can configure the defaults in your config.toml aswell 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 config.toml this defaults to\n​ config.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden in a pages frontmatter by eg.\n​ frontmatter +++ [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​ Result border = true lightbox = false shadow = false bg-white = true 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\" alt=\"Minion\" class=\"bg-white border 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 config.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 config.toml or pages frontmatter.\n", + "content": "The theme supports non-standard image effects.\nAs described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page.\nInstead, you can configure the defaults in your hugo.toml aswell 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\n​ hugo.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden in a pages frontmatter by eg.\n​ frontmatter +++ [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​ Result border = true lightbox = false shadow = false bg-white = true 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\" alt=\"Minion\" class=\"bg-white border 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": "", "tags": null, "title": "Image Effects", @@ -93,7 +93,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40By default, shortcuts are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n[Shortcuts-Title] other = \"\u003cYour value\u003e\"Read more about hugo menu and hugo i18n translation strings\nConfiguration for Multilingual mode When using a multilingual website, you can set different menus for each language. In the config.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the current website:\n[languages] [languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = \"more/credits/\" weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = \"tags/\" weight = 40 [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = \"more/credits/\" weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = \"tags/\" weight = 40Read more about hugo menu and hugo multilingual menus\nShortcuts to pages inside of your project If you have shortcuts to pages inside of your project and you don’t want them to show up in page menu section, you have two choices:\nMake the page file for the shortcut a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn 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.\ntitle = \"Credits\" ", + "content": "You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration hugo.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40By default, shortcuts are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n[Shortcuts-Title] other = \"\u003cYour value\u003e\"Read more about hugo menu and hugo i18n translation strings\nConfiguration for Multilingual mode When using a multilingual website, you can set different menus for each language. In the hugo.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the current website:\n[languages] [languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = \"more/credits/\" weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = \"tags/\" weight = 40 [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = \"more/credits/\" weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = \"tags/\" weight = 40Read more about hugo menu and hugo multilingual menus\nShortcuts to pages inside of your project If you have shortcuts to pages inside of your project and you don’t want them to show up in page menu section, you have two choices:\nMake the page file for the shortcut a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn 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.\ntitle = \"Credits\" ", "description": "", "tags": null, "title": "Menu extra shortcuts", @@ -101,7 +101,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "The Relearn theme is fully compatible with Hugo multilingual mode.\nAvailable languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute! Full support for languages written right to left Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config.toml file.\nFor example with current English and Piratized English website.\nNote Make sure your default language is defined as the first one in the [languages] array, as the theme needs to make assumptions on it\n# English is the default language defaultContentLanguage = \"en\" [languages] [languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\"Then, for each new page, append the id of the language to the file.\nSingle file my-page.md is split in two files: in English: my-page.md in Piratized English: my-page.pir.md Single file _index.md is split in two files: in English: _index.md in Piratized English: _index.pir.md Info Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.\nTip Use slug frontmatter parameter to translate urls too.\nSearch In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.\nWarning Although the theme supports a wide variety of supported languages, the site’s search via the Lunr search library does not. You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:\nCzech Indonesian Polish Swahili Search with mixed language support In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your config.toml to broaden search.\n[params] additionalContentLanguage = [ \"en\" ]As this is an array, you can add multiple additional languages.\nNote Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in zh-CN, you have to add just zh to this parameter.\nOverwrite translation strings Translations strings are used for common default values used in the theme (Edit button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.\nTo override these values, create a new file in your local i18n folder i18n/\u003cidlanguage\u003e.toml and inspire yourself from the theme themes/hugo-theme-relearn/i18n/en.toml\nDisable language switching Switching the language in the browser is a great feature, but for some reasons you may want to disable it.\nJust set disableLanguageSwitchingButton=true in your config.toml\n[params] # When using multilingual website, disable the switch language button. disableLanguageSwitchingButton = true", + "content": "The Relearn theme is fully compatible with Hugo multilingual mode.\nAvailable languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute! Full support for languages written right to left Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your hugo.toml file.\nFor example with current English and Piratized English website.\nNote Make sure your default language is defined as the first one in the [languages] array, as the theme needs to make assumptions on it\n# English is the default language defaultContentLanguage = \"en\" [languages] [languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\"Then, for each new page, append the id of the language to the file.\nSingle file my-page.md is split in two files: in English: my-page.md in Piratized English: my-page.pir.md Single file _index.md is split in two files: in English: _index.md in Piratized English: _index.pir.md Info Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.\nTip Use slug frontmatter parameter to translate urls too.\nSearch In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.\nWarning Although the theme supports a wide variety of supported languages, the site’s search via the Lunr search library does not. You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:\nCzech Indonesian Polish Swahili Search with mixed language support In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your hugo.toml to broaden search.\n[params] additionalContentLanguage = [ \"en\" ]As this is an array, you can add multiple additional languages.\nNote Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in zh-CN, you have to add just zh to this parameter.\nOverwrite translation strings Translations strings are used for common default values used in the theme (Edit button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.\nTo override these values, create a new file in your local i18n folder i18n/\u003cidlanguage\u003e.toml and inspire yourself from the theme themes/hugo-theme-relearn/i18n/en.toml\nDisable language switching Switching the language in the browser is a great feature, but for some reasons you may want to disable it.\nJust set disableLanguageSwitchingButton=true in your hugo.toml\n[params] # When using multilingual website, disable the switch language button. disableLanguageSwitchingButton = true", "description": "", "tags": null, "title": "Multilingual and i18n", @@ -109,7 +109,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "The Relearn theme supports Hugo’s default taxonomies tag and category out of the box.\nConfiguration Just add tags and/or categories to any page. They can be given as a single string or an array of strings.\n+++ categories = [\"taxonomy\", \"content\"] tags = \"tutorial\" title = \"Taxonomy\" +++Behavior The tags are displayed at the top of the page in alphabetical order.\nThe categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own content-footer.html partial.\nEach item is a link to a taxonomy page displaying all the articles with the given term.\nList all the tags In the config.toml file you can add a shortcut to display all the tags and categories\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" [[menu.shortcuts]] name = \"\u003ci class='fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = \"/categories\"Customization If you define custom taxonomies and want to display a list of them somewhere on your page (often in the layouts/partials/content-footer.html) you can call a partial that does the job for you:\n{{- partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. taxonomy \u003cempty\u003e The plural name of the taxonomy to display as used in your frontmatter. class \u003cempty\u003e Additional CSS classes set on the outermost generated HTML element.\nIf set to tags you will get the visuals for displaying the tags taxonomy, otherwise it will be a simple list of links as for the categories taxonomy. style primary The style scheme used if class is tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used if class is tags. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon \u003cempty\u003e An optional Font Awesome icon name set to the left of the list. ", + "content": "The Relearn theme supports Hugo’s default taxonomies tag and category out of the box.\nConfiguration Just add tags and/or categories to any page. They can be given as a single string or an array of strings.\n+++ categories = [\"taxonomy\", \"content\"] tags = \"tutorial\" title = \"Taxonomy\" +++Behavior The tags are displayed at the top of the page in alphabetical order.\nThe categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own content-footer.html partial.\nEach item is a link to a taxonomy page displaying all the articles with the given term.\nList all the tags In the hugo.toml file you can add a shortcut to display all the tags and categories\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" [[menu.shortcuts]] name = \"\u003ci class='fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = \"/categories\"Customization If you define custom taxonomies and want to display a list of them somewhere on your page (often in the layouts/partials/content-footer.html) you can call a partial that does the job for you:\n{{- partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes page \u003cempty\u003e Mandatory reference to the page. taxonomy \u003cempty\u003e The plural name of the taxonomy to display as used in your frontmatter. class \u003cempty\u003e Additional CSS classes set on the outermost generated HTML element.\nIf set to tags you will get the visuals for displaying the tags taxonomy, otherwise it will be a simple list of links as for the categories taxonomy. style primary The style scheme used if class is tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used if class is tags. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon \u003cempty\u003e An optional Font Awesome icon name set to the left of the list. ", "description": "", "tags": "tutorial", "title": "Taxonomy", @@ -136,7 +136,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eInstall the theme Install the Relearn theme by following this documentation using Hugo’s module system.\nThis theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, you can download the theme as .zip file and extract it in the themes directory\nFrom Git If you install the theme from your git repository or GitHub, you have several options.\nIf you use the head of the main branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.\nAdditionally you can checkout one of the tagged versions. These tagged versions correspond to an official releases from the GitHub repository.\nBesides the usual version tags (eg 1.2.3) there are also tags for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) released version making it easier for you to pin the theme to a certain version.\nBasic configuration When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (config.toml) and set the theme as the default. You can also add the [outputs] section to enable the search functionality.\n# Change the default theme to be use when building the site with Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"SEARCH\"]Create your first chapter page Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.\n### Chapter 1 # Basics Discover what this Hugo theme is all about and the core concepts behind it.renders as\nThe Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command\nhugo new --kind chapter basics/_index.mdBy opening the given file, you should see the property chapter=true on top, meaning this page is a chapter.\nBy default all chapters and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata.\nCreate your first content pages Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.mdFeel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nLaunching the website locally Launch by using the following command:\nhugo serveGo to http://localhost:1313\nYou should notice three things:\nYou have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files. The home page explains how to customize it by following the instructions. When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes. Neat! Build the website When your site is ready to deploy, run the following command:\nhugoA public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.\nNote This website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages.\n", + "content": "The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eInstall the theme Install the Relearn theme by following this documentation using Hugo’s module system.\nThis theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, you can download the theme as .zip file and extract it in the themes directory\nFrom Git If you install the theme from your git repository or GitHub, you have several options.\nIf you use the head of the main branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.\nAdditionally you can checkout one of the tagged versions. These tagged versions correspond to an official releases from the GitHub repository.\nBesides the usual version tags (eg 1.2.3) there are also tags for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) released version making it easier for you to pin the theme to a certain version.\nBasic configuration When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (hugo.toml) and set the theme as the default. You can also add the [outputs] section to enable the search functionality.\n# Change the default theme to be use when building the site with Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"SEARCH\"]Create your first chapter page Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.\n### Chapter 1 # Basics Discover what this Hugo theme is all about and the core concepts behind it.renders as\nThe Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command\nhugo new --kind chapter basics/_index.mdBy opening the given file, you should see the property chapter=true on top, meaning this page is a chapter.\nBy default all chapters and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata.\nCreate your first content pages Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.mdFeel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nLaunching the website locally Launch by using the following command:\nhugo serveGo to http://localhost:1313\nYou should notice three things:\nYou have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files. The home page explains how to customize it by following the instructions. When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes. Neat! Build the website When your site is ready to deploy, run the following command:\nhugoA public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.\nNote This website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages.\n", "description": "", "tags": [ "documentation" @@ -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 config.toml. The defaults are written in the comments of each option.\nNote that some of these options are explained in detail in other sections of this documentation.\n​ config.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # 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. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These options set your color variant. # 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 explaination. # 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 = \"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 tihs 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 config.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 given URL is prepended to the # relative file path of a the displayed page. The URL must end with a `/`. # This is useful if you wnat 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/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # Hide the search box. # Default: false # If the searc box is sisabled, 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. 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 opition 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 effects can be overridden in the page's frontmatter or thru URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # 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 = \"_blank\" # 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. The defaults are written in the comments of each option.\nNote that some of these options are explained in detail in other sections of this documentation.\n​ hugo.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # 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. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These options set your color variant. # 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 explaination. # 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 = \"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 tihs 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 given URL is prepended to the # relative file path of a the displayed page. The URL must end with a `/`. # This is useful if you wnat 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/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # Hide the search box. # Default: false # If the searc box is sisabled, 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. 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 opition 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 effects can be overridden in the page's frontmatter or thru URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # 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 = \"_blank\" # 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": "", "tags": [ "config" @@ -167,7 +167,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants.\nA color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your config.toml.\nThe Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The interactive variant generator may help you with this task.\nOnce configured in your config.toml, you can select them with the variant selector at the bottom of the menu.\nChange the Variant (Simple) Single Variant Set the themeVariant value to the name of your theme file. That’s it! Your site will be displayed in this variant only.\n​ config.toml [params] themeVariant = \"relearn-light\" Note Your theme variant file must reside in your site’s static/css directory or in the theme’s static/css directory and the file name must start with theme- and end wit .css. In the above example, the path of your theme file must be static/css/theme-relearn-light.css.\nIf you want to make changes to a shipped color variant, create a copy in your site’s static/css directory. Don’t edit the file in the theme’s directory!\nMultiple Variants You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\n​ config.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Tip The theme provides an advanced configuration mode, combining the functionality for multiple variants with the below possibilities of adjusting to your OS settings, logo and syntax highlightning and even more!\nAlthough all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.\nAdjust to OS Settings You can also cause the site to adjust to your OS settings for light/dark mode. Just set the themeVariant to auto to become an auto mode variant. That’s it.\nYou can use the auto value with the single or multiple variants option. If you are using multiple variants, you can drop auto at any position in the option’s array, but usually it makes sense to set it in the first position and make it the default.\n​ config.toml [params] themeVariant = [ \"auto\", \"red\" ] If you don’t configure anything else, the theme will default to use relearn-light for light mode and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant option if present.\nIn the above example, you would end with red for light mode and the default of relearn-dark for dark mode.\nIf you don’t like that behavior, you can explicitly set themeVariantAuto. The first entry in the array is the color variant for light mode, the second for dark mode.\n​ config.toml [params] themeVariantAuto = [ \"learn\", \"neon\" ] Change the Favicon If your favicon is a SVG, PNG or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png or favicon.ico respectively.\nIf you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file layouts/partials/favicon.html in your site’s directory and write something like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change the Logo Create a new file in layouts/partials/logo.html of your site. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNote The size of the logo will adapt automatically.\nSyntax Highlightning If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation according to Hugo’s documentation and provide a syntax highlighting stylesheet file.\nYou can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to static/css/chroma-\u003cNAME\u003e.css. To use it with your color variant you have to define --CODE-theme: \u003cNAME\u003e in the color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.\nChange the Variant (Advanced) The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.\nLike with the multiple variants option, you are defining your theme variants in an array but now not by simple strings but in a table with suboptions.\nAgain, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\n​ config.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] you now write it that way:\n​ config.toml [params] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form static/css/theme-\u003cIDENTIFIER\u003e.css. name see notes The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. auto \u003cempty\u003e If set, the variant is treated as an auto mode variant. It has the same behavior as the themeVariantAuto option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. Example Configuration of This Site ​ config.toml [params] [[params.themeVariant]] identifier = \"relearn-auto\" name = \"Relearn Light/Dark\" auto = [] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" [[params.themeVariant]] identifier = \"zen-auto\" name = \"Zen Light/Dark\" auto = [ \"zen-light\", \"zen-dark\" ] [[params.themeVariant]] identifier = \"zen-light\" [[params.themeVariant]] identifier = \"zen-dark\" [[params.themeVariant]] identifier = \"neon\" Modify Shipped Variants In case you like a shipped variant but only want to tweak some aspects, you have two choices:\nCopy and change\nYou can copy the shipped variant file from the theme’s static/css directory to the site’s static/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your config.toml by the choosen name.\nCreate and import\nYou can create a new variant file in the site’s static/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your config.toml by the choosen name.\nFor example, you want to use the relearn-light variant but want to change the syntax highlightning schema to the one used in the neon variant. For that, create a new static/css/theme-my-branding.css in your site’s directory and add the following lines:\n​ static/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: learn; /* name of the chroma styleheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */ } Afterwards put this in your config.toml to use your new variant:\n​ config.toml [params] themeVariant = \"my-branding\" In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant but keep your modifications.\n", + "content": "The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants.\nA color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo.toml.\nThe Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The interactive variant generator may help you with this task.\nOnce configured in your hugo.toml, you can select them with the variant selector at the bottom of the menu.\nChange the Variant (Simple) Single Variant Set the themeVariant value to the name of your theme file. That’s it! Your site will be displayed in this variant only.\n​ hugo.toml [params] themeVariant = \"relearn-light\" Note Your theme variant file must reside in your site’s static/css directory or in the theme’s static/css directory and the file name must start with theme- and end wit .css. In the above example, the path of your theme file must be static/css/theme-relearn-light.css.\nIf you want to make changes to a shipped color variant, create a copy in your site’s static/css directory. Don’t edit the file in the theme’s directory!\nMultiple Variants You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\n​ hugo.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Tip The theme provides an advanced configuration mode, combining the functionality for multiple variants with the below possibilities of adjusting to your OS settings, logo and syntax highlightning and even more!\nAlthough all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.\nAdjust to OS Settings You can also cause the site to adjust to your OS settings for light/dark mode. Just set the themeVariant to auto to become an auto mode variant. That’s it.\nYou can use the auto value with the single or multiple variants option. If you are using multiple variants, you can drop auto at any position in the option’s array, but usually it makes sense to set it in the first position and make it the default.\n​ hugo.toml [params] themeVariant = [ \"auto\", \"red\" ] If you don’t configure anything else, the theme will default to use relearn-light for light mode and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant option if present.\nIn the above example, you would end with red for light mode and the default of relearn-dark for dark mode.\nIf you don’t like that behavior, you can explicitly set themeVariantAuto. The first entry in the array is the color variant for light mode, the second for dark mode.\n​ hugo.toml [params] themeVariantAuto = [ \"learn\", \"neon\" ] Change the Favicon If your favicon is a SVG, PNG or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png or favicon.ico respectively.\nIf you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file layouts/partials/favicon.html in your site’s directory and write something like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change the Logo Create a new file in layouts/partials/logo.html of your site. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNote The size of the logo will adapt automatically.\nSyntax Highlightning If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation according to Hugo’s documentation and provide a syntax highlighting stylesheet file.\nYou can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to static/css/chroma-\u003cNAME\u003e.css. To use it with your color variant you have to define --CODE-theme: \u003cNAME\u003e in the color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css and hugo.toml of the exampleSite.\nChange the Variant (Advanced) The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.\nLike with the multiple variants option, you are defining your theme variants in an array but now not by simple strings but in a table with suboptions.\nAgain, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.\n​ hugo.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] you now write it that way:\n​ hugo.toml [params] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond to the name of a color variant either in your site’s or the theme’s directory in the form static/css/theme-\u003cIDENTIFIER\u003e.css. name see notes The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. auto \u003cempty\u003e If set, the variant is treated as an auto mode variant. It has the same behavior as the themeVariantAuto option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. Example Configuration of This Site ​ hugo.toml [params] [[params.themeVariant]] identifier = \"relearn-auto\" name = \"Relearn Light/Dark\" auto = [] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" [[params.themeVariant]] identifier = \"zen-auto\" name = \"Zen Light/Dark\" auto = [ \"zen-light\", \"zen-dark\" ] [[params.themeVariant]] identifier = \"zen-light\" [[params.themeVariant]] identifier = \"zen-dark\" [[params.themeVariant]] identifier = \"neon\" Modify Shipped Variants In case you like a shipped variant but only want to tweak some aspects, you have two choices:\nCopy and change\nYou can copy the shipped variant file from the theme’s static/css directory to the site’s static/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your hugo.toml by the choosen name.\nCreate and import\nYou can create a new variant file in the site’s static/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your hugo.toml by the choosen name.\nFor example, you want to use the relearn-light variant but want to change the syntax highlightning schema to the one used in the neon variant. For that, create a new static/css/theme-my-branding.css in your site’s directory and add the following lines:\n​ static/css/theme-my-branding.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: learn; /* name of the chroma styleheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */ } Afterwards put this in your hugo.toml to use your new variant:\n​ hugo.toml [params] themeVariant = \"my-branding\" In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant but keep your modifications.\n", "description": "", "tags": null, "title": "Branding", @@ -175,7 +175,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "Serving your page from a subfolder If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nServing your page from the filesystem If you want your page served from the filesystem by using URLs starting with file:// you’ll need the following configuration in your config.toml:\nrelativeURLs = trueThe theme will append an additional index.html to all page bundle links by default to make the page be servable from the file system. If you don’t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your config.toml\n[params] disableExplicitIndexURLs = true Note If you want to use the search feature from the file system using an older installation of the theme make sure to change your outputformat for the homepage from the now deprecated JSON to SEARCH as seen below.\nActivate search If not already present, add the following lines in your config.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\"]This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library. Note that the SEARCH outputformat was named JSON in previous releases but was implemented differently. Although JSON still works, it is now deprecated.\nActivate dedicated search page You can add a dedicated search page for your page by adding the SEARCHPAGE outputformat to your home page by adding the following lines in your config.toml file. This will cause Hugo to generate a new file http://example.com/mysite/search.html.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\", \"SEARCHPAGE\"]You can access this page by either clicking on the magnifier glass or by typing some search term and pressing ENTER inside of the menu’s search box .\nNote To have Hugo create the dedicated search page successfully, you must not generate the URL http://example.com/mysite/search.html from your own content. This can happen if you set uglyURLs=true in your config.toml and defining a Markdown file content/search.md.\nTo make sure, there is no duplicate content for any given URL of your project, run hugo --printPathWarnings.\nActivate print support You can activate print support to add the capability to print whole chapters or even the complete site. Just add the PRINT output format to your home, section and page in your config.toml as seen below:\n[outputs] home = [\"HTML\", \"RSS\", \"PRINT\", \"SEARCH\"] section = [\"HTML\", \"RSS\", \"PRINT\"] page = [\"HTML\", \"RSS\", \"PRINT\"]This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.\nNote The resulting URL will not be configured ugly in terms of Hugo’s URL handling even if you’ve set uglyURLs=true in your config.toml. This is due to the fact that for one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy with the resulting URLs you can manually redefine outputFormats.PRINT in your own config.toml to your liking.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure the landingPageName for the defined languages:\n[languages] [languages.en] ... [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [languages.pir] ... [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ...If this option is not configured for a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\"The home button is going to look like this:\nSocial Media Meta Tags You can add social media meta tags for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the Hugo docs.\nChange the Menu Width The menu width adjusts automatically for different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 0 M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem The values for the screen width breakpoints aren’t configurable.\nIf you want to adjust the menu width you can define the following CSS variables in your custom-header.html. Note that --MENU-WIDTH-S doesn’t exist as the menu is always hidden for small screen sizes.\n:root { --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Own Shortcodes with JavaScript Dependencies Certain shortcodes make use of additional JavaScript files. The theme only loads these dependencies if the shortcode is used. To do so correctly the theme adds management code in various files.\nYou can you use this mechanism in your own shortcodes. Say you want to add a shortcode myshortcode that also requires the jquery JavaScript library.\nWrite the shortcode file layouts/shortcodes/myshortcode.html and add the following line\n{{- .Store.Set \"hasMyShortcode\" true }} Add the following snippet to your config.toml\n[params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = \"MyShortcode\" location = \"footer\" Add the dependency loader file layouts/partials/dependencies/myshortcode.html. The loader file will be appended to your header or footer, dependend on the location setting in your config.toml.\n\u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e Character casing is relevant!\nthe name setting in your config.toml must match the key (that needs to be prefixed with a has) you used for the store in your layouts/shortcodes/myshortcode.html. the key on params.relearn.dependencies in your config.toml must match the base file name of your loader file. See the math, mermaid and openapi shortcodes for examples.\nOutput Formats Certain parts of the theme can be changed for support of your own output formats. Eg. if you define a new output format PLAINTEXT in your config.toml, you can add a file layouts/partials/header.plaintext.html to change the way, the page header should look like for that output format.\nReact to Variant Switches in JavaScript Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event themeVariantLoaded on the document will be dispatched. You can add an event listener and react to changes.\ndocument.addEventListener( 'themeVariantLoaded', function( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\nheader.html: the header of the page. See output-formats footer.html: the footer of the page. See output-formats body.html: the body of the page. The body may contain of one or many articles. See output-formats article.html: the output for a single article, can contain elements around your content. See output-formats menu.html: left menu. Not meant to be overwritten search.html: search box. Not meant to be overwritten custom-header.html: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file. custom-footer.html: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include javascript HTML tag directive in your file. favicon.html: the favicon heading-pre.html: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s headingPre setting into account. heading-post.html: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s headingPost setting into account. logo.html: the logo, on top left hand corner meta.html: HTML meta tags, if you want to change default behavior menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s menuPre setting into account. menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s menuPost setting into account. menu-footer.html: footer of the the left menu toc.html: table of contents content.html: the content page itself. This can be overridden if you want to display page’s meta data above or below the content. content-header.html: header above the title, has a default implementation but you can overwrite it if you don’t like it. content-footer.html: footer below the content, has a default implementation but you can overwrite it if you don’t like it. ", + "content": "Serving your page from a subfolder If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your hugo.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nServing your page from the filesystem If you want your page served from the filesystem by using URLs starting with file:// you’ll need the following configuration in your hugo.toml:\nrelativeURLs = trueThe theme will append an additional index.html to all page bundle links by default to make the page be servable from the file system. If you don’t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your hugo.toml\n[params] disableExplicitIndexURLs = true Note If you want to use the search feature from the file system using an older installation of the theme make sure to change your outputformat for the homepage from the now deprecated JSON to SEARCH as seen below.\nActivate search If not already present, add the following lines in your hugo.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\"]This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library. Note that the SEARCH outputformat was named JSON in previous releases but was implemented differently. Although JSON still works, it is now deprecated.\nActivate dedicated search page You can add a dedicated search page for your page by adding the SEARCHPAGE outputformat to your home page by adding the following lines in your hugo.toml file. This will cause Hugo to generate a new file http://example.com/mysite/search.html.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\", \"SEARCHPAGE\"]You can access this page by either clicking on the magnifier glass or by typing some search term and pressing ENTER inside of the menu’s search box .\nNote To have Hugo create the dedicated search page successfully, you must not generate the URL http://example.com/mysite/search.html from your own content. This can happen if you set uglyURLs=true in your hugo.toml and defining a Markdown file content/search.md.\nTo make sure, there is no duplicate content for any given URL of your project, run hugo --printPathWarnings.\nActivate print support You can activate print support to add the capability to print whole chapters or even the complete site. Just add the PRINT output format to your home, section and page in your hugo.toml as seen below:\n[outputs] home = [\"HTML\", \"RSS\", \"PRINT\", \"SEARCH\"] section = [\"HTML\", \"RSS\", \"PRINT\"] page = [\"HTML\", \"RSS\", \"PRINT\"]This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.\nNote The resulting URL will not be configured ugly in terms of Hugo’s URL handling even if you’ve set uglyURLs=true in your hugo.toml. This is due to the fact that for one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy with the resulting URLs you can manually redefine outputFormats.PRINT in your own hugo.toml to your liking.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure the landingPageName for the defined languages:\n[languages] [languages.en] ... [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [languages.pir] ... [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ...If this option is not configured for a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\"The home button is going to look like this:\nSocial Media Meta Tags You can add social media meta tags for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the Hugo docs.\nChange the Menu Width The menu width adjusts automatically for different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 0 M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem The values for the screen width breakpoints aren’t configurable.\nIf you want to adjust the menu width you can define the following CSS variables in your custom-header.html. Note that --MENU-WIDTH-S doesn’t exist as the menu is always hidden for small screen sizes.\n:root { --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Own Shortcodes with JavaScript Dependencies Certain shortcodes make use of additional JavaScript files. The theme only loads these dependencies if the shortcode is used. To do so correctly the theme adds management code in various files.\nYou can you use this mechanism in your own shortcodes. Say you want to add a shortcode myshortcode that also requires the jquery JavaScript library.\nWrite the shortcode file layouts/shortcodes/myshortcode.html and add the following line\n{{- .Store.Set \"hasMyShortcode\" true }} Add the following snippet to your hugo.toml\n[params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = \"MyShortcode\" location = \"footer\" Add the dependency loader file layouts/partials/dependencies/myshortcode.html. The loader file will be appended to your header or footer, dependend on the location setting in your hugo.toml.\n\u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e Character casing is relevant!\nthe name setting in your hugo.toml must match the key (that needs to be prefixed with a has) you used for the store in your layouts/shortcodes/myshortcode.html. the key on params.relearn.dependencies in your hugo.toml must match the base file name of your loader file. See the math, mermaid and openapi shortcodes for examples.\nOutput Formats Certain parts of the theme can be changed for support of your own output formats. Eg. if you define a new output format PLAINTEXT in your hugo.toml, you can add a file layouts/partials/header.plaintext.html to change the way, the page header should look like for that output format.\nReact to Variant Switches in JavaScript Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event themeVariantLoaded on the document will be dispatched. You can add an event listener and react to changes.\ndocument.addEventListener( 'themeVariantLoaded', function( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\nheader.html: the header of the page. See output-formats footer.html: the footer of the page. See output-formats body.html: the body of the page. The body may contain of one or many articles. See output-formats article.html: the output for a single article, can contain elements around your content. See output-formats menu.html: left menu. Not meant to be overwritten search.html: search box. Not meant to be overwritten custom-header.html: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file. custom-footer.html: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include javascript HTML tag directive in your file. favicon.html: the favicon heading-pre.html: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s headingPre setting into account. heading-post.html: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s headingPost setting into account. logo.html: the logo, on top left hand corner meta.html: HTML meta tags, if you want to change default behavior menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s menuPre setting into account. menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s menuPost setting into account. menu-footer.html: footer of the the left menu toc.html: table of contents content.html: the content page itself. This can be overridden if you want to display page’s meta data above or below the content. content-header.html: header above the title, has a default implementation but you can overwrite it if you don’t like it. content-footer.html: footer below the content, has a default implementation but you can overwrite it if you don’t like it. ", "description": "", "tags": null, "title": "Customization", @@ -183,7 +183,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "This interactive tool may help you to generate your own color variant stylesheet.\nShow usage instructions To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.\nThe graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.\nThe arrowed lines reflect how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this select the neon variant and modify the different heading colors. There, colors for the heading h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can browse to other pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and copy it into your site’s static/css directory. Afterwards you have to adjust the themeVariant parameter in your config.toml to your chosen file name.\nEg. if your new variants file is named theme-my-custom-variant.css, you have to set themeVariant='my-custom-variant' to use it.\nDownload variant Reset variant\nGraph Download variant Reset variant\n", + "content": "This interactive tool may help you to generate your own color variant stylesheet.\nShow usage instructions To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.\nThe graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.\nThe arrowed lines reflect how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this select the neon variant and modify the different heading colors. There, colors for the heading h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant selector will show a “My custom variant” entry and your changes are stored in the browser. You can browse to other pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and copy it into your site’s static/css directory. Afterwards you have to adjust the themeVariant parameter in your hugo.toml to your chosen file name.\nEg. if your new variants file is named theme-my-custom-variant.css, you have to set themeVariant='my-custom-variant' to use it.\nDownload variant Reset variant\nGraph Download variant Reset variant\n", "description": "", "tags": null, "title": "Stylesheet generator", @@ -261,7 +261,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The button shortcode displays a clickable button with adjustable color, title and icon.\nGet Hugo Get Hugo\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" icon=\"dragon\" %}}Get Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once the button is clicked, it opens another browser tab for the given URL.\nParameter Name Default Notes href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.\n- if starting with javascript: all following text will be executed in your browser\n- every other string will be interpreted as URL style transparent The style scheme used for the button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) iconposition left Places the icon to the left or right of the title. target see notes The destination frame/window if href is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:\n- the setting of externalLinkTarget or _blank if not set, for any address starting with http:// or https://\n- no specific value for all other links type see notes The button type if href is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to button \u003ccontent\u003e see notes Arbitrary text for the button title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo Get Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo\nIcon Empty {{% button href=\"https://gohugo.io/\" icon=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}{{% /button %}} To the Left {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}Get Hugo{{% /button %}} Get Hugo To the Right {{% button href=\"https://gohugo.io/\" icon=\"download\" iconposition=\"right\" %}}Get Hugo{{% /button %}}Get Hugo Override for Severity {{% button href=\"https://gohugo.io/\" icon=\"dragon\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Hugo in same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Hugo in new Window/Frame (default){{% /button %}}Get Hugo in same Window/Frame Get Hugo in new Window/Frame (default)\nOther With User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" icon=\"fab fa-hackerrank\" %}}Get **Hugo**{{% /button %}} Get Hugo Severity Style with All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Tip Button to Internal Page {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button with JavaScript Action If your JavaScript action does not change the focus afterwards, make sure to call this.blur() in the end to unselect the button.\n{{% button style=\"primary\" icon=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element To use native HTML elements in your Markdown, add this in your config.toml\n[markup.goldmark.renderer] unsafe = true\u003cform action=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", + "content": "The button shortcode displays a clickable button with adjustable color, title and icon.\nGet Hugo Get Hugo\nUsage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" icon=\"dragon\" %}}Get Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once the button is clicked, it opens another browser tab for the given URL.\nParameter Name Default Notes href \u003cempty\u003e Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.\n- if starting with javascript: all following text will be executed in your browser\n- every other string will be interpreted as URL style transparent The style scheme used for the button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default.\n- for severity styles: a nice matching color for the severity\n- for all other styles: the corresponding color icon see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.\n- for severity styles: a nice matching icon for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) iconposition left Places the icon to the left or right of the title. target see notes The destination frame/window if href is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:\n- the setting of externalLinkTarget or _blank if not set, for any address starting with http:// or https://\n- no specific value for all other links type see notes The button type if href is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to button \u003ccontent\u003e see notes Arbitrary text for the button title. Depending on the style there may be a default title. Any given value will overwrite the default.\n- for severity styles: the matching title for the severity\n- for all other styles: \u003cempty\u003e\nIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Get Hugo Get Hugo Get Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo Get Hugo Get Hugo Get Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Hugo{{% /button %}}Get Hugo Get Hugo\nIcon Empty {{% button href=\"https://gohugo.io/\" icon=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}{{% /button %}} To the Left {{% button href=\"https://gohugo.io/\" icon=\"download\" %}}Get Hugo{{% /button %}} Get Hugo To the Right {{% button href=\"https://gohugo.io/\" icon=\"download\" iconposition=\"right\" %}}Get Hugo{{% /button %}}Get Hugo Override for Severity {{% button href=\"https://gohugo.io/\" icon=\"dragon\" style=\"warning\" %}}Get Hugo{{% /button %}} Get Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Hugo in same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Hugo in new Window/Frame (default){{% /button %}}Get Hugo in same Window/Frame Get Hugo in new Window/Frame (default)\nOther With User-Defined Color, Font Awesome Brand Icon and Markdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" icon=\"fab fa-hackerrank\" %}}Get **Hugo**{{% /button %}} Get Hugo Severity Style with All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Tip Button to Internal Page {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button with JavaScript Action If your JavaScript action does not change the focus afterwards, make sure to call this.blur() in the end to unselect the button.\n{{% button style=\"primary\" icon=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element To use native HTML elements in your Markdown, add this in your hugo.toml\n[markup.goldmark.renderer] unsafe = true\u003cform action=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", "description": "Clickable buttons", "tags": null, "title": "Button", @@ -365,7 +365,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The highlight shortcode renders your code with a syntax highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode is fully compatible with Hugo’s highlight shortcode but offers some extensions.\nIt is called interchangeably in the same way as Hugo’s own shortcode providing positional parameter or by simply using codefences.\nYou are free to also call this shortcode from your own partials. In this case it resembles Hugo’s highlight function syntax if you call this shortcode as a partial using compatiblity syntax.\nWhile the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Position Default Notes type 1 \u003cempty\u003e The language of the code to highlight. Choose from one of the supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title for code. This displays the code like a single tab if hl_inline=false (which is Hugos default). wrap see notes Extension. When true the content may wrap on long lines otherwise it will be scrollable.\nThe default value can be set in your config.toml and overwritten via frontmatter. See below. options 2 \u003cempty\u003e An optional, comma-separated list of zero or more Hugo supported options as well as extension parameter from this table. \u003coption\u003e \u003cempty\u003e Any of Hugo’s supported options. \u003ccontent\u003e \u003cempty\u003e Your code to highlight. Configuration Default values for Hugo’s supported options can be set via goldmark settings in your config.toml\nDefault values for extension options can be set via params settings in your config.toml or be overwritten by frontmatter for each individual page.\nGlobal Configuration File You can configure the color style used for code blocks in your color variants stylesheet file.\nRecommended Settings [markup] [markup.highlight] # line numbers in a table layout will shift if code is wrapping, so better # use inline; besides that visually both layouts have the same look and behavior lineNumbersInTable = false # the shipped variants come with their own modified chroma syntax highlightning # stylesheets which are linked in your generated HTML pages; you can use Hugo to generate # own stylesheets to your liking and use them in your variant; # if you want to use Hugo's internal styles instead of the shipped stylesheets: # - remove `noClasses` or set `noClasses = true` # - set `style` to a predefined style name # note: with using the internal styles, the `--CODE-theme` setting in your variant # stylesheet will be ignored and the internal style is used for all variants and # even print noClasses = false # style = \"tango\"Optional Settings [params] highlightWrap = truePage’s Frontmatter +++ highlightWrap = true +++Examples Line Numbers with Starting Offset As mentioned above, line numbers in a table layout will shift if code is wrapping, so better use inline. To make things easier for you, set lineNumbersInTable = false in your config.toml and add lineNos = true when calling the shortcode instead of the specific values table or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence with Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") With Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff ", + "content": "The highlight shortcode renders your code with a syntax highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode is fully compatible with Hugo’s highlight shortcode but offers some extensions.\nIt is called interchangeably in the same way as Hugo’s own shortcode providing positional parameter or by simply using codefences.\nYou are free to also call this shortcode from your own partials. In this case it resembles Hugo’s highlight function syntax if you call this shortcode as a partial using compatiblity syntax.\nWhile the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Position Default Notes type 1 \u003cempty\u003e The language of the code to highlight. Choose from one of the supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title for code. This displays the code like a single tab if hl_inline=false (which is Hugos default). wrap see notes Extension. When true the content may wrap on long lines otherwise it will be scrollable.\nThe default value can be set in your hugo.toml and overwritten via frontmatter. See below. options 2 \u003cempty\u003e An optional, comma-separated list of zero or more Hugo supported options as well as extension parameter from this table. \u003coption\u003e \u003cempty\u003e Any of Hugo’s supported options. \u003ccontent\u003e \u003cempty\u003e Your code to highlight. Configuration Default values for Hugo’s supported options can be set via goldmark settings in your hugo.toml\nDefault values for extension options can be set via params settings in your hugo.toml or be overwritten by frontmatter for each individual page.\nGlobal Configuration File You can configure the color style used for code blocks in your color variants stylesheet file.\nRecommended Settings [markup] [markup.highlight] # line numbers in a table layout will shift if code is wrapping, so better # use inline; besides that visually both layouts have the same look and behavior lineNumbersInTable = false # the shipped variants come with their own modified chroma syntax highlightning # stylesheets which are linked in your generated HTML pages; you can use Hugo to generate # own stylesheets to your liking and use them in your variant; # if you want to use Hugo's internal styles instead of the shipped stylesheets: # - remove `noClasses` or set `noClasses = true` # - set `style` to a predefined style name # note: with using the internal styles, the `--CODE-theme` setting in your variant # stylesheet will be ignored and the internal style is used for all variants and # even print noClasses = false # style = \"tango\"Optional Settings [params] highlightWrap = truePage’s Frontmatter +++ highlightWrap = true +++Examples Line Numbers with Starting Offset As mentioned above, line numbers in a table layout will shift if code is wrapping, so better use inline. To make things easier for you, set lineNumbersInTable = false in your hugo.toml and add lineNos = true when calling the shortcode instead of the specific values table or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence with Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") With Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x for x in L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x for x in L[1:] if x\u003e=L[0]]) # Some more stuff ", "description": "Render code with a syntax highlighter", "tags": null, "title": "Highlight", @@ -381,7 +381,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The icon shortcode displays icons using the Font Awesome library.\nUsage While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% icon icon=\"exclamation-triangle\" %}} {{% icon icon=\"angle-double-up\" %}} {{% icon icon=\"skull-crossbones\" %}} {{% icon exclamation-triangle %}} {{% icon angle-double-up %}} {{% icon skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Position Default Notes icon 1 \u003cempty\u003e Font Awesome icon name to be displayed. It will be displayed in the text color of its according context. Finding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the icon name and paste into the Markdown content.\nCustomising Icons Font Awesome provides many ways to modify the icon\nChange color (by default the icon will inherit the parent color) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\nExamples Standard Usage Built with {{% icon heart %}} by Relearn and HugoBuilt with by Relearn and Hugo\nAdvanced HTML Usage While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the \u003ci\u003e HTML into markup, and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and HugoBuilt with by Relearn and Hugo\nTo use these native HTML elements in your Markdown, add this in your config.toml:\n[markup.goldmark.renderer] unsafe = true", + "content": "The icon shortcode displays icons using the Font Awesome library.\nUsage While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% icon icon=\"exclamation-triangle\" %}} {{% icon icon=\"angle-double-up\" %}} {{% icon icon=\"skull-crossbones\" %}} {{% icon exclamation-triangle %}} {{% icon angle-double-up %}} {{% icon skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Position Default Notes icon 1 \u003cempty\u003e Font Awesome icon name to be displayed. It will be displayed in the text color of its according context. Finding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the icon name and paste into the Markdown content.\nCustomising Icons Font Awesome provides many ways to modify the icon\nChange color (by default the icon will inherit the parent color) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\nExamples Standard Usage Built with {{% icon heart %}} by Relearn and HugoBuilt with by Relearn and Hugo\nAdvanced HTML Usage While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the \u003ci\u003e HTML into markup, and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and HugoBuilt with by Relearn and Hugo\nTo use these native HTML elements in your Markdown, add this in your hugo.toml:\n[markup.goldmark.renderer] unsafe = true", "description": "Nice icons for your page", "tags": null, "title": "Icon", @@ -405,7 +405,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The math shortcode generates beautiful formatted math and chemical formulae using the MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Note This only works in modern browsers.\nUsage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\n​ codefence shortcode partial ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} Parameter Name Default Notes align center Allowed values are left, center or right. \u003ccontent\u003e \u003cempty\u003e Your formuale. Configuration MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files thru a JSON object in your config.toml or override these settings per page thru your pages frontmatter.\nThe JSON object of your config.toml / frontmatter is forwarded into MathJax’s configuration object.\nSee MathJax documentation for all allowed settings.\nGlobal Configuration File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\"Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++Examples Inline Math Inline math is generated if you use a single `$` as a delimiter around your formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math is generated if you use a single $ as a delimiter around your formulae: $\\sqrt{3}$\nBlocklevel Math with Right Alignment If you delimit your formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If you delimit your formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence You can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", + "content": "The math shortcode generates beautiful formatted math and chemical formulae using the MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Note This only works in modern browsers.\nUsage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\n​ codefence shortcode partial ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} Parameter Name Default Notes align center Allowed values are left, center or right. \u003ccontent\u003e \u003cempty\u003e Your formuale. Configuration MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files thru a JSON object in your hugo.toml or override these settings per page thru your pages frontmatter.\nThe JSON object of your hugo.toml / frontmatter is forwarded into MathJax’s configuration object.\nSee MathJax documentation for all allowed settings.\nGlobal Configuration File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\"Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++Examples Inline Math Inline math is generated if you use a single `$` as a delimiter around your formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math is generated if you use a single $ as a delimiter around your formulae: $\\sqrt{3}$\nBlocklevel Math with Right Alignment If you delimit your formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If you delimit your formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence You can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", "description": "Beautiful math and chemical formulae", "tags": null, "title": "Math", @@ -413,7 +413,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The mermaid shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Note This only works in modern browsers.\nUsage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.\nParameter Name Default Notes align center Allowed values are left, center or right. zoom see notes Whether the graph is pan- and zoomable.\nIf not set the value is determined by the mermaidZoom setting of the site or the pages frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan and zoom active \u003ccontent\u003e \u003cempty\u003e Your Mermaid graph. Configuration Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your config.toml, override these settings per page thru your pages frontmatter or override these setting per diagramm thru diagram directives.\nThe JSON object of your config.toml / frontmatter is forwarded into Mermaid’s mermaid.initialize() function.\nSee Mermaid documentation for all allowed settings.\nThe theme setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in config.toml, frontmatter or diagram directives.\nGlobal Configuration File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = truePage’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true +++Examples Flowchart with YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram with Configuration Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! Class Diagram with Codefence Syntax ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned to the Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model with Non-Default Mermaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid Timeline {{\u003c mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ", + "content": "The mermaid shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Note This only works in modern browsers.\nUsage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.\nYou are free to also call this shortcode from your own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.\nParameter Name Default Notes align center Allowed values are left, center or right. zoom see notes Whether the graph is pan- and zoomable.\nIf not set the value is determined by the mermaidZoom setting of the site or the pages frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan and zoom active \u003ccontent\u003e \u003cempty\u003e Your Mermaid graph. Configuration Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your hugo.toml, override these settings per page thru your pages frontmatter or override these setting per diagramm thru diagram directives.\nThe JSON object of your hugo.toml / frontmatter is forwarded into Mermaid’s mermaid.initialize() function.\nSee Mermaid documentation for all allowed settings.\nThe theme setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in hugo.toml, frontmatter or diagram directives.\nGlobal Configuration File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = truePage’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true +++Examples Flowchart with YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram with Configuration Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how are you? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about you? Bob--\u003e\u003eJohn: Jolly good! Class Diagram with Codefence Syntax ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned to the Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model with Non-Default Mermaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"liable for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My working day section Go to work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to Mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to Mermaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach and engagement of campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need to promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: the test text. risk: high verifymethod: test } element test_entity { type: simulation } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram for Internet Banking System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Banking Customer A\", \"A customer of the bank, with personal bank accounts.\") Person(customerB, \"Banking Customer B\") Person_Ext(customerC, \"Banking Customer C\", \"desc\") Person(customerD, \"Banking Customer D\", \"A customer of the bank, \u003cbr/\u003e with personal bank accounts.\") System(SystemAA, \"Internet Banking System\", \"Allows customers to view information about their bank accounts, and make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Banking System\", \"Stores all of the core banking information about customers, accounts, transactions, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Banking System A\") System(SystemB, \"Banking System B\", \"A system of the bank, with personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Banking System D Database\", \"A system of the bank, with personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Banking System F Queue\", \"A system of the bank.\") SystemQueue_Ext(SystemG, \"Banking System G Queue\", \"A system of the bank, with personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisation British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creation Uses Creative techniques Strategic planning Argument mapping Tools Pen and paper Mermaid Timeline {{\u003c mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History of Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generation / exports,104.453 Electricity grid,Heating and cooling - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ", "description": "Generate diagrams and flowcharts from text", "tags": null, "title": "Mermaid", @@ -552,7 +552,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shortcodes", - "content": "The siteparam shortcode prints values of site params.\nUsage While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Position Default Notes name 1 \u003cempty\u003e The name of the site param to be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\nNested parameter with Markdown and HTML formatting To use formatted parameter, add this in your config.toml:\n[markup.goldmark.renderer] unsafe = true ​ config.toml [params] [params.siteparam.test] text = \"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting\" Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested option \u003cb\u003ewith\u003c/b\u003e formatting\n", + "content": "The siteparam shortcode prints values of site params.\nUsage While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Position Default Notes name 1 \u003cempty\u003e The name of the site param to be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\nNested parameter with Markdown and HTML formatting To use formatted parameter, add this in your hugo.toml:\n[markup.goldmark.renderer] unsafe = true ​ hugo.toml [params] [params.siteparam.test] text = \"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting\" Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested option \u003cb\u003ewith\u003c/b\u003e formatting\n", "description": "Get value of site params", "tags": null, "title": "SiteParam", diff --git a/js/variant.js b/js/variant.js index 78d255ba30..e7304cd06f 100644 --- a/js/variant.js +++ b/js/variant.js @@ -585,9 +585,9 @@ var variants = { { name: 'CODE-INLINE-BORDER-color', group: 'inline code', default: '#fbf0cb', tooltip: 'border color of inline code', }, { name: 'BROWSER-theme', group: '3rd party', default: 'light', tooltip: 'name of the theme for browser scrollbars of the main section', }, - { name: 'MERMAID-theme', group: '3rd party', default: 'default', tooltip: 'name of the default Mermaid theme for this variant, can be overridden in config.toml', }, - { name: 'OPENAPI-theme', group: '3rd party', default: 'light', tooltip: 'name of the default OpenAPI theme for this variant, can be overridden in config.toml', }, - { name: 'OPENAPI-CODE-theme', group: '3rd party', default: 'obsidian', tooltip: 'name of the default OpenAPI code theme for this variant, can be overridden in config.toml', }, + { name: 'MERMAID-theme', group: '3rd party', default: 'default', tooltip: 'name of the default Mermaid theme for this variant, can be overridden in hugo.toml', }, + { name: 'OPENAPI-theme', group: '3rd party', default: 'light', tooltip: 'name of the default OpenAPI theme for this variant, can be overridden in hugo.toml', }, + { name: 'OPENAPI-CODE-theme', group: '3rd party', default: 'obsidian', tooltip: 'name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml', }, { name: 'MENU-BORDER-color', group: 'header', default: 'transparent', tooltip: 'border color between menu and content', }, { name: 'MENU-TOPBAR-BORDER-color', group: 'header', fallback: 'MENU-HEADER-BG-color', tooltip: 'border color of vertical line between menu and topbar', }, diff --git a/more/credits/index.html b/more/credits/index.html index 5b6f742bf2..401830663a 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/more/credits/index.print.html b/more/credits/index.print.html index cd36346f8d..816f1a1233 100644 --- a/more/credits/index.print.html +++ b/more/credits/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/404.html b/pir/404.html index ca2522bb6f..1cd2e1fbf7 100644 --- a/pir/404.html +++ b/pir/404.html @@ -19,21 +19,21 @@ 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 cdc7b1085c..8f08d587e8 100644 --- a/pir/basics/branding/index.print.html +++ b/pir/basics/branding/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index 639ab0d59c..bf34091320 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/configuration/index.print.html b/pir/basics/configuration/index.print.html index ca212a026a..76edde074f 100644 --- a/pir/basics/configuration/index.print.html +++ b/pir/basics/configuration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index 6752457468..7529826378 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/customization/index.print.html b/pir/basics/customization/index.print.html index 7e25096010..b3f9c0b5b9 100644 --- a/pir/basics/customization/index.print.html +++ b/pir/basics/customization/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index f4bab12660..66b98fd0e2 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/generator/index.print.html b/pir/basics/generator/index.print.html index a177f12f73..27b3020769 100644 --- a/pir/basics/generator/index.print.html +++ b/pir/basics/generator/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index 7b66af580a..626386b6e9 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/history/index.print.html b/pir/basics/history/index.print.html index b37d2f3f14..05d6fe7086 100644 --- a/pir/basics/history/index.print.html +++ b/pir/basics/history/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/index.html b/pir/basics/index.html index 30c7a4153a..970162f29a 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/index.print.html b/pir/basics/index.print.html index 608f2e37ce..257caf4fc4 100644 --- a/pir/basics/index.print.html +++ b/pir/basics/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/index.xml b/pir/basics/index.xml index 1d841df28c..f70500ba1f 100644 --- a/pir/basics/index.xml +++ b/pir/basics/index.xml @@ -40,9 +40,9 @@ This theme’s repository be: https://github. https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html - On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer config.toml. Th' defaults be written 'n th' comments o' each opt'n. + On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml. Th' defaults be written 'n th' comments o' each opt'n. Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n. -​ config.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. +​ hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. Brrrand'n @@ -50,16 +50,16 @@ Avast that some o' these opt'ns be explained 'n detail 'n other Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed thru so called color variants. -A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer config. +A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo. Customizat'n https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html - Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer config.toml + Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer hugo.toml baseURL = "https://example.com/mysite/" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226. -Serv'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer config. +Serv'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer hugo. Stylesheet generrrat'r diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index d8a57bd34a..c2c46c910d 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/installation/index.print.html b/pir/basics/installation/index.print.html index dc6a65379d..3f278be4b3 100644 --- a/pir/basics/installation/index.print.html +++ b/pir/basics/installation/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index 5c0d354e3d..4329e8f899 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/migration/index.print.html b/pir/basics/migration/index.print.html index 2a69f83e91..29182bfa0c 100644 --- a/pir/basics/migration/index.print.html +++ b/pir/basics/migration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index 5a234f8b4a..3e82f18278 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/requirements/index.print.html b/pir/basics/requirements/index.print.html index eb4f3b8794..19130b8fee 100644 --- a/pir/basics/requirements/index.print.html +++ b/pir/basics/requirements/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/topbar/index.html b/pir/basics/topbar/index.html index 835ea9a874..51cf90f4ef 100644 --- a/pir/basics/topbar/index.html +++ b/pir/basics/topbar/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/topbar/index.print.html b/pir/basics/topbar/index.print.html index ecacad4ffd..b0e874c166 100644 --- a/pir/basics/topbar/index.print.html +++ b/pir/basics/topbar/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/categories/basic/index.html b/pir/categories/basic/index.html index a56bbff331..67862983dd 100644 --- a/pir/categories/basic/index.html +++ b/pir/categories/basic/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/content/index.html b/pir/categories/content/index.html index 2b8cb19f1f..49fbf60216 100644 --- a/pir/categories/content/index.html +++ b/pir/categories/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.html b/pir/categories/custom/index.html index 84ac04a310..f2b413b3d3 100644 --- a/pir/categories/custom/index.html +++ b/pir/categories/custom/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.xml b/pir/categories/custom/index.xml index b6e4d58993..4976947a0f 100644 --- a/pir/categories/custom/index.xml +++ b/pir/categories/custom/index.xml @@ -13,7 +13,7 @@ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed thru so called color variants. -A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer config. +A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo. \ No newline at end of file diff --git a/pir/categories/index.html b/pir/categories/index.html index d355e3aa84..d0d20924e1 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/taxonomy/index.html b/pir/categories/taxonomy/index.html index 56a45e45c1..163e1d7795 100644 --- a/pir/categories/taxonomy/index.html +++ b/pir/categories/taxonomy/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.html b/pir/categories/theming/index.html index 46ee89e236..1b90a4766c 100644 --- a/pir/categories/theming/index.html +++ b/pir/categories/theming/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.xml b/pir/categories/theming/index.xml index 2bb9a62bf0..148c5a8492 100644 --- a/pir/categories/theming/index.xml +++ b/pir/categories/theming/index.xml @@ -13,7 +13,7 @@ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed thru so called color variants. -A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer config. +A color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo. Stylesheet generrrat'r diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index f1a1059878..47d6f61263 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/archetypes/index.print.html b/pir/cont/archetypes/index.print.html index 0a46dcb88e..7a0f2aad49 100644 --- a/pir/cont/archetypes/index.print.html +++ b/pir/cont/archetypes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/frontmatter/index.html b/pir/cont/frontmatter/index.html index de2e0b5734..f45a006bcb 100644 --- a/pir/cont/frontmatter/index.html +++ b/pir/cont/frontmatter/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/frontmatter/index.print.html b/pir/cont/frontmatter/index.print.html index 4b77cd19a6..e83624465e 100644 --- a/pir/cont/frontmatter/index.print.html +++ b/pir/cont/frontmatter/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index b243907ad3..7daeb38043 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/i18n/index.print.html b/pir/cont/i18n/index.print.html index 0f1cc9f4d8..5b37b72ee0 100644 --- a/pir/cont/i18n/index.print.html +++ b/pir/cont/i18n/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/imageeffects/index.html b/pir/cont/imageeffects/index.html index 1bfcadd505..0bd4b26dfd 100644 --- a/pir/cont/imageeffects/index.html +++ b/pir/cont/imageeffects/index.html @@ -12,15 +12,15 @@ +Without any sett'ns 'n yer hugo.toml this defaults t'"> +Without any sett'ns 'n yer hugo.toml this defaults t'"> @@ -32,21 +32,21 @@ Without any sett'ns 'n yer config.toml this defaults t'"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/imageeffects/index.print.html b/pir/cont/imageeffects/index.print.html index 8b4673cba8..41d3ee6463 100644 --- a/pir/cont/imageeffects/index.print.html +++ b/pir/cont/imageeffects/index.print.html @@ -12,15 +12,15 @@ +Without any sett'ns 'n yer hugo.toml this defaults t'"> +Without any sett'ns 'n yer hugo.toml this defaults t'"> @@ -32,22 +32,22 @@ Without any sett'ns 'n yer config.toml this defaults t'"> - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.html b/pir/cont/index.html index 3df72f086f..ba592cb205 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/index.print.html b/pir/cont/index.print.html index 90279877a0..26fe8df399 100644 --- a/pir/cont/index.print.html +++ b/pir/cont/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.xml b/pir/cont/index.xml index 238207cfe8..f05b876a0e 100644 --- a/pir/cont/index.xml +++ b/pir/cont/index.xml @@ -49,9 +49,9 @@ Marrrkdown be simple t' learn, wit' minimal extra characters so it&r https://McShelby.github.io/hugo-theme-relearn/pir/cont/imageeffects/index.html Th' theme supports non-standard image effects. As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank. -Instead, ye can configure th' defaults 'n yer config.toml aswell as overrid'n these default 'n th' planks frontmatter. +Instead, ye can configure th' defaults 'n yer hugo.toml aswell as overrid'n these default 'n th' planks frontmatter. Explicitly set URL query parameter will override th' defaults 'n effect fer a plank. -Without any sett'ns 'n yer config.toml this defaults t' +Without any sett'ns 'n yer hugo.toml this defaults t' Menu extrrra shorrrtcuts @@ -59,7 +59,7 @@ Without any sett'ns 'n yer config.toml this defaults t'Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/cont/menushortcuts/index.html Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n. -Basic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add. +Basic configurat'n Edit th' website configurat'n hugo.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add. Example from th' current website: [[menu.shortcuts]] name = "<i class='fab fa-fw fa-github'></i> GitHub repo" identifier = "ds" url = "https://github.com/McShelby/hugo-theme-relearn" weight = 10 [[menu.shortcuts]] name = "<i class='fas fa-fw fa-camera'></i> Showcases" url = "showcase/" weight = 11 [[menu. @@ -69,7 +69,7 @@ Example from th' current website: Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/cont/i18n/index.html Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode. -Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config. +Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer hugo. Taxonomy diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index 295b7f6c30..e4748b73d1 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -30,21 +30,21 @@ Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/markdown/index.print.html b/pir/cont/markdown/index.print.html index e3344625b7..057c879230 100644 --- a/pir/cont/markdown/index.print.html +++ b/pir/cont/markdown/index.print.html @@ -30,22 +30,22 @@ Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/menushortcuts/index.html b/pir/cont/menushortcuts/index.html index a1bf1b666c..8afbd32d00 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -11,12 +11,12 @@ @@ -30,21 +30,21 @@ Example from th' current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/menushortcuts/index.print.html b/pir/cont/menushortcuts/index.print.html index fd842969d1..f5fd605355 100644 --- a/pir/cont/menushortcuts/index.print.html +++ b/pir/cont/menushortcuts/index.print.html @@ -11,12 +11,12 @@ @@ -30,22 +30,22 @@ Example from th' current website: - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index aa641eb935..60bdef3853 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/pages/index.print.html b/pir/cont/pages/index.print.html index 8bcbe075b2..8fe0d4cf36 100644 --- a/pir/cont/pages/index.print.html +++ b/pir/cont/pages/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/taxonomy/index.html b/pir/cont/taxonomy/index.html index 52fda12abd..16e6bd6177 100644 --- a/pir/cont/taxonomy/index.html +++ b/pir/cont/taxonomy/index.html @@ -30,21 +30,21 @@ Th' categories be displayed at th' bottom o' th' plank 'n al - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/taxonomy/index.print.html b/pir/cont/taxonomy/index.print.html index 68ab91c746..0ee680a557 100644 --- a/pir/cont/taxonomy/index.print.html +++ b/pir/cont/taxonomy/index.print.html @@ -30,22 +30,22 @@ Th' categories be displayed at th' bottom o' th' plank 'n al - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/contributing/index.html b/pir/dev/contributing/index.html index 731c54270b..d7fbc79cbc 100644 --- a/pir/dev/contributing/index.html +++ b/pir/dev/contributing/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/contributing/index.print.html b/pir/dev/contributing/index.print.html index 4773b4c9d8..50b3b22a9e 100644 --- a/pir/dev/contributing/index.print.html +++ b/pir/dev/contributing/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/index.html b/pir/dev/index.html index 0efe9795b1..e9551589c7 100644 --- a/pir/dev/index.html +++ b/pir/dev/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/index.print.html b/pir/dev/index.print.html index ede1194b24..8bbb1ab899 100644 --- a/pir/dev/index.print.html +++ b/pir/dev/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/maintaining/index.html b/pir/dev/maintaining/index.html index c17de4fa2c..fb9b5862e8 100644 --- a/pir/dev/maintaining/index.html +++ b/pir/dev/maintaining/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/maintaining/index.print.html b/pir/dev/maintaining/index.print.html index a42dce2360..d6729b609b 100644 --- a/pir/dev/maintaining/index.print.html +++ b/pir/dev/maintaining/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/screenshots/index.html b/pir/dev/screenshots/index.html index b23f7b0ae5..9bab6fc460 100644 --- a/pir/dev/screenshots/index.html +++ b/pir/dev/screenshots/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/screenshots/index.print.html b/pir/dev/screenshots/index.print.html index 1fa678d42f..4c261733d6 100644 --- a/pir/dev/screenshots/index.print.html +++ b/pir/dev/screenshots/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/index.html b/pir/index.html index b1a8768f80..ee9edf1b72 100644 --- a/pir/index.html +++ b/pir/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/index.print.html b/pir/index.print.html index 30764ec060..4bcc6b5d76 100644 --- a/pir/index.print.html +++ b/pir/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/pir/index.search.js b/pir/index.search.js index f5f0b77be3..c8a9ed6460 100644 --- a/pir/index.search.js +++ b/pir/index.search.js @@ -27,7 +27,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml fer documentat'n 'n all cases.\n+++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's config.toml be used. images = [ \"images/hero.png\" ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = \"Example Page\" # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's config.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's config.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Th' title 'n main menu. # Default: \u003ctitle\u003e # If set, this will be used fer th' page's menu entry instead o' th' `title` # opt'n. menuTitle = \"\" # Prefix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = \"\" # Suffix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = \"\" # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value be true, th' plank be hidden from th' menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Prefix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n. headingPre = \"\" # Suffix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n. headingPost = \"\" # Display name o' th' page's last editor. # Default: not set # If set, it will be displayed 'n th' default footer. LastModifierDisplayName = \"\" # Email address o' th' page's last editor. # Default: not set # If set together wit' LastModifierDisplayName, it will be displayed 'n th' # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # If not set, th' set value o' yer site's config.toml be used or given as a # parameter t' individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effect values default t' th' values o' yer site's config.toml an' can be # overridden thru URL parameter given t' th' image. See th' documentat'n fer # details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's config.toml be used. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # If not set, th' set value o' yer site's config.toml be used or given as a # parameter t' individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's config.toml be used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++Some Detailed Examples Add Ay'con t' a Menu Entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n Sibl'n Menu/Page Entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight parameter t' a number.\n+++ title = \"My page\" weight = 5 +++Us'n a Custom Title fer Menu Entries By default, th' Relearrrn theme will use a page’s title attribute fer th' menu item (or linkTitle if defined).\nBut a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' menuTitle parameter fer that purpose:\nFor example (for a plank named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++Override Expand State Rules fer Menu Entries Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' alwaysopen sett'n on a per plank basis. If alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\nDis'ble Sect'n Planks Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.\nT' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.\nFor this, open content/level-one/_index.md an' add th' follow'n frontmatter\n+++ collapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer config.toml [_build] render = \"never\" # no plank will be generated so th' plank does not have a url +++ ", + "content": " Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml fer documentat'n 'n all cases.\n+++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used. images = [ \"images/hero.png\" ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = \"Example Page\" # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's hugo.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's hugo.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Th' title 'n main menu. # Default: \u003ctitle\u003e # If set, this will be used fer th' page's menu entry instead o' th' `title` # opt'n. menuTitle = \"\" # Prefix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = \"\" # Suffix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = \"\" # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value be true, th' plank be hidden from th' menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Prefix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n. headingPre = \"\" # Suffix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n. headingPost = \"\" # Display name o' th' page's last editor. # Default: not set # If set, it will be displayed 'n th' default footer. LastModifierDisplayName = \"\" # Email address o' th' page's last editor. # Default: not set # If set together wit' LastModifierDisplayName, it will be displayed 'n th' # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effect values default t' th' values o' yer site's hugo.toml an' can be # overridden thru URL parameter given t' th' image. See th' documentat'n fer # details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # If not set, th' set value o' yer site's hugo.toml be used or given as a # parameter t' individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's hugo.toml be used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's hugo.toml be used. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's hugo.toml be used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++Some Detailed Examples Add Ay'con t' a Menu Entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n Sibl'n Menu/Page Entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight parameter t' a number.\n+++ title = \"My page\" weight = 5 +++Us'n a Custom Title fer Menu Entries By default, th' Relearrrn theme will use a page’s title attribute fer th' menu item (or linkTitle if defined).\nBut a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' menuTitle parameter fer that purpose:\nFor example (for a plank named content/install/linux.md):\n+++ title = \"Install on Linux\" menuTitle = \"Linux\" +++Override Expand State Rules fer Menu Entries Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' alwaysopen sett'n on a per plank basis. If alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\nDis'ble Sect'n Planks Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.\nT' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.\nFor this, open content/level-one/_index.md an' add th' follow'n frontmatter\n+++ collapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer hugo.toml [_build] render = \"never\" # no plank will be generated so th' plank does not have a url +++ ", "description": "", "tags": null, "title": "Frrrontmatter", @@ -43,7 +43,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' history plank.\n0.112.4 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n5.24.0.beta 0.112.4 This release requires a newer Cap'n Hugo version.\nChange Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlightn'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.\nNew Ye now can configure additional opt'ns fer every theme variant 'n yer config.toml. This allows fer optional advanced functionality. Ye don’t need t' change anyth'n as th' old configurat'n opt'ns will still work (but may generate warnings now).\nTh' advanced functionality allows ye t' set an explicit name fer a theme variant, set different colors (if ye be us'n monochrome SVGs) or even different ay'cons (handy if ye want t' adjust colors fer PNGs, GIFs or JPGs) an' now allows fer multiple auto mode variants that adjust t' th' light/dark preference o' yer OS sett'ns.\n5.23.0 (2023-11-03) Change Wit' 0.120.0 th' author sett'ns move into th' [params] array 'n yer config.toml. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.\nChange yer previous sett'n from\n[params] author = \"Hugo\"t'\n[params] author.name = \"Hugo\" Change Taxonomy term planks now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer config.toml by add'n disableTermBreadcrumbs=true.\nNew Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns fer th' menu an' th' children shortcode. Both will now accept th' follow'n values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adher'n t' Hugo’s default sort order).\nNew Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. See th' docs.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independend way t' link t' planks inside o' yer project. It always required ye t' know how yer uglyURLs sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This be a hassle as ye have t' change these links manually once ye change yer uglyURLs sett'n or change th' type o' a plank.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow it’s poss'ble t' use th' same path o' a call t' relref 'n a plain Marrrkdown link (eg [generator](../generator)). This be independend o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so [generator](generator/index.html) will work as before.\nTh' follow'n types o' link'n be supported:\nlink descript'n [generator](en/basics/generator) absolute from yer project root (multilang) [generator](/en/basics/generator) absolute from yer project root (multilang) [generator](basics/generator) absolute from yer current language root [generator](/basics/generator) absolute from yer current language root [generator](./../generator) relative from th' current plank [generator](../generator) relative from th' current plank 5.22.0 (2023-10-02) Change This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' R-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See th' documentat'n fer how t' do this.\nThis feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n shortcuts t' planks inside o' yer project wit' a headless branch parent.\nIn this case it be advised t' remove th' title from th' headless branch parent’s frontmatter, as it will otherwise appear 'n yer breadcrumbs.\nNew It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer config.toml inside o' a page’s frontmatter.\nNew If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer config.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew Translat'n into Swahili. This language be not supported fer search.\n5.21.0 (2023-09-18) Change We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer menu-footer.html partial overridden, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.\nNew This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See th' documentat'n fer further details.\nNew Th' theme has updated its Swagger dependency t' 5.7.2 fer th' openapi shortcode. This br'ns support fer OpenAPI Specificat'n 3.1.\n5.20.0 (2023-08-26) Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.\nWit' this comes a change 'n th' light theme variants o' Relearrrn Bright, Relearrrn Light an' Zen Light by switch'n th' syntaxhighlightn'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.\nAdditionally, th' syntaxhighlightn'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed th' CSS vari'ble --MENU-SECTION-HR-color t' --MENU-SECTION-SEPARATOR-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose borders be now configur'ble by us'n th' CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color an' --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor exist'n variants noth'n has changed visually.\nNew Th' default values fer th' image effects be now configur'ble fer yer whole ship via config.toml or fer each plank thru frontmatter.\nNew This release fixes a long outstand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed expand or inactive tabs.\nNew Restored compatibility wit' Cap'n Hugo versions lower than 0.111.0 fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\n5.19.0 (2023-08-12) New Th' highlight shortcode now accepts th' new parameter title. This displays th' code like a single tab. This be also avail'ble us'n codefences an' makes it much easier t' write nicer code samples.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew Th' theme now dispatches th' custom event themeVariantLoaded on th' document when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.\nNew Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' sankey diagram type an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).\nNew Translat'n into Hungarian.\n5.18.0 (2023-07-27) Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange There be visual improvements 'n display'n text links 'n yer rrrambl'n aswell as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.\nNew Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' siteparam shortcode be now cap'ble 'n display'n nested params aswell as support'n text formatt'n.\n5.17.0 (2023-06-22) Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n [params] disableHoverBlockCopyToClipBoard=true t' yer config.toml.\nNew Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.\n5.16.0 (2023-06-10) Change Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documenat'n.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew Th' tabs shortcode an' th' tab shortcode received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.\nTh' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.\nAdditionally th' name parameter was renamed t' title but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.\nNew Th' theme now optionally supports separate favicons fer light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility wit' Cap'n Hugo 0.112.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nTh' attachments shortcode has compatiblity issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt be planned t' refactor th' attchments shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.\nNew Th' already known tabshas a new friend th' tab shortcode t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew Besides th' tag taxonomy th' theme now also provides th' category taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.\n5.14.0 (2023-05-20) New Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.\nHugo’s default taxonmies tags an' categories be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer config.toml.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional taxonomies not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{- partial \"tags.html\" . }} t' it. Show tags below rrrambl'n: Overwrite content-footer.html an' add {{- partial \"tags.html\" . }} t' it. New Th' new parameter breadcrumbSeparator be now avail'ble 'n yer config.toml t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.\n5.13.0 (2023-05-17) Change Th' swagger shortcode was deprecated 'n favor fer th' openapi shortcode. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' swagger shortcode 'n th' next major release.\nAdditionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.\n5.12.0 (2023-05-04) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Support fer th' great VSCode Front Matter extension which provides on-premise CMS capabilties t' Cap'n Hugo.\nTh' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer frontmatter.json like this\n{ ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' pirate translat'n. This feature be not avail'ble 'n Internet Explorer 11.\nNew Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.\n5.11.0 (2023-02-07) Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer static/js directory an' board it from yer own layouts/partials/custom-header.html like this:\n\u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' default sett'n o' on, 'n effect since 1.1.0, changed back t' off as there was interference wit' scroll'n on mobile an' big planks.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer config.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis also changed th' lightbox effects parameter from featherlight=false t' lightbox=false. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.\nChange In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' expand shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Translat'n into Czech. This language be not supported fer search.\nNew GitHub releases be also now tagged fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) release mak'n it easier fer ye t' pin th' theme t' a certain version.\n5.10.0 (2023-01-25) New Th' attachments, badge, button an' notice shorrrtcodes have a new parameter color t' set arbitrary CSS color values.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.\n5.9.0 (2022-12-23) Break'n Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.\nIt was later discovered, that this causes planks only meant t' be displayed 'n th' More section o' th' menu an' stored directly inside yer rrrambl'n directory t' now show up 'n th' menu aswell.\nT' get rid o' this undesired behavior ye have two choices:\nMake th' plank file a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store th' plank file fer below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\ntitle = \"Credits\" Change Th' required folder name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a files subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a index.files directory. Although th' old files directory be now deprecated, if both directories be present, only th' old files directory will be used fer compatiblity.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer config.toml.\nNew Th' theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New Th' new badge shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.\nNew A new color --ACCENT-color was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old yellow color be still used as default.\n5.7.0 (2022-11-29) Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code ko. Formerly th' country code kr was used instead.\nNew Th' button shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.\nNew Th' search now supports th' Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.\nT' activate this feature, ye need t' configure it 'n yer config.toml as a new outputformat SEARCHPAGE fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'n CTRL+ALT+t now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' TAB key.\nTh' search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.\nNew Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.\nT' configure this 'n yer config.toml make sure t' set Hugo’s disableHugoGeneratorInject=true an' also [params] disableGeneratorVersion=true, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).\n5.5.0 (2022-11-06) Change Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.\nFor that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.\nIf ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML img URLs manually t' th' respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change Wit' th' proper sett'ns 'n yer config.toml yer plank be now serv'ble from th' local file system us'n file:// URLs.\nPlease note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer config.toml from JSON t' SEARCH. Th' now deprecated JSON outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from http:// or https://.\nChange Th' button shortcode has a new parameter target t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.\nNew Th' math shortcode an' mermaid shortcode now also support th' align parameter if codefence rules be used.\nNew Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.\nNew Translat'n into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).\nNew Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline opt'n be now documented.\nNew Print'n fer th' swagger shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true 'n yer config.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Cap'n Hugo version.\nChange Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer config.tomlt':\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' permalink'ble = false 5.0.0 (2022-07-05) Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.\nYer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n after th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:\nfer yer home plank, add th' frontmatter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated frontmatter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' frontmatter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew Add'n new partials heading-pre.html / heading-post.html an' accord'n frontmatter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew Th' new shortcode math be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n4.2.0 (2022-06-23) Break'n Th' second parameter fer th' include shortcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange Previously, if th' tabs shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.\nChange Th' landingPageURL was removed from config.toml. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically an' will point t' th' project’s homepage. If ye want t' support a different link, overwrite th' logo.html partial.\nNew All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.\n4.1.0 (2022-06-12) New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank. 4.0.0 (2022-06-05) Break'n Th' custom_css config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' custom-header.html template 'n a much more generic manner.\nBreak'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from --MAIN-LINK-color an' --MAIN-ANCHOR-HOVER-color respectively.\nNew All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew New colors --PRIMARY-color an' --SECONDARY-color were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have primary or secondary as additional values.\nThese two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 (2022-04-03) Break'n If ye had previously overwritten th' custom-footer.html partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial content-footer.html. custom-footer.html was never meant t' contain HTML other than additional styles an' JavaScript.\nNew If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer config.toml. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.\nNew Ye can activate print support 'n yer config.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between --MAIN-font fer all rrrambl'n text an' --CODE-font fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.\nNew Th' new shortcode swagger be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Cap'n Hugo version.\nChange In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set disableMermaid=false 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.\nNew Additional color variant vari'ble --MERMAID-theme t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.\n3.1.0 (2022-03-15) New attachment an' notice shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons. 3.0.0 (2022-02-22) Break'n We made changes t' th' menu footer. If ye have yer menu-footer.html partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' menu-footer.html partial that be com'n wit' th' exampleSite.\nThis change was made t' allow yer own menu footer t' be placed right after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).\nBreak'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.\nThis change will only affect yer installat'n if you’ve not set th' themeVariant parameter 'n yer config.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant=\"learn\" 'n yer config.toml.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color t' --MENU-SEARCH-BORDER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.\nNew Ye can now configure multiple color variants 'n yer config.toml. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant selector will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant selector will not be displayed wit' Internet Explorer 11.\n2.9.0 (2021-11-19) Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard compliant form ye must not link t' th' *.md file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server after an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console after th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not foundIn this case, ye must apply one o' two opt'ns:\nStart up a text editor wit' regular expression support fer search an' replace. Search fer (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" an' replace it by $1$2\" 'n all *.md files. This be th' recommended choice.\nCopy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes th' font Novacento/Novecento. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.\nNew Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer config.toml. For an example see th' example configurat'n.\n2.7.0 (2021-10-24) New Optional second parameter fer notice shortcode t' set title 'n box header. 2.6.0 (2021-10-21) New Yer ship can now be served from a subfolder if ye set baseURL an' canonifyURLs=true 'n yer config.toml. See th' documentat'n fer a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugos rules highlight'n 'n case no language was given or th' language be unsupported. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style. 2.4.0 (2021-10-07) Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.\nNew Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer config.toml.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer config.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Cap'n Hugo version.\nNew Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.\n2.2.0 (2021-09-09) New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n disableSeoHiddenPages=true 'n yer config.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Cap'n Hugo version.\nChange In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n th' exampleSite), they will now be ignored by th' search.\nNew Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n disableSearchHiddenPages=true 'n yer config.toml.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.\n2.0.0 (2021-08-28) Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n\nChange In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange --MENU-HOME-LINK-color an' --MENU-HOME-LINK-HOVER-color were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.\nChange Arrow navigat'n an' children shortcode were ignor'n sett'n fer ordersectionsby. This be now changed an' may result 'n different sort'n order o' yer sub planks.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 (2021-07-26) New Shortcode expand wit' new parameter t' open on plank board. 1.1.0 (2021-07-02) Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.\nNew Merrrmaid config opt'ns can be set 'n config.toml.\n1.0.0 (2021-07-01) 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.\nNew Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' Relearrrn an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.\n", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nThis document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' history plank.\n0.112.4 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n5.24.0.beta 0.112.4 This release requires a newer Cap'n Hugo version.\nChange Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlightn'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai. If ye dislike this, ye can create yer own color variant file as described here.\nNew Ye now can configure additional opt'ns fer every theme variant 'n yer hugo.toml. This allows fer optional advanced functionality. Ye don’t need t' change anyth'n as th' old configurat'n opt'ns will still work (but may generate warnings now).\nTh' advanced functionality allows ye t' set an explicit name fer a theme variant, set different colors (if ye be us'n monochrome SVGs) or even different ay'cons (handy if ye want t' adjust colors fer PNGs, GIFs or JPGs) an' now allows fer multiple auto mode variants that adjust t' th' light/dark preference o' yer OS sett'ns.\n5.23.0 (2023-11-03) Change Wit' 0.120.0 th' author sett'ns move into th' [params] array 'n yer hugo.toml. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.\nChange yer previous sett'n from\n[params] author = \"Hugo\"t'\n[params] author.name = \"Hugo\" Change Taxonomy term planks now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer hugo.toml by add'n disableTermBreadcrumbs=true.\nNew Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.\nNew It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. See th' docs.\nNew It be now poss'ble t' adjust th' menu width fer yer whole ship. See th' docs.\nNew This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. See th' docs.\nNew This release comes wit' additional sort opt'ns fer th' menu an' th' children shortcode. Both will now accept th' follow'n values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adher'n t' Hugo’s default sort order).\nNew Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. See th' docs.\nNew Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' xychart type.\nNew This release adds port'ble Marrrkdown links.\nPreviously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independend way t' link t' planks inside o' yer project. It always required ye t' know how yer uglyURLs sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This be a hassle as ye have t' change these links manually once ye change yer uglyURLs sett'n or change th' type o' a plank.\nYe could work around this by us'n th' relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results 'n non-port'ble Marrrkdown.\nNow it’s poss'ble t' use th' same path o' a call t' relref 'n a plain Marrrkdown link (eg [generator](../generator)). This be independend o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so [generator](generator/index.html) will work as before.\nTh' follow'n types o' link'n be supported:\nlink descript'n [generator](en/basics/generator) absolute from yer project root (multilang) [generator](/en/basics/generator) absolute from yer project root (multilang) [generator](basics/generator) absolute from yer current language root [generator](/basics/generator) absolute from yer current language root [generator](./../generator) relative from th' current plank [generator](../generator) relative from th' current plank 5.22.0 (2023-10-02) Change This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' R-.\nIf ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.\nChange Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.\nThis can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See th' documentat'n fer how t' do this.\nThis feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n shortcuts t' planks inside o' yer project wit' a headless branch parent.\nIn this case it be advised t' remove th' title from th' headless branch parent’s frontmatter, as it will otherwise appear 'n yer breadcrumbs.\nNew It be now poss'ble t' overwrite th' sett'n fer collapsibleMenu o' yer hugo.toml inside o' a page’s frontmatter.\nNew If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.\nNew It be now poss'ble t' remove th' root breadcrumb by sett'n disableRootBreadcrumb=true 'n yer hugo.toml.\nNew Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.\nNew T'ble rows now change their background color on every even row.\nNew Translat'n into Swahili. This language be not supported fer search.\n5.21.0 (2023-09-18) Change We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer menu-footer.html partial overridden, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.\nNew This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See th' documentat'n fer further details.\nNew Th' theme has updated its Swagger dependency t' 5.7.2 fer th' openapi shortcode. This br'ns support fer OpenAPI Specificat'n 3.1.\n5.20.0 (2023-08-26) Change Th' theme has updated its Swagger dependency t' 5.4.1 fer th' openapi shortcode.\nWit' this comes a change 'n th' light theme variants o' Relearrrn Bright, Relearrrn Light an' Zen Light by switch'n th' syntaxhighlightn'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.\nAdditionally, th' syntaxhighlightn'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.\nIf ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed th' CSS vari'ble --MENU-SECTION-HR-color t' --MENU-SECTION-SEPARATOR-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Th' theme variants Zen Light an' Zen Dark now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.\nThose borders be now configur'ble by us'n th' CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color an' --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor exist'n variants noth'n has changed visually.\nNew Th' default values fer th' image effects be now configur'ble fer yer whole ship via hugo.toml or fer each plank thru frontmatter.\nNew This release fixes a long outstand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed expand or inactive tabs.\nNew Restored compatibility wit' Cap'n Hugo versions lower than 0.111.0 fer th' highlight shortcode. This does not change th' minimum required Cap'n Hugo version.\n5.19.0 (2023-08-12) New Th' highlight shortcode now accepts th' new parameter title. This displays th' code like a single tab. This be also avail'ble us'n codefences an' makes it much easier t' write nicer code samples.\nNew Th' theme has added two new color variants zen-light an' zen-dark. Check it out!\nNew Th' theme now dispatches th' custom event themeVariantLoaded on th' document when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.\nNew Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' sankey diagram type an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).\nNew Translat'n into Hungarian.\n5.18.0 (2023-07-27) Change Th' theme adds additional warnings fer deprecated or now unsupported features.\nChange There be visual improvements 'n display'n text links 'n yer rrrambl'n aswell as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.\nNew Restored compatibility wit' Cap'n Hugo 0.95.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' siteparam shortcode be now cap'ble 'n display'n nested params aswell as support'n text formatt'n.\n5.17.0 (2023-06-22) Change Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.\nTh' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.\nIf ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n [params] disableHoverBlockCopyToClipBoard=true t' yer hugo.toml.\nNew Restored compatibility wit' Cap'n Hugo 0.114.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nNew Th' new highlight shortcode replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.\nIn addit'n it offers some extensions. Currently only th' wrap extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.\n5.16.0 (2023-06-10) Change Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documenat'n.\nDEPRECATION warnings mark features that still work but may be removed 'n th' future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange Th' 404 error plank was revamped. Hopefully ye will not see this very often.\nNew Th' tabs shortcode an' th' tab shortcode received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.\nTh' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.\nAdditionally th' name parameter was renamed t' title but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.\nNew Th' theme now optionally supports separate favicons fer light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility wit' Cap'n Hugo 0.112.0 or higher. This does not change th' minimum required Cap'n Hugo version.\nTh' attachments shortcode has compatiblity issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo \u003c 0.112.0 fer now.\nIt be planned t' refactor th' attchments shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a break'n change.\nChange Th' tabs shortcode has changed behavior if ye haven’t set th' groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.\nNew Th' already known tabshas a new friend th' tab shortcode t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.\nAdditionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.\nNew Besides th' tag taxonomy th' theme now also provides th' category taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.\n5.14.0 (2023-05-20) New Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.\nHugo’s default taxonmies tags an' categories be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer hugo.toml.\nNew T' give ye more flexibility 'n customiz'n yer article layout a new partial content-header.html be introduced.\nThis came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional taxonomies not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.\nSo how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?\nHide tags above title: Overwrite content-header.html wit' an empty file. Show tags between title an' rrrambl'n: Overwrite heading-post.html an' add {{- partial \"tags.html\" . }} t' it. Show tags below rrrambl'n: Overwrite content-footer.html an' add {{- partial \"tags.html\" . }} t' it. New Th' new parameter breadcrumbSeparator be now avail'ble 'n yer hugo.toml t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.\n5.13.0 (2023-05-17) Change Th' swagger shortcode was deprecated 'n favor fer th' openapi shortcode. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' swagger shortcode 'n th' next major release.\nAdditionally, th' implemant'n o' this shortcode was switched from RapiDoc t' SwaggerUI.\n5.12.0 (2023-05-04) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Support fer th' great VSCode Front Matter extension which provides on-premise CMS capabilties t' Cap'n Hugo.\nTh' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer frontmatter.json like this\n{ ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' pirate translat'n. This feature be not avail'ble 'n Internet Explorer 11.\nNew Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.\n5.11.0 (2023-02-07) Change Th' theme removed th' popular jQuery library from its distribut'n.\nIn case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer static/js directory an' board it from yer own layouts/partials/custom-header.html like this:\n\u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Merrrmaid diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.\nTh' default sett'n o' on, 'n effect since 1.1.0, changed back t' off as there was interference wit' scroll'n on mobile an' big planks.\nChange Th' theme be now cap'ble t' visually adapt t' yer OS’s light/dark mode sett'n.\nThis be also th' new default sett'n if ye haven’t configured themeVariant 'n yer hugo.toml.\nAdditionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new themeVariantAuto parameter.\nThis be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nChange Th' JavaScript code fer handl'n image lightboxes (provided by Featherlight) was replaced by a CSS-only solut'n.\nThis also changed th' lightbox effects parameter from featherlight=false t' lightbox=false. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.\nChange In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' expand shortcode was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.\nNew Translat'n into Czech. This language be not supported fer search.\nNew GitHub releases be also now tagged fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) release mak'n it easier fer ye t' pin th' theme t' a certain version.\n5.10.0 (2023-01-25) New Th' attachments, badge, button an' notice shorrrtcodes have a new parameter color t' set arbitrary CSS color values.\nAdditionally th' --ACCENT-color brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.\n5.9.0 (2022-12-23) Break'n Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.\nIt was later discovered, that this causes planks only meant t' be displayed 'n th' More section o' th' menu an' stored directly inside yer rrrambl'n directory t' now show up 'n th' menu aswell.\nT' get rid o' this undesired behavior ye have two choices:\nMake th' plank file a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store th' plank file fer below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\ntitle = \"Credits\" Change Th' required folder name fer th' attachments shortcode was changed fer leaf bundles.\nPreviously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a files subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a index.files directory. Although th' old files directory be now deprecated, if both directories be present, only th' old files directory will be used fer compatiblity.\nChange Absolute links prefixed wit' http:// or https:// be now opened 'n a separate browser tab.\nYe can revert back t' th' old behavior by defin'n externalLinkTarget=\"_self\" 'n th' params section o' yer hugo.toml.\nNew Th' theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New Th' new badge shortcode be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.\nNew Th' new ay'con shortcode simplyfies th' usage o' ay'cons. This can even be combined wit' also new badge shortcode.\nNew Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely task lists, defint'n lists an' footnotes.\nNew A new color --ACCENT-color was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old yellow color be still used as default.\n5.7.0 (2022-11-29) Change Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code ko. Formerly th' country code kr was used instead.\nNew Th' button shortcode can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.\nNew Th' search now supports th' Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.\nT' activate this feature, ye need t' configure it 'n yer hugo.toml as a new outputformat SEARCHPAGE fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.\nYe can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.\nNew Keyboard handl'n fer th' TOC an' search was improved.\nPress'n CTRL+ALT+t now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' TAB key.\nTh' search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.\nNew Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.\nT' configure this 'n yer hugo.toml make sure t' set Hugo’s disableHugoGeneratorInject=true an' also [params] disableGeneratorVersion=true, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.\nNew Creat'n o' yer project gets a little bit faster wit' this release.\nThis addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).\n5.5.0 (2022-11-06) Change Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.\nFor that th' JavaScript code t' handle th' lightbox an' image effects on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.\nIf ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML img URLs manually t' th' respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change Wit' th' proper sett'ns 'n yer hugo.toml yer plank be now serv'ble from th' local file system us'n file:// URLs.\nPlease note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer hugo.toml from JSON t' SEARCH. Th' now deprecated JSON outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from http:// or https://.\nChange Th' button shortcode has a new parameter target t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.\nNew Th' math shortcode an' mermaid shortcode now also support th' align parameter if codefence rules be used.\nNew Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.\nNew Translat'n into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).\nNew Image formatt'n has two new classes t' align images t' th' left or right. Additionally, th' already exist'n inline opt'n be now documented.\nNew Print'n fer th' swagger shortcode was optimized t' expand sections that be usually closed 'n interactive mode. This requires print support t' be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true 'n yer hugo.toml, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Cap'n Hugo version.\nChange Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a index.print.html t' th' default URL.\nYe can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer hugo.tomlt':\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' permalink'ble = false 5.0.0 (2022-07-05) Break'n Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate *.js file (if not already) an' add th' defer keyword t' th' script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change Th' way archetypes be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.\nYer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n after th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:\nfer yer home plank, add th' frontmatter parameter archetype = \"home\" an' remove th' lead'n head'n\nfer all files contain'n th' deprecated frontmatter parameter chapter = true, replace it wit' archetype = \"chapter\" an' remove th' lead'n head'ns\nChange Th' frontmatter opt'ns pre / post were renamed t' menuPre / menuPost. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.\nNew Add'n new partials heading-pre.html / heading-post.html an' accord'n frontmatter opt'ns headingPre / headingPost t' modify th' way yer page`s main head'n gets styled.\nNew Th' new shortcode math be avail'ble t' add beautiful math an' chemical formulae. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n4.2.0 (2022-06-23) Break'n Th' second parameter fer th' include shortcode was switched 'n mean'n an' was renamed from showfirsthead'n t' hidefirsthead'n. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.\nIf you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.\nChange Previously, if th' tabs shortcode could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.\nChange Th' landingPageURL was removed from hugo.toml. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically an' will point t' th' project’s homepage. If ye want t' support a different link, overwrite th' logo.html partial.\nNew All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.\n4.1.0 (2022-06-12) New While fix'n issues wit' th' search functionality fer non Latin languages, ye can now configure t' have multiple languages on a single plank. 4.0.0 (2022-06-05) Break'n Th' custom_css config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' custom-header.html template 'n a much more generic manner.\nBreak'n Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove --MAIN-ANCHOR-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from --MAIN-LINK-color an' --MAIN-ANCHOR-HOVER-color respectively.\nNew All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.\nThis applies t' expand, include, notice an' siteparam.\nNew Th' button shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.\nNew New colors --PRIMARY-color an' --SECONDARY-color were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have primary or secondary as additional values.\nThese two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.\nNew Translat'n into Polish. This language be not supported fer search.\nNew Th' documentat'n fer all shorrrtcodes were revised.\n3.4.0 (2022-04-03) Break'n If ye had previously overwritten th' custom-footer.html partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial content-footer.html. custom-footer.html was never meant t' contain HTML other than additional styles an' JavaScript.\nNew If ye prefer expandable/collaps'ble menu items, ye can now set collapsibleMenu=true 'n yer hugo.toml. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.\nNew Ye can activate print support 'n yer hugo.toml t' add th' capability t' print whole chapters or even th' complete ship.\nNew Translat'n into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between --MAIN-font fer all rrrambl'n text an' --CODE-font fer inline or block code. There be additional overrides fer all head'ns. See th' theme variant generator o' th' exampleSite fer all avail'ble variables.\nNew Th' new shortcode swagger be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' documentat'n fer avail'ble features. This feature will not work wit' Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Cap'n Hugo version.\nChange In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' disableMermaid config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.\nTh' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set disableMermaid=false 'n yer frontmatter t' force th' library t' be boarded. See th' theme variant generator o' th' exampleSite fer an example.\nNew Additional color variant vari'ble --MERMAID-theme t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.\n3.1.0 (2022-03-15) New attachment an' notice shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all Font Awesome 5 Free ay'cons. 3.0.0 (2022-02-22) Break'n We made changes t' th' menu footer. If ye have yer menu-footer.html partial overridden, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' menu-footer.html partial that be com'n wit' th' exampleSite.\nThis change was made t' allow yer own menu footer t' be placed right after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' Clear history functionality).\nBreak'n We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.\nThis change will only affect yer installat'n if you’ve not set th' themeVariant parameter 'n yer hugo.toml. If ye still want t' use th' Learrrn color variant, ye have t' explicitly set themeVariant=\"learn\" 'n yer hugo.toml.\nAvast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove --MENU-SEARCH-BOX-ICONS-color an' introduced --MENU-SEARCH-color instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color t' --MENU-SEARCH-BORDER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nNew Wit' this release ye be now cap'ble t' define yer own dark mode variants.\nT' make this poss'ble, we have introduced a lot more color variables ye can use 'n yer color variants. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.\nT' see what’s now poss'ble, see th' new variants relearn-dark an' neon that be com'n wit' this release.\nNew T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive theme variant generator. This feature will not work wit' Internet Explorer 11.\nNew Ye can now configure multiple color variants 'n yer hugo.toml. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant selector will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant selector will not be displayed wit' Internet Explorer 11.\n2.9.0 (2021-11-19) Break'n This release removes th' themes implementat'n o' ref/relref 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.\nIn a standard compliant form ye must not link t' th' *.md file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configurat'n Leaf bundle basics/configuration/index.md basics/configurat'n Plank basics/configurat'n.md basics/configurat'n If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but Cap'n Hugo got ye covered as well.\nAlso, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.\nIn th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server after an upgrade an' no errors be written t' th' console.\nYe may see errors on th' console after th' update 'n th' form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": plank not foundIn this case, ye must apply one o' two opt'ns:\nStart up a text editor wit' regular expression support fer search an' replace. Search fer (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" an' replace it by $1$2\" 'n all *.md files. This be th' recommended choice.\nCopy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes th' font Novacento/Novecento. If ye use it 'n an overwritten CSS please replace it wit' Work Sans. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.\nNew Th' theme now supports favicons served from static/images/ named as favicon or logo 'n SVG, PNG or ICO format out o' th' box. An overridden partial layouts/partials/favicon.html may not be necessary anymore 'n most cases.\nNew Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' disableToc opt'n 'n yer hugo.toml. For an example see th' example configurat'n.\n2.7.0 (2021-10-24) New Optional second parameter fer notice shortcode t' set title 'n box header. 2.6.0 (2021-10-21) New Yer ship can now be served from a subfolder if ye set baseURL an' canonifyURLs=true 'n yer hugo.toml. See th' documentat'n fer a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color an' --CODE-BLOCK-BG-color were added t' provide a fallback fer Hugos rules highlight'n 'n case no language was given or th' language be unsupported. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style. 2.4.0 (2021-10-07) Change Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.\nNew Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n disableTagHiddenPages=true 'n yer hugo.toml.\nNew Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' alwaysopen opt'n 'n yer hugo.toml. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New frontmatter ordersectionsby opt'n t' change immediate children sort'n 'n menu an' children shortcode. Poss'ble values be title or weight.\nNew Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See Cap'n Hugo documentat'n.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Cap'n Hugo version.\nNew Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.\n2.2.0 (2021-09-09) New Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n disableSeoHiddenPages=true 'n yer hugo.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Cap'n Hugo version.\nChange In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see CHANGELOG.md 'n th' exampleSite), they will now be ignored by th' search.\nNew Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n disableSearchHiddenPages=true 'n yer hugo.toml.\nNew If a search term be found 'n an expand shortcode, th' expand will be opened.\nNew Th' menu will scroll th' active item into view on board.\n2.0.0 (2021-08-28) Change Rules highlight'n was switched t' th' built 'n Hugo mechanism. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n\nChange In th' predefined stylesheets there was a typo an' --MENU-HOME-LINK-HOVERED-color must be changed t' --MENU-HOME-LINK-HOVER-color. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.\nChange --MENU-HOME-LINK-color an' --MENU-HOME-LINK-HOVER-color were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.\nChange Arrow navigat'n an' children shortcode were ignor'n sett'n fer ordersectionsby. This be now changed an' may result 'n different sort'n order o' yer sub planks.\nChange If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.\nChange A plank without a title will be treated as hidden=true.\nNew Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further documentat'n fer poss'ble values an' default behavior.\nNew New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See documentat'n fer further read'n.\nNew Shortcode children wit' new parameter containerstyle.\nNew New shortcode include t' include arbitrary file rrrambl'n into a plank.\n1.2.0 (2021-07-26) New Shortcode expand wit' new parameter t' open on plank board. 1.1.0 (2021-07-02) Break'n Merrrmaid diagrams can now be panned an' zoomed. This isn’t configur'ble yet.\nNew Merrrmaid config opt'ns can be set 'n hugo.toml.\n1.0.0 (2021-07-01) 0.65.0 Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.\nNew Initial fork o' th' Learrrn theme based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' Relearrrn an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see this comment 'n th' Learrrn issues.\n", "description": "", "tags": null, "title": "What's New", @@ -51,7 +51,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number or delete th' whole weight parameter entirely.\nSelf defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n", + "content": " Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number or delete th' whole weight parameter entirely.\nSelf defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n", "description": "", "tags": null, "title": "Arrrchetypes", @@ -75,7 +75,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nSmarrrt Arrrse Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'n This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Result grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables In GFM (GitHub Flavored Markdown) ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | |--------|-------------| | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble thru yer config.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", + "content": " Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nSmarrrt Arrrse Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. --- Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'n This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```js grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; ``` Result grunt.initConfig({ assemble: { opt'ns: { assets: 'docs/assets', data: 'src/data/*.{json,yml}', helpers: 'src/custom-helpers.js', partials: ['src/partials/**/*.{hbs,md}'] }, planks: { opt'ns: { layout: 'default.hbs' }, files: { './': ['src/templates/pages/index.hbs'] } } } }; Tables In GFM (GitHub Flavored Markdown) ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.\n| Opt'n | Descript'n | |--------|-------------| | data | path t' data files t' supply th' data that will be passed into templates. | | engine | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | extension t' be used fer dest files. | Result Opt'n Descript'n data path t' data files t' supply th' data that will be passed into templates. engine engine t' be used fer process'n templates. Handlebars be th' default. ext extension t' be used fer dest files. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble thru yer hugo.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", "description": "", "tags": [ "Content" @@ -85,7 +85,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Th' theme supports non-standard image effects.\nAs described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer config.toml aswell as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer config.toml this defaults t'\n​ config.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden 'n a planks frontmatter by eg.\n​ frontmatter +++ [imageEffects] border = true +++ Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) Th' sett'ns applied t' th' above image would be\n​ Result border = true lightbox = false shadow = false bg-white = true This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" alt=\"Minion\" class=\"bg-white border nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer config.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' config.toml or planks frontmatter.\n", + "content": " Th' theme supports non-standard image effects.\nAs described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer hugo.toml aswell as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer hugo.toml this defaults t'\n​ hugo.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden 'n a planks frontmatter by eg.\n​ frontmatter +++ [imageEffects] border = true +++ Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) Th' sett'ns applied t' th' above image would be\n​ Result border = true lightbox = false shadow = false bg-white = true This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" alt=\"Minion\" class=\"bg-white border nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer hugo.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' hugo.toml or planks frontmatter.\n", "description": "", "tags": null, "title": "Image Effects", @@ -93,7 +93,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overridden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n[Shortcuts-Title] other = \"\u003cYour value\u003e\"Read more about hugo menu an' hugo i18n translat'n str'ns\nConfigurat'n fer Multilingual mode When us'n a multilingual website, ye can set different menus fer each language. In th' config.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = \"more/credits/\" weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = \"tags/\" weight = 40 [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = \"more/credits/\" weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = \"tags/\" weight = 40Read more about hugo menu an' hugo multilingual menus\nShortcuts t' planks inside o' yer project If ye have shortcuts t' planks inside o' yer project an' ye don’t want them t' show up 'n plank menu section, ye have two choices:\nMake th' plank file fer th' shortcut a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store th' plank file fer th' shortcut below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\ntitle = \"Credits\" ", + "content": " Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.\nBasic configurat'n Edit th' website configurat'n hugo.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.\nExample from th' current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overridden by chang'n yer local i18n translat'n str'n configurat'n.\nFor example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n\n[Shortcuts-Title] other = \"\u003cYour value\u003e\"Read more about hugo menu an' hugo i18n translat'n str'ns\nConfigurat'n fer Multilingual mode When us'n a multilingual website, ye can set different menus fer each language. In th' hugo.toml file, prefix yer menu configurat'n by Languages.\u003clanguage-id\u003e.\nExample from th' current website:\n[languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" pageRef = \"more/credits/\" weight = 30 [[languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" pageRef = \"tags/\" weight = 40 [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" pageRef = \"showcase/\" weight = 11 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" pageRef = \"more/credits/\" weight = 30 [[languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" pageRef = \"tags/\" weight = 40Read more about hugo menu an' hugo multilingual menus\nShortcuts t' planks inside o' yer project If ye have shortcuts t' planks inside o' yer project an' ye don’t want them t' show up 'n plank menu section, ye have two choices:\nMake th' plank file fer th' shortcut a headless branch bundle (contained 'n its own subdirectory an' called _index.md) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s content/showcase/_index.en.md). This causes its rrrambl'n t' not be ontained 'n th' sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store th' plank file fer th' shortcut below a parent headless branch bundle an' add th' follow'n frontmatter t' he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s content/more/credits.en.md). This causes its rrrambl'n t' be contained 'n th' sitemap.\ntitle = \"Credits\" ", "description": "", "tags": null, "title": "Menu extrrra shorrrtcuts", @@ -101,7 +101,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nAvail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.\nFor example wit' current English an' Piratized English website.\nAvast Make sure yer default language be defined as th' first one 'n th' [languages] array, as th' theme needs t' make assumpt'ns on it\n# English be th' default language defaultContentLanguage = \"en\" [languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\"Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' site’s search via th' Lunr search library does not. You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nCzech Indonesian Polish Swahili Search wit' mixed language support In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer config.toml t' broaden search.\n[params] additionalContentLanguage = [ \"en\" ]As this be an array, ye can add multiple additional languages.\nAvast Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n zh-CN, ye have t' add just zh t' this parameter.\nOverwrite translat'n str'ns Translat'ns str'ns be used fer common default values used 'n th' theme (Edit button, Search placeholder an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.\nT' override these values, create a new file 'n yer local i18n folder i18n/\u003cidlanguage\u003e.toml an' inspire yourself from th' theme themes/hugo-theme-relearn/i18n/en.toml\nDis'ble language switch'n Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.\nJust set disableLanguageSwitchingButton=true 'n yer config.toml\n[params] # When us'n multilingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = true ", + "content": " Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.\nAvail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute! Full support fer languages written right t' left Automatic menu generat'n from multilingual rrrambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer hugo.toml file.\nFor example wit' current English an' Piratized English website.\nAvast Make sure yer default language be defined as th' first one 'n th' [languages] array, as th' theme needs t' make assumpt'ns on it\n# English be th' default language defaultContentLanguage = \"en\" [languages] [languages.en] title = \"Hugo Relearrrn Theme\" weight = 1 languageName = \"English\" [languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\"Then, fer each new plank, append th' id o' th' language t' th' file.\nSingle file my-page.md be split 'n two files: 'n English: my-page.md 'n Piratized English: my-page.pir.md Single file _index.md be split 'n two files: 'n English: _index.md 'n Piratized English: _index.pir.md Ahoi Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.\nSmarrrt Arrrse Use slug frontmatter parameter t' translate urls too.\nSearch In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.\nArrr Although th' theme supports a wide variety o' supported languages, th' site’s search via th' Lunr search library does not. You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:\nCzech Indonesian Polish Swahili Search wit' mixed language support In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer hugo.toml t' broaden search.\n[params] additionalContentLanguage = [ \"en\" ]As this be an array, ye can add multiple additional languages.\nAvast Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n zh-CN, ye have t' add just zh t' this parameter.\nOverwrite translat'n str'ns Translat'ns str'ns be used fer common default values used 'n th' theme (Edit button, Search placeholder an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.\nT' override these values, create a new file 'n yer local i18n folder i18n/\u003cidlanguage\u003e.toml an' inspire yourself from th' theme themes/hugo-theme-relearn/i18n/en.toml\nDis'ble language switch'n Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.\nJust set disableLanguageSwitchingButton=true 'n yer hugo.toml\n[params] # When us'n multilingual website, dis'ble th' switch language button. disableLanguageSwitchingButton = true ", "description": "", "tags": null, "title": "Multilingual an' i18n", @@ -109,7 +109,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box.\nConfigurat'n Just add tags and/or categories t' any plank. They can be given as a single str'n or an array o' str'ns.\n+++ categories = [\"taxonomy\", \"content\"] tags = \"tutorial\" title = \"Taxonomy\" +++Behavior Th' tags be displayed at th' top o' th' plank 'n alphabetical order.\nTh' categories be displayed at th' bottom o' th' plank 'n alphabetical order 'n th' default implementat'n o' th' theme but can be customized by provid'n yer own content-footer.html partial.\nEach item be a link t' a taxonomy plank display'n all th' articles wit' th' given term.\nList all th' tags In th' config.toml file ye can add a shortcut t' display all th' tags an' categories\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" [[menu.shortcuts]] name = \"\u003ci class='fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = \"/categories\"Customizat'n If ye define custom taxonomies an' want t' display a list o' them somewhere on yer plank (often 'n th' layouts/partials/content-footer.html) ye can call a partial that does th' job fer ye:\n{{- partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. taxonomy \u003cempty\u003e Th' plural name o' th' taxonomy t' display as used 'n yer frontmatter. class \u003cempty\u003e Additional CSS classes set on th' outermost generated HTML element.\nIf set t' tags ye will get th' visuals fer display'n th' tags taxonomy, otherwise it will be a simple list o' links as fer th' categories taxonomy. style primary Th' style scheme used if class be tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used if class be tags. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con \u003cempty\u003e An optional Font Awesome ay'con name set t' th' left o' th' list. ", + "content": " Th' Relearrrn theme supports Hugo’s default taxonomies tag an' category out o' th' box.\nConfigurat'n Just add tags and/or categories t' any plank. They can be given as a single str'n or an array o' str'ns.\n+++ categories = [\"taxonomy\", \"content\"] tags = \"tutorial\" title = \"Taxonomy\" +++Behavior Th' tags be displayed at th' top o' th' plank 'n alphabetical order.\nTh' categories be displayed at th' bottom o' th' plank 'n alphabetical order 'n th' default implementat'n o' th' theme but can be customized by provid'n yer own content-footer.html partial.\nEach item be a link t' a taxonomy plank display'n all th' articles wit' th' given term.\nList all th' tags In th' hugo.toml file ye can add a shortcut t' display all th' tags an' categories\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" [[menu.shortcuts]] name = \"\u003ci class='fas fa-layer-group'\u003e\u003c/i\u003e Categories\" url = \"/categories\"Customizat'n If ye define custom taxonomies an' want t' display a list o' them somewhere on yer plank (often 'n th' layouts/partials/content-footer.html) ye can call a partial that does th' job fer ye:\n{{- partial \"term-list.html\" (dict \"page\" . \"taxonomy\" \"categories\" \"icon\" \"layer-group\" ) }}Parameter Name Default Notes plank \u003cempty\u003e Mandatory reference t' th' plank. taxonomy \u003cempty\u003e Th' plural name o' th' taxonomy t' display as used 'n yer frontmatter. class \u003cempty\u003e Additional CSS classes set on th' outermost generated HTML element.\nIf set t' tags ye will get th' visuals fer display'n th' tags taxonomy, otherwise it will be a simple list o' links as fer th' categories taxonomy. style primary Th' style scheme used if class be tags.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used if class be tags. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con \u003cempty\u003e An optional Font Awesome ay'con name set t' th' left o' th' list. ", "description": "", "tags": "tutorrrial", "title": "Taxonomy", @@ -136,7 +136,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eInstall th' theme Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nFrom Git If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.\nIf ye use th' head o' th' main branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.\nAdditionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.\nBesides th' usual version tags (eg 1.2.3) there be also tags fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) released version mak'n it easier fer ye t' pin th' theme t' a certain version.\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (config.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"SEARCH\"]Create yer first chapter plank Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.\n### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.renders as\nTh' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command\nhugo new --kind chapter basics/_index.mdBy open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.mdFeel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serveGo t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugoA public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks.\n", + "content": " Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this great documentat'n fer beginners.\nCreate yer project Cap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eInstall th' theme Install th' Relearrrn theme by follow'n this documentat'n us'n Hugo’s module system.\nThis theme’s repository be: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory\nFrom Git If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.\nIf ye use th' head o' th' main branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.\nAdditionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official releases from th' GitHub repository.\nBesides th' usual version tags (eg 1.2.3) there be also tags fer th' main version (eg. 1.2.x), major version (eg. 1.x) an' th' latest (just x) released version mak'n it easier fer ye t' pin th' theme t' a certain version.\nBasic configurat'n When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (hugo.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.\n# Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"SEARCH\"]Create yer first chapter plank Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.\n### Chapter 1 # Basics Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.renders as\nTh' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command\nhugo new --kind chapter basics/_index.mdBy open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.\nBy default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.\nCreate yer first rrrambl'n planks Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.mdFeel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.\nLaunch'n th' website locally Launch by us'n th' follow'n command:\nhugo serveGo t' http://localhost:1313\nYe should notice three th'ns:\nYe have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files. Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns. When ye run hugo serve, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat! Build th' website When yer ship be ready t' deploy, run th' follow'n command:\nhugoA public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.\nAvast This website can be automatically published an' hosted wit' Netlify (Read more about Automated HUGO deployments wit' Netlify). Alternatively, ye can use GitHub planks.\n", "description": "", "tags": [ "documentat'n" @@ -146,7 +146,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer config.toml. Th' defaults be written 'n th' comments o' each opt'n.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\n​ config.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Th' descript'n o' yer ship. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. descript'n = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These opt'ns set yer color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explainat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In tihs case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Multilanguage rrrambl'n. # Default: not set # If yer planks contain further languages besides th' main one used, add all # those auxiliary languages here. This will create a search index wit' # support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See config.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' given URL be prepended t' th' # relative file path o' a th' displayed plank. Th' URL must end wit' a `/`. # This be useful if ye wnat t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Hide th' search box. # Default: false # If th' searc box be sisabled, th' search functionality be disabled too. # This will also cause th' keyboard shortcut t' be disabled an' th' dedicated # search plank be not linked although it mighty be configured. disableSearch = false # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Hide head'n above th' shortcut menu. # Default: false # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opit'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: \"::\" # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = \"\u003e\" # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or thru URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # How t' open external links. # Default: \"_blank\" # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", + "content": " On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml. Th' defaults be written 'n th' comments o' each opt'n.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\n​ hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Th' descript'n o' yer ship. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. descript'n = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These opt'ns set yer color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explainat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In tihs case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Multilanguage rrrambl'n. # Default: not set # If yer planks contain further languages besides th' main one used, add all # those auxiliary languages here. This will create a search index wit' # support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See hugo.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' given URL be prepended t' th' # relative file path o' a th' displayed plank. Th' URL must end wit' a `/`. # This be useful if ye wnat t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Hide th' search box. # Default: false # If th' searc box be sisabled, th' search functionality be disabled too. # This will also cause th' keyboard shortcut t' be disabled an' th' dedicated # search plank be not linked although it mighty be configured. disableSearch = false # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Hide head'n above th' shortcut menu. # Default: false # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opit'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: \"::\" # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = \"\u003e\" # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or thru URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # How t' open external links. # Default: \"_blank\" # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", "description": "", "tags": [ "config" @@ -167,7 +167,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed thru so called color variants.\nA color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer config.toml.\nTh' Relearrrn theme ships wit' a wide set o' different color variants. Ye can use them as-is, copy them over an' use them as a start'n point fer yer customizat'ns or just create completely new variants unique t' yer ship. Th' interactive variant generator may help ye wit' this task.\nOnce configured 'n yer config.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.\nChange th' Variant (Simple) Single Variant Set th' themeVariant value t' th' name o' yer theme file. That’s it! Yer ship will be displayed 'n this variant only.\n​ config.toml [params] themeVariant = \"relearn-light\" Avast Yer theme variant file must reside 'n yer site’s static/css directory or 'n th' theme’s static/css directory an' th' file name must start wit' theme- an' end wit .css. In th' above example, th' path o' yer theme file must be static/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s static/css directory. Don’t edit th' file 'n th' theme’s directory!\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\n​ config.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Smarrrt Arrrse Th' theme provides an advanced configurat'n mode, combin'n th' functionality fer multiple variants wit' th' below possibilities o' adjust'n t' yer OS sett'ns, logo an' rules highlightn'n an' even more!\nAlthough all opt'ns documented here be still work'n, th' advanced configurat'n opt'ns be th' recommended way t' configure yer color variants. See below.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto t' become an auto mode variant. That’s it.\nYe can use th' auto value wit' th' single or multiple variants opt'n. If ye be us'n multiple variants, ye can drop auto at any posit'n 'n th' option’s array, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\n​ config.toml [params] themeVariant = [ \"auto\", \"red\" ] If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant opt'n if present.\nIn th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.\nIf ye don’t like that behavior, ye can explicitly set themeVariantAuto. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode.\n​ config.toml [params] themeVariantAuto = [ \"learn\", \"neon\" ] Change th' Favicon If yer favicon be a SVG, PNG or ICO, just drop yer image 'n yer site’s static/images/ directory an' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf ye want t' adjust yer favicon accord'n t' yer OS sett'ns fer light/dark mode, add th' image files static/images/favicon-light.svg an' static/images/favicon-dark.svg t' yer site’s directory, respectively, correspond'n t' yer file format. In case some o' th' files be miss'n, th' theme falls back t' favicon.svg fer each miss'n file. All supplied favicons must be o' th' same file format.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file layouts/partials/favicon.html 'n yer site’s directory an' write someth'n like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' Logo Create a new file 'n layouts/partials/logo.html o' yer ship. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically.\nRules Highlightn'n If ye want t' switch th' rules highlight'n theme together wit' yer color variant, ye need t' configure yer installat'n accord'n t' Hugo’s documentat'n an' provide a rules highlight'n stylesheet file.\nYe can use a one o' th' shipped stylesheet files or use Cap'n Hugo t' generate a file fer ye. Th' file must be written t' static/css/chroma-\u003cNAME\u003e.css. T' use it wit' yer color variant ye have t' define --CODE-theme: \u003cNAME\u003e 'n th' color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.\nChange th' Variant (Advanced) Th' theme offers a new way t' configure theme variants an' all o' th' aspects above inside o' a single configurat'n item. This comes wit' some features previously unsupported.\nLike wit' th' multiple variants opt'n, ye be defin'n yer theme variants 'n an array but now not by simple str'ns but 'n a t'ble wit' subopt'ns.\nAgain, 'n this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\n​ config.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] ye now write it that way:\n​ config.toml [params] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" Th' identifier opt'n be mandatory an' equivalent t' th' str'n 'n th' first example. Further opt'ns can be configured, see th' t'ble below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond t' th' name o' a color variant either 'n yer site’s or th' theme’s directory 'n th' form static/css/theme-\u003cIDENTIFIER\u003e.css. name see notes Th' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form. auto \u003cempty\u003e If set, th' variant be treated as an auto mode variant. It has th' same behavior as th' themeVariantAuto opt'n. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode. Defin'n auto mode variants wit' th' advanced opt'ns has th' benefit that ye can now have multiple auto mode variants instead o' just one wit' th' simple opt'ns. Example Configurat'n o' This Ship ​ config.toml [params] [[params.themeVariant]] identifier = \"relearn-auto\" name = \"Relearn Light/Dark\" auto = [] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" [[params.themeVariant]] identifier = \"zen-auto\" name = \"Zen Light/Dark\" auto = [ \"zen-light\", \"zen-dark\" ] [[params.themeVariant]] identifier = \"zen-light\" [[params.themeVariant]] identifier = \"zen-dark\" [[params.themeVariant]] identifier = \"neon\" Modify Shipped Variants In case ye like a shipped variant but only want t' tweak some aspects, ye have two choices:\nCopy an' change\nYe can copy th' shipped variant file from th' theme’s static/css directory t' th' site’s static/css directory an' either store it wit' th' same name or give it a new name. Edit th' sett'ns an' save th' new file. Afterwards ye can use it 'n yer config.toml by th' choosen name.\nCreate an' import\nYe can create a new variant file 'n th' site’s static/css directory an' give it a new name. Import th' shipped variant, add th' sett'ns ye want t' change an' save th' new file. Afterwards ye can use it 'n yer config.toml by th' choosen name.\nFor example, ye want t' use th' relearn-light variant but want t' change th' rules highlightn'n schema t' th' one used 'n th' neon variant. For that, create a new static/css/theme-my-brand'n.css 'n yer site’s directory an' add th' follow'n lines:\n​ static/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: learn; /* name o' th' chroma styleheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color fer code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color fer code background */ } Afterwards put this 'n yer config.toml t' use yer new variant:\n​ config.toml [params] themeVariant = \"my-branding\" In comparison t' copy an' change, this has th' advantage that ye profit from any adjustments t' th' relearn-light variant but keep yer modificat'ns.\n", + "content": " Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site’s colors, favicon an' logo. This allows ye t' easily align yer ship visuals t' yer desired style. Most o' these opt'ns be exposed thru so called color variants.\nA color variant lets ye cust'mize various visual effects o' yer ship like almost any color, used fonts, color schemes o' print, rules highligtn'n, Merrrmaid an' th' OpenAPI shortcode, etc. It contains o' a CSS file an' optional configurat'n opt'ns 'n yer hugo.toml.\nTh' Relearrrn theme ships wit' a wide set o' different color variants. Ye can use them as-is, copy them over an' use them as a start'n point fer yer customizat'ns or just create completely new variants unique t' yer ship. Th' interactive variant generator may help ye wit' this task.\nOnce configured 'n yer hugo.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.\nChange th' Variant (Simple) Single Variant Set th' themeVariant value t' th' name o' yer theme file. That’s it! Yer ship will be displayed 'n this variant only.\n​ hugo.toml [params] themeVariant = \"relearn-light\" Avast Yer theme variant file must reside 'n yer site’s static/css directory or 'n th' theme’s static/css directory an' th' file name must start wit' theme- an' end wit .css. In th' above example, th' path o' yer theme file must be static/css/theme-relearn-light.css.\nIf ye want t' make changes t' a shipped color variant, create a copy 'n yer site’s static/css directory. Don’t edit th' file 'n th' theme’s directory!\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\n​ hugo.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Smarrrt Arrrse Th' theme provides an advanced configurat'n mode, combin'n th' functionality fer multiple variants wit' th' below possibilities o' adjust'n t' yer OS sett'ns, logo an' rules highlightn'n an' even more!\nAlthough all opt'ns documented here be still work'n, th' advanced configurat'n opt'ns be th' recommended way t' configure yer color variants. See below.\nAdjust t' OS Sett'ns Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' themeVariant t' auto t' become an auto mode variant. That’s it.\nYe can use th' auto value wit' th' single or multiple variants opt'n. If ye be us'n multiple variants, ye can drop auto at any posit'n 'n th' option’s array, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\n​ hugo.toml [params] themeVariant = [ \"auto\", \"red\" ] If ye don’t configure anyth'n else, th' theme will default t' use relearn-light fer light mode an' relearn-dark fer dark mode. These defaults be overwritten by th' first two non-auto opt'ns o' yer themeVariant opt'n if present.\nIn th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.\nIf ye don’t like that behavior, ye can explicitly set themeVariantAuto. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode.\n​ hugo.toml [params] themeVariantAuto = [ \"learn\", \"neon\" ] Change th' Favicon If yer favicon be a SVG, PNG or ICO, just drop yer image 'n yer site’s static/images/ directory an' name it favicon.svg, favicon.png or favicon.ico respectively.\nIf ye want t' adjust yer favicon accord'n t' yer OS sett'ns fer light/dark mode, add th' image files static/images/favicon-light.svg an' static/images/favicon-dark.svg t' yer site’s directory, respectively, correspond'n t' yer file format. In case some o' th' files be miss'n, th' theme falls back t' favicon.svg fer each miss'n file. All supplied favicons must be o' th' same file format.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file layouts/partials/favicon.html 'n yer site’s directory an' write someth'n like this:\n​ layouts/partials/favicon.html \u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003e Change th' Logo Create a new file 'n layouts/partials/logo.html o' yer ship. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically.\nRules Highlightn'n If ye want t' switch th' rules highlight'n theme together wit' yer color variant, ye need t' configure yer installat'n accord'n t' Hugo’s documentat'n an' provide a rules highlight'n stylesheet file.\nYe can use a one o' th' shipped stylesheet files or use Cap'n Hugo t' generate a file fer ye. Th' file must be written t' static/css/chroma-\u003cNAME\u003e.css. T' use it wit' yer color variant ye have t' define --CODE-theme: \u003cNAME\u003e 'n th' color variant stylesheet file.\nFor an example, take a look into theme-relearn-light.css an' hugo.toml o' th' exampleSite.\nChange th' Variant (Advanced) Th' theme offers a new way t' configure theme variants an' all o' th' aspects above inside o' a single configurat'n item. This comes wit' some features previously unsupported.\nLike wit' th' multiple variants opt'n, ye be defin'n yer theme variants 'n an array but now not by simple str'ns but 'n a t'ble wit' subopt'ns.\nAgain, 'n this case, th' first variant be th' default chosen on first view an' a variant selector will be shown 'n th' menu footer if th' array contains more than one entry.\n​ hugo.toml [params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ] ye now write it that way:\n​ hugo.toml [params] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" Th' identifier opt'n be mandatory an' equivalent t' th' str'n 'n th' first example. Further opt'ns can be configured, see th' t'ble below.\nParameter Name Default Notes identifier \u003cempty\u003e Must correspond t' th' name o' a color variant either 'n yer site’s or th' theme’s directory 'n th' form static/css/theme-\u003cIDENTIFIER\u003e.css. name see notes Th' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form. auto \u003cempty\u003e If set, th' variant be treated as an auto mode variant. It has th' same behavior as th' themeVariantAuto opt'n. Th' first entry 'n th' array be th' color variant fer light mode, th' second fer dark mode. Defin'n auto mode variants wit' th' advanced opt'ns has th' benefit that ye can now have multiple auto mode variants instead o' just one wit' th' simple opt'ns. Example Configurat'n o' This Ship ​ hugo.toml [params] [[params.themeVariant]] identifier = \"relearn-auto\" name = \"Relearn Light/Dark\" auto = [] [[params.themeVariant]] identifier = \"relearn-light\" [[params.themeVariant]] identifier = \"relearn-dark\" [[params.themeVariant]] identifier = \"zen-auto\" name = \"Zen Light/Dark\" auto = [ \"zen-light\", \"zen-dark\" ] [[params.themeVariant]] identifier = \"zen-light\" [[params.themeVariant]] identifier = \"zen-dark\" [[params.themeVariant]] identifier = \"neon\" Modify Shipped Variants In case ye like a shipped variant but only want t' tweak some aspects, ye have two choices:\nCopy an' change\nYe can copy th' shipped variant file from th' theme’s static/css directory t' th' site’s static/css directory an' either store it wit' th' same name or give it a new name. Edit th' sett'ns an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' choosen name.\nCreate an' import\nYe can create a new variant file 'n th' site’s static/css directory an' give it a new name. Import th' shipped variant, add th' sett'ns ye want t' change an' save th' new file. Afterwards ye can use it 'n yer hugo.toml by th' choosen name.\nFor example, ye want t' use th' relearn-light variant but want t' change th' rules highlightn'n schema t' th' one used 'n th' neon variant. For that, create a new static/css/theme-my-brand'n.css 'n yer site’s directory an' add th' follow'n lines:\n​ static/css/theme-my-brand'n.css @import \"theme-relearn-light.css\"; :root { --CODE-theme: learn; /* name o' th' chroma styleheet file */ --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color fer code text */ --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color fer code background */ } Afterwards put this 'n yer hugo.toml t' use yer new variant:\n​ hugo.toml [params] themeVariant = \"my-branding\" In comparison t' copy an' change, this has th' advantage that ye profit from any adjustments t' th' relearn-light variant but keep yer modificat'ns.\n", "description": "", "tags": null, "title": "Brrrand'n", @@ -175,7 +175,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nServ'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer config.toml:\nrelativeURLs = trueTh' theme will append an additional index.html t' all plank bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer config.toml\n[params] disableExplicitIndexURLs = true Avast If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated JSON t' SEARCH as seen below.\nActivate search If not already present, add th' follow'n lines 'n yer config.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\"]This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' SEARCH outputformat was named JSON 'n previous releases but was implemented differently. Although JSON still works, it be now deprecated.\nActivate dedicated search plank Ye can add a dedicated search plank fer yer plank by add'n th' SEARCHPAGE outputformat t' yer home plank by add'n th' follow'n lines 'n yer config.toml file. This will cause Cap'n Hugo t' generate a new file http://example.com/mysite/search.html.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\", \"SEARCHPAGE\"]Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n ENTER inside o' th' menu’s search box .\nAvast T' have Cap'n Hugo create th' dedicated search plank successfully, ye must not generate th' URL http://example.com/mysite/search.html from yer own rrrambl'n. This can happen if ye set uglyURLs=true 'n yer config.toml an' defin'n a Marrrkdown file content/search.md.\nT' make sure, there be no duplicate rrrambl'n fer any given URL o' yer project, run hugo --printPathWarn'ns.\nActivate print support Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' PRINT output format t' yer home, section an' plank 'n yer config.toml as seen below:\n[outputs] home = [\"HTML\", \"RSS\", \"PRINT\", \"SEARCH\"] section = [\"HTML\", \"RSS\", \"PRINT\"] plank = [\"HTML\", \"RSS\", \"PRINT\"]This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set uglyURLs=true 'n yer config.toml. This be due t' th' fact that fer one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine outputFormats.PRINT 'n yer own config.toml t' yer lik'n.\nHome Button Configurat'n If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure th' landingPageName fer th' defined languages:\n[languages] [languages.en] ... [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [languages.pir] ... [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ...If this opt'n be not configured fer a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\"Th' home button be go'n t' look like this:\nSocial Media Meta Tags Ye can add social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. These be configured as mentioned 'n th' Cap'n Hugo docs.\nChange th' Menu Width Th' menu width adjusts automatically fer different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 0 M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem Th' values fer th' screen width breakpoints aren’t configur'ble.\nIf ye want t' adjust th' menu width ye can define th' follow'n CSS variables 'n yer custom-header.html. Avast that --MENU-WIDTH-S doesn’t exist as th' menu be always hidden fer small screen sizes.\n:root { --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Own Shorrrtcodes wit' JavaScript Dependencies Certain shorrrtcodes make use o' additional JavaScript files. Th' theme only loads these dependencies if th' shortcode be used. T' do so correctly th' theme adds management code 'n various files.\nYe can ye use this mechanism 'n yer own shorrrtcodes. Say ye want t' add a shortcode myshortcode that also requires th' jquery JavaScript library.\nWrite th' shortcode file layouts/shortcodes/myshortcode.html an' add th' follow'n line\n{{- .Store.Set \"hasMyShortcode\" true }} Add th' follow'n snippet t' yer config.toml\n[params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = \"MyShortcode\" locat'n = \"footer\" Add th' dependency loader file layouts/partials/dependencies/myshortcode.html. Th' loader file will be appended t' yer header or footer, dependend on th' locat'n sett'n 'n yer config.toml.\n\u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e Character cas'n be relevant!\nth' name sett'n 'n yer config.toml must match th' key (that needs t' be prefixed wit' a has) ye used fer th' store 'n yer layouts/shortcodes/myshortcode.html. th' key on params.relearn.dependencies 'n yer config.toml must match th' base file name o' yer loader file. See th' math, mermaid an' openapi shorrrtcodes fer examples.\nOutput Formats Certain parts o' th' theme can be changed fer support o' yer own output formats. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/header.plaintext.html t' change th' way, th' plank header should look like fer that output format.\nReact t' Variant Switches 'n JavaScript Once a color variant be fully boarded, either initially or by switch'n th' color variant manually wit' th' variant selector, th' custom event themeVariantLoaded on th' document will be dispatched. Ye can add an event listener an' react t' changes.\ndocument.addEventListener( 'themeVariantLoaded', funct'n( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. See output-formats footer.html: th' footer o' th' plank. See output-formats body.html: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats article.html: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’t forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon heading-pre.html: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPre sett'n into account. heading-post.html: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPost sett'n into account. logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPost sett'n into account. menu-footer.html: footer o' th' the left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye want t' display page’s meta data above or below th' rrrambl'n. content-header.html: header above th' title, has a default implementat'n but ye can overwrite it if ye don’t like it. content-footer.html: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it. ", + "content": " Serv'n yer plank from a subfolder If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer hugo.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true relativeURLs = trueWithout canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nServ'n yer plank from th' filesystem If ye want yer plank served from th' filesystem by us'n URLs start'n wit' file:// you’ll need th' follow'n configurat'n 'n yer hugo.toml:\nrelativeURLs = trueTh' theme will append an additional index.html t' all plank bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer hugo.toml\n[params] disableExplicitIndexURLs = true Avast If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated JSON t' SEARCH as seen below.\nActivate search If not already present, add th' follow'n lines 'n yer hugo.toml file.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\"]This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' SEARCH outputformat was named JSON 'n previous releases but was implemented differently. Although JSON still works, it be now deprecated.\nActivate dedicated search plank Ye can add a dedicated search plank fer yer plank by add'n th' SEARCHPAGE outputformat t' yer home plank by add'n th' follow'n lines 'n yer hugo.toml file. This will cause Cap'n Hugo t' generate a new file http://example.com/mysite/search.html.\n[outputs] home = [\"HTML\", \"RSS\", \"SEARCH\", \"SEARCHPAGE\"]Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n ENTER inside o' th' menu’s search box .\nAvast T' have Cap'n Hugo create th' dedicated search plank successfully, ye must not generate th' URL http://example.com/mysite/search.html from yer own rrrambl'n. This can happen if ye set uglyURLs=true 'n yer hugo.toml an' defin'n a Marrrkdown file content/search.md.\nT' make sure, there be no duplicate rrrambl'n fer any given URL o' yer project, run hugo --printPathWarn'ns.\nActivate print support Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' PRINT output format t' yer home, section an' plank 'n yer hugo.toml as seen below:\n[outputs] home = [\"HTML\", \"RSS\", \"PRINT\", \"SEARCH\"] section = [\"HTML\", \"RSS\", \"PRINT\"] plank = [\"HTML\", \"RSS\", \"PRINT\"]This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.\nAvast Th' result'n URL will not be configured ugly 'n terms o' Hugo’s URL handl'n even if you’ve set uglyURLs=true 'n yer hugo.toml. This be due t' th' fact that fer one mime type only one suffix can be configured.\nNevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine outputFormats.PRINT 'n yer own hugo.toml t' yer lik'n.\nHome Button Configurat'n If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure th' landingPageName fer th' defined languages:\n[languages] [languages.en] ... [languages.en.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [languages.pir] ... [languages.pir.params] landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ...If this opt'n be not configured fer a specific language, they will get their default values:\nlandingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\"Th' home button be go'n t' look like this:\nSocial Media Meta Tags Ye can add social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. These be configured as mentioned 'n th' Cap'n Hugo docs.\nChange th' Menu Width Th' menu width adjusts automatically fer different screen sizes.\nName Screen Width Menu Width S \u003c 48rem 0 M 48rem - 60rem 14.375rem L \u003e= 60rem 18.75rem Th' values fer th' screen width breakpoints aren’t configur'ble.\nIf ye want t' adjust th' menu width ye can define th' follow'n CSS variables 'n yer custom-header.html. Avast that --MENU-WIDTH-S doesn’t exist as th' menu be always hidden fer small screen sizes.\n:root { --MENU-WIDTH-M: 14.375rem; --MENU-WIDTH-L: 18.75rem; }Own Shorrrtcodes wit' JavaScript Dependencies Certain shorrrtcodes make use o' additional JavaScript files. Th' theme only loads these dependencies if th' shortcode be used. T' do so correctly th' theme adds management code 'n various files.\nYe can ye use this mechanism 'n yer own shorrrtcodes. Say ye want t' add a shortcode myshortcode that also requires th' jquery JavaScript library.\nWrite th' shortcode file layouts/shortcodes/myshortcode.html an' add th' follow'n line\n{{- .Store.Set \"hasMyShortcode\" true }} Add th' follow'n snippet t' yer hugo.toml\n[params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = \"MyShortcode\" locat'n = \"footer\" Add th' dependency loader file layouts/partials/dependencies/myshortcode.html. Th' loader file will be appended t' yer header or footer, dependend on th' locat'n sett'n 'n yer hugo.toml.\n\u003cscript src=\"https://www.unpkg.com/jquery/dist/jquery.js\"\u003e\u003c/script\u003e Character cas'n be relevant!\nth' name sett'n 'n yer hugo.toml must match th' key (that needs t' be prefixed wit' a has) ye used fer th' store 'n yer layouts/shortcodes/myshortcode.html. th' key on params.relearn.dependencies 'n yer hugo.toml must match th' base file name o' yer loader file. See th' math, mermaid an' openapi shorrrtcodes fer examples.\nOutput Formats Certain parts o' th' theme can be changed fer support o' yer own output formats. Eg. if ye define a new output format PLAINTEXT 'n yer hugo.toml, ye can add a file layouts/partials/header.plaintext.html t' change th' way, th' plank header should look like fer that output format.\nReact t' Variant Switches 'n JavaScript Once a color variant be fully boarded, either initially or by switch'n th' color variant manually wit' th' variant selector, th' custom event themeVariantLoaded on th' document will be dispatched. Ye can add an event listener an' react t' changes.\ndocument.addEventListener( 'themeVariantLoaded', funct'n( e ){ console.log( e.detail.variant ); // `relearn-light` });Partials Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\nheader.html: th' header o' th' plank. See output-formats footer.html: th' footer o' th' plank. See output-formats body.html: th' body o' th' plank. Th' body may contain o' one or many articles. See output-formats article.html: th' output fer a single article, can contain elements around yer rrrambl'n. See output-formats menu.html: left menu. Not meant t' be overwritten search.html: search box. Not meant t' be overwritten custom-header.html: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file. custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’t forget t' include javascript HTML tag directive 'n yer file. favicon.html: th' favicon heading-pre.html: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPre sett'n into account. heading-post.html: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s headingPost sett'n into account. logo.html: th' logo, on top left hand corner meta.html: HTML meta tags, if ye want t' change default behavior menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPre sett'n into account. menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' page’s menuPost sett'n into account. menu-footer.html: footer o' th' the left menu toc.html: t'ble o' contents rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye want t' display page’s meta data above or below th' rrrambl'n. content-header.html: header above th' title, has a default implementat'n but ye can overwrite it if ye don’t like it. content-footer.html: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it. ", "description": "", "tags": null, "title": "Customizat'n", @@ -183,7 +183,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflect how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s static/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer config.toml t' yer chosen file name.\nEg. if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nDownload variant Reset variant\nGraph Download variant Reset variant\n", + "content": " This interactive tool may help ye t' generate yer own color variant stylesheet.\nShow usage instruct'ns T' get started, first select a color variant from th' variant selector 'n th' lower left sidebar that fits ye best as a start'n point.\nTh' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.\nTh' arrowed lines reflect how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.\nT' better understand this select th' neon variant an' modify th' different head'n colors. There, colors fer th' head'n h2, h3 an' h4 be explicitly set. h5 be not set an' inherits its value from h4. h6 be also not set an' inherits its value from h5.\nOnce you’ve changed a color, th' variant selector will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can browse t' other planks an' even close th' browser without los'n yer changes.\nOnce ye be satisfied, ye can download th' new variants file an' copy it into yer site’s static/css directory. Afterwards ye have t' adjust th' themeVariant parameter 'n yer hugo.toml t' yer chosen file name.\nEg. if yer new variants file be named theme-my-custom-variant.css, ye have t' set themeVariant='my-custom-variant' t' use it.\nDownload variant Reset variant\nGraph Download variant Reset variant\n", "description": "", "tags": null, "title": "Stylesheet generrrat'r", @@ -253,7 +253,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo\nAy'con Empty {{% button href=\"https://gohugo.io/\" ay'con=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}{{% /button %}} T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" iconposit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Cap'n Hugo 'n same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo 'n new Window/Frame (default){{% /button %}}Get Cap'n Hugo 'n same Window/Frame Get Cap'n Hugo 'n new Window/Frame (default)\nOther Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" %}}Get **Cap'n Hugo**{{% /button %}} Get Cap'n Hugo Severity Style wit' All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse Button t' Internal Plank {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button wit' JavaScript Act'n If yer JavaScript act'n does not change th' focus afterwards, make sure t' call this.blur() 'n th' end t' unselect th' button.\n{{% button style=\"primary\" ay'con=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element T' use native HTML elements 'n yer Marrrkdown, add this 'n yer config.toml\n[marrrkup.goldmark.renderer] unsafe = true\u003cform act'n=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", + "content": " Th' button shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.\nGet Cap'n Hugo Get Cap'n Hugo\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode partial {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" ay'con=\"dragon\" %}}Get Cap'n Hugo{{% /button %}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"content\" \"Get Hugo\" )}} {{ partial \"shortcodes/button.html\" (dict \"page\" . \"href\" \"https://gohugo.io/\" \"style\" \"warning\" \"icon\" \"dragon\" \"content\" \"Get Hugo\" )}} Once th' button be clicked, it opens another browser tab fer th' given URL.\nParameter Name Default Notes href \u003cempty\u003e Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.\n- if start'n wit' javascript: all follow'n text will be executed 'n yer browser\n- every other str'n will be interpreted as URL style transparent Th' style scheme used fer th' button.\n- by severity: info, note, tip, warning\n- by brand color: primary, secondary, accent\n- by color: blue, green, grey, orange, red\n- by special color: default, transparent, code color see notes Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n color fer th' severity\n- fer all other styles: th' correspond'n color ay'con see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.\n- fer severity styles: a nice match'n ay'con fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no ay'con fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) iconposit'n left Places th' ay'con t' th' left or right o' th' title. target see notes Th' destinat'n frame/window if href be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':\n- th' sett'n o' externalLinkTarget or _blank if not set, fer any address start'n wit' http:// or https://\n- no specific value fer all other links type see notes Th' button type if href be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' button \u003ccontent\u003e see notes Arbitrary text fer th' button title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.\n- fer severity styles: th' match'n title fer th' severity\n- fer all other styles: \u003cempty\u003e\nIf ye want no title fer a severity style, ye have t' set this parameter t' \" \" (a non empty str'n filled wit' spaces) Examples Style By Severity {{% button href=\"https://gohugo.io/\" style=\"info\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"note\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Brand Colors {{% button href=\"https://gohugo.io/\" style=\"primary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"secondary\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"accent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Color {{% button href=\"https://gohugo.io/\" style=\"blue\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"green\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"grey\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"orange\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"red\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo Get Cap'n Hugo\nBy Special Color {{% button href=\"https://gohugo.io/\" style=\"default\" %}}Get Cap'n Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" style=\"transparent\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Get Cap'n Hugo\nAy'con Empty {{% button href=\"https://gohugo.io/\" ay'con=\" \" %}}{{% /button %}} Only {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}{{% /button %}} T' th' Left {{% button href=\"https://gohugo.io/\" ay'con=\"download\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo T' th' Right {{% button href=\"https://gohugo.io/\" ay'con=\"download\" iconposit'n=\"right\" %}}Get Cap'n Hugo{{% /button %}}Get Cap'n Hugo Override fer Severity {{% button href=\"https://gohugo.io/\" ay'con=\"dragon\" style=\"warning\" %}}Get Cap'n Hugo{{% /button %}} Get Cap'n Hugo Target {{% button href=\"https://gohugo.io/\" target=\"_self\" %}}Get Cap'n Hugo 'n same window{{% /button %}} {{% button href=\"https://gohugo.io/\" %}}Get Cap'n Hugo 'n new Window/Frame (default){{% /button %}}Get Cap'n Hugo 'n same Window/Frame Get Cap'n Hugo 'n new Window/Frame (default)\nOther Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title {{% button href=\"https://gohugo.io/\" color=\"fuchsia\" ay'con=\"fab fa-hackerrank\" %}}Get **Cap'n Hugo**{{% /button %}} Get Cap'n Hugo Severity Style wit' All Defaults {{% button href=\"https://gohugo.io/\" style=\"tip\" %}}{{% /button %}} Smarrrt Arrrse Button t' Internal Plank {{% button href=\"/index.html\" %}}Home{{% /button %}}Home Button wit' JavaScript Act'n If yer JavaScript act'n does not change th' focus afterwards, make sure t' call this.blur() 'n th' end t' unselect th' button.\n{{% button style=\"primary\" ay'con=\"bullhorn\" href=\"javascript:alert('Hello world!');this.blur();\" %}}Shout it out{{% /button %}} Shout it out Button within a form Element T' use native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml\n[marrrkup.goldmark.renderer] unsafe = true\u003cform act'n=\"../../search.html\" method=\"get\"\u003e \u003cinput name=\"search-by-detail\" class=\"search-by\" type=\"search\"\u003e {{% button type=\"submit\" style=\"secondary\" icon=\"search\" %}}Search{{% /button %}} \u003c/form\u003e Search ", "description": "", "tags": null, "title": "Button", @@ -365,7 +365,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' highlight shortcode renders yer code wit' a rules highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode be fully compat'ble wit' Hugo’s highlight shortcode but offers some extensions.\nIt be called interchangeably 'n th' same way as Hugo’s own shortcode provid'n positional parameter or by simply us'n codefences.\nYe be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s highlight funct'n rules if ye call this shortcode as a partial us'n compatiblity rules.\nWhile th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Posit'n Default Notes type 1 \u003cempty\u003e Th' language o' th' code t' highlight. Choose from one o' th' supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title fer code. This displays th' code like a single tab if hl_inline=false (which be Hugos default). wrap see notes Extension. When true th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.\nTh' default value can be set 'n yer config.toml an' overwritten via frontmatter. See below. opt'ns 2 \u003cempty\u003e An optional, comma-separated list o' zero or more Cap'n Hugo supported opt'ns as well as extension parameter from this t'ble. \u003coption\u003e \u003cempty\u003e Any o' Hugo’s supported opt'ns. \u003ccontent\u003e \u003cempty\u003e Yer code t' highlight. Configurat'n Default values fer Hugo’s supported opt'ns can be set via goldmark sett'ns 'n yer config.toml\nDefault values fer extension opt'ns can be set via params sett'ns 'n yer config.toml or be overwritten by frontmatter fer each individual plank.\nGlobal Configurat'n File Ye can configure th' color style used fer code blocks 'n yer color variants stylesheet file.\nRecommended Sett'ns [marrrkup] [marrrkup.highlight] # line numbers 'n a t'ble layout will shift if code be wrapp'n, so better # use inline; besides that visually both layouts have th' same look an' behavior lineNumbersInT'ble = false # th' shipped variants come wit' their own modified chroma rules highlightn'n # stylesheets which be linked 'n yer generated HTML planks; ye can use Cap'n Hugo t' generate # own stylesheets t' yer lik'n an' use them 'n yer variant; # if ye want t' use Hugo's internal styles instead o' th' shipped stylesheets: # - remove `noClasses` or set `noClasses = true` # - set `style` t' a predefined style name # note: wit' us'n th' internal styles, th' `--CODE-theme` sett'n 'n yer variant # stylesheet will be ignored an' th' internal style be used fer all variants an' # even print noClasses = false # style = \"tango\"Optional Sett'ns [params] highlightWrap = truePage’s Frontmatter +++ highlightWrap = true +++Examples Line Numbers wit' Start'n Offset As mentioned above, line numbers 'n a t'ble layout will shift if code be wrapp'n, so better use inline. T' make th'ns easier fer ye, set lineNumbersInT'ble = false 'n yer config.toml an' add lineNos = true when call'n th' shortcode instead o' th' specific values t'ble or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence wit' Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") Wit' Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff ", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' highlight shortcode renders yer code wit' a rules highlighter.\n​ python 1print(\"Hello World!\") Usage This shortcode be fully compat'ble wit' Hugo’s highlight shortcode but offers some extensions.\nIt be called interchangeably 'n th' same way as Hugo’s own shortcode provid'n positional parameter or by simply us'n codefences.\nYe be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s highlight funct'n rules if ye call this shortcode as a partial us'n compatiblity rules.\nWhile th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\n​ codefence shortcode shortcode (positional) partial partial (compat) ```py { lineNos=\"true\" wrap=\"true\" title=\"python\" } print(\"Hello World!\") ``` {{\u003c highlight lineNos=\"true\" type=\"py\" wrap=\"true\" title=\"python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{\u003c highlight py \"lineNos=true,wrap=true,title=python\" \u003e}} print(\"Hello World!\") {{\u003c /highlight \u003e}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"lineNos\" \"true\" \"type\" \"py\" \"wrap\" \"true\" \"title\" \"python\" )}} {{ partial \"shortcodes/highlight.html\" (dict \"page\" . \"content\" \"print(\\\"Hello World!\\\")\" \"options\" \"lineNos=true,wrap=true,title=python\" \"type\" \"py\" )}} Parameter Name Posit'n Default Notes type 1 \u003cempty\u003e Th' language o' th' code t' highlight. Choose from one o' th' supported languages. Case-insensitive. title \u003cempty\u003e Extension. Arbitrary title fer code. This displays th' code like a single tab if hl_inline=false (which be Hugos default). wrap see notes Extension. When true th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.\nTh' default value can be set 'n yer hugo.toml an' overwritten via frontmatter. See below. opt'ns 2 \u003cempty\u003e An optional, comma-separated list o' zero or more Cap'n Hugo supported opt'ns as well as extension parameter from this t'ble. \u003coption\u003e \u003cempty\u003e Any o' Hugo’s supported opt'ns. \u003ccontent\u003e \u003cempty\u003e Yer code t' highlight. Configurat'n Default values fer Hugo’s supported opt'ns can be set via goldmark sett'ns 'n yer hugo.toml\nDefault values fer extension opt'ns can be set via params sett'ns 'n yer hugo.toml or be overwritten by frontmatter fer each individual plank.\nGlobal Configurat'n File Ye can configure th' color style used fer code blocks 'n yer color variants stylesheet file.\nRecommended Sett'ns [marrrkup] [marrrkup.highlight] # line numbers 'n a t'ble layout will shift if code be wrapp'n, so better # use inline; besides that visually both layouts have th' same look an' behavior lineNumbersInT'ble = false # th' shipped variants come wit' their own modified chroma rules highlightn'n # stylesheets which be linked 'n yer generated HTML planks; ye can use Cap'n Hugo t' generate # own stylesheets t' yer lik'n an' use them 'n yer variant; # if ye want t' use Hugo's internal styles instead o' th' shipped stylesheets: # - remove `noClasses` or set `noClasses = true` # - set `style` t' a predefined style name # note: wit' us'n th' internal styles, th' `--CODE-theme` sett'n 'n yer variant # stylesheet will be ignored an' th' internal style be used fer all variants an' # even print noClasses = false # style = \"tango\"Optional Sett'ns [params] highlightWrap = truePage’s Frontmatter +++ highlightWrap = true +++Examples Line Numbers wit' Start'n Offset As mentioned above, line numbers 'n a t'ble layout will shift if code be wrapp'n, so better use inline. T' make th'ns easier fer ye, set lineNumbersInT'ble = false 'n yer hugo.toml an' add lineNos = true when call'n th' shortcode instead o' th' specific values t'ble or inline.\n{{\u003c highlight lineNos=\"true\" lineNoStart=\"666\" type=\"py\" \u003e}} # th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits print(\"Hello\") print(\" \") print(\"World\") print(\"!\") {{\u003c /highlight \u003e}}666# th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits 667print(\"Hello\") 668print(\" \") 669print(\"World\") 670print(\"!\") Codefence wit' Title ```py { title=\"python\" } # a bit shorter print(\"Hello World!\") ``` ​ python # a bit shorter print(\"Hello World!\") Wit' Wrap {{\u003c highlight type=\"py\" wrap=\"true\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff Without Wrap {{\u003c highlight type=\"py\" wrap=\"false\" hl_lines=\"2\" \u003e}} # Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff {{\u003c /highlight \u003e}}# Quicksort Python One-liner lambda L: [] if L==[] else qsort([x fer x 'n L[1:] if x\u003c L[0]]) + L[0:1] + qsort([x fer x 'n L[1:] if x\u003e=L[0]]) # Some more stuff ", "description": "Render code with a syntax highlighter", "tags": null, "title": "Highlight", @@ -381,7 +381,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.\nCustomis'n Ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. Paste th' \u003ci\u003e HTML into marrrkup, an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nT' use these native HTML elements 'n yer Marrrkdown, add this 'n yer config.toml:\n[marrrkup.goldmark.renderer] unsafe = true ", + "content": " Th' ay'con shortcode displays ay'cons us'n th' Font Awesome library.\nUsage While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% ay'con ay'con=\"exclamation-triangle\" %}} {{% ay'con ay'con=\"angle-double-up\" %}} {{% ay'con ay'con=\"skull-crossbones\" %}} {{% ay'con exclamat'n-triangle %}} {{% ay'con angle-do'ble-up %}} {{% ay'con skull-crossbones %}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"exclamation-triangle\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"angle-double-up\" )}} {{ partial \"shortcodes/icon.html\" (dict \"page\" . \"icon\" \"skull-crossbones\" )}} Parameter Name Posit'n Default Notes ay'con 1 \u003cempty\u003e Font Awesome ay'con name t' be displayed. It will be displayed 'n th' text color o' its accord'n context. Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.\nOnce on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.\nCustomis'n Ay'cons Font Awesome provides many ways t' modify th' ay'con\nChange color (by default th' ay'con will inherit th' parent color) Increase or decrease size Rotate Combine wit' other ay'cons Check th' full documentat'n on web fonts wit' CSS fer more.\nExamples Standard Usage Built wit' {{% ay'con heart %}} by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nAdvanced HTML Usage While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. Paste th' \u003ci\u003e HTML into marrrkup, an' Font Awesome will board th' relevant ay'con.\nBuilt wit' \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearrrn an' Cap'n HugoBuilt wit' by Relearrrn an' Cap'n Hugo\nT' use these native HTML elements 'n yer Marrrkdown, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true ", "description": "", "tags": null, "title": "Icon", @@ -405,7 +405,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' math shortcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n​ codefence shortcode partial ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} Parameter Name Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formuale. Configurat'n MathJax be configured wit' default sett'ns. Ye can cust'mize MathJax’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into MathJax’s configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nGlobal Configurat'n File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\"Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++Examples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Right Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If ye delimit yer formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence Ye can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' math shortcode generates beautiful formatted math an' chemical formulae us'n th' MathJax library.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n​ codefence shortcode partial ```math { align=\"center\" } $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` {{\u003c math align=\"center\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}} {{ partial \"shortcodes/math.html\" (dict \"page\" . \"content\" \"$$left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\" \"align\" \"center\" )}} Parameter Name Default Notes align center Allowed values be left, center or right. \u003ccontent\u003e \u003cempty\u003e Yer formuale. Configurat'n MathJax be configured wit' default sett'ns. Ye can cust'mize MathJax’s default sett'ns fer all o' yer files thru a JSON object 'n yer hugo.toml or override these sett'ns per plank thru yer planks frontmatter.\nTh' JSON object o' yer hugo.toml / frontmatter be forwarded into MathJax’s configurat'n object.\nSee MathJax documentat'n fer all allowed sett'ns.\nGlobal Configurat'n File [params] mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\"Page’s Frontmatter +++ mathJaxInitialize = \"{ \\\"chtml\\\": { \\\"displayAlign\\\": \\\"left\\\" } }\" +++Examples Inline Math Inline math be generated if ye use a single `$` as a delimiter around yer formulae: {{\u003c math \u003e}}$\\sqrt{3}${{\u003c /math \u003e}}Inline math be generated if ye use a single $ as a delimiter around yer formulae: $\\sqrt{3}$\nBlocklevel Math wit' Right Alignment If ye delimit yer formulae by two consecutive `$$` it generates a new block. {{\u003c math align=\"right\" \u003e}} $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ {{\u003c /math \u003e}}If ye delimit yer formulae by two consecutive $$ it generates a new block.\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ Codefence Ye can also use codefences.\n```math $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$ ``` $$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$Chemical Formulae {{\u003c math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ {{\u003c /math \u003e}} $$\\ce{Hg^2+ -\u003e[I-] HgI2 -\u003e[I-] [Hg^{II}I4]^2-}$$ ", "description": "", "tags": null, "title": "Math", @@ -413,7 +413,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' mermaid shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nParameter Name Default Notes align center Allowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' th' ship or th' planks frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer config.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer config.toml / frontmatter be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n config.toml, frontmatter or diagram directives.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = truePage’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true +++Examples Flowchart wit' YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram wit' Configurat'n Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! Class Diagram wit' Codefence Rules ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned t' th' Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model wit' Non-Default Merrrmaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::ay'con(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003ean' features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid Timeline {{\u003c mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ", + "content": " Arrr! Pirrrates Fello' pirrrates, grog made us dizzy! Be awarrre some stuff may look weird in this trrranslat'n. Like Merrrmaids, do'n math or chemistrrry and stuff.\nTh' mermaid shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' Merrrmaid library.\ngraph LR; If --\u003e Then Then --\u003e Else Avast This only works 'n modern browsers.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.\nYe be free t' also call this shortcode from yer own partials.\n​ codefence shortcode partial ```mermaid { align=\"center\" zoom=\"true\" } graph LR; If --\u003e Then Then --\u003e Else ``` {{\u003c mermaid align=\"center\" zoom=\"true\" \u003e}} graph LR; If --\u003e Then Then --\u003e Else {{\u003c /mermaid \u003e}} {{ partial \"shortcodes/mermaid.html\" (dict \"page\" . \"content\" \"graph LR;\\nIf --\u003e Then\\nThen --\u003e Else\" \"align\" \"center\" \"zoom\" \"true\" )}} Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.\nParameter Name Default Notes align center Allowed values be left, center or right. zoom see notes Whether th' graph be pan- an' zoom'ble.\nIf not set th' value be determined by th' mermaidZoom sett'n o' th' ship or th' planks frontmatter or false if not set at all.\n- false: no pan or zoom\n- true: pan an' zoom active \u003ccontent\u003e \u003cempty\u003e Yer Merrrmaid graph. Configurat'n Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer hugo.toml, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru diagram directives.\nTh' JSON object o' yer hugo.toml / frontmatter be forwarded into Mermaid’s mermaid.initialize() funct'n.\nSee Merrrmaid documentat'n fer all allowed sett'ns.\nTh' theme sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n hugo.toml, frontmatter or diagram directives.\nGlobal Configurat'n File [params] mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = truePage’s Frontmatter +++ mermaidInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" mermaidZoom = true +++Examples Flowchart wit' YAML-Title {{\u003c mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] {{\u003c /mermaid \u003e}} --- title: Example Diagram --- graph LR; A[Hard edge] --\u003e|Link text| B(Round edge) B --\u003e C{\u003cstrong\u003eDecision\u003c/strong\u003e} C --\u003e|One| D[Result one] C --\u003e|Two| E[Result two] Sequence Diagram wit' Configurat'n Directive {{\u003c mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Avast right o' John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! {{\u003c /mermaid \u003e}} %%{init:{\"fontFamily\":\"monospace\", \"sequence\":{\"showSequenceNumbers\":true}}}%% sequenceDiagram Alice-\u003e\u003eJohn: Hello John, how be ye? loop Healthcheck John-\u003e\u003eJohn: Fight against hypochondria end Note right of John: Rational thoughts! John--\u003e\u003eAlice: Great! John-\u003e\u003eBob: How about ye? Bob--\u003e\u003eJohn: Jolly bloody! Class Diagram wit' Codefence Rules ```mermaid classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } ``` classDiagram Animal \u003c|-- Duck Animal \u003c|-- Fish Animal \u003c|-- Zebra Animal : +int age Animal : +Str'n gender Animal: +isMammal() Animal: +mate() class Duck{ +Str'n beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }State Diagram Aligned t' th' Right {{\u003c mermaid align=\"right\" \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open {{\u003c /mermaid \u003e}} stateDiagram-v2 open: Open Door closed: Closed Door locked: Locked Door open --\u003e closed: Close closed --\u003e locked: Lock locked --\u003e closed: Unlock closed --\u003e open: Open Entity Relationship Model wit' Non-Default Merrrmaid Theme {{\u003c mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" {{\u003c /mermaid \u003e}} %%{init:{\"theme\":\"forest\"}}%% erDiagram CUSTOMER }|..|{ DELIVERY-ADDRESS : has CUSTOMER ||--o{ ORDER : places CUSTOMER ||--o{ INVOICE : \"li'ble for\" DELIVERY-ADDRESS ||--o{ ORDER : receives INVOICE ||--|{ ORDER : covers ORDER ||--|{ ORDER-ITEM : includes PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT ||--o{ ORDER-ITEM : \"ordered in\" User Journey {{\u003c mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me {{\u003c /mermaid \u003e}} journey title My work'n day section Go t' work Make tea: 5: Me Go upstairs: 3: Me Do work: 1: Me, Cat section Go home Go downstairs: 5: Me Sit down: 3: Me GANTT Chart {{\u003c mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d {{\u003c /mermaid \u003e}} gantt dateFormat YYYY-MM-DD title Add'n GANTT diagram functionality t' Merrrmaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task 'n th' critical line :crit, done, 2014-01-06,24h Implement parser an' jison :crit, done, after des1, 2d Create tests fer parser :crit, active, 3d Future task 'n critical line :crit, 5d Create tests fer renderer :2d Add t' Merrrmaid :1d Pie Chart without Zoom {{\u003c mermaid zoom=\"false\" \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 {{\u003c /mermaid \u003e}} pie title Pets adopted by volunteers \"Dogs\" : 386 \"Cats\" : 85 \"Rats\" : 15 Quadrant Chart {{\u003c mermaid \u003e}} pie title Pets adopted by volunteers title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] {{\u003c /mermaid \u003e}} quadrantChart title Reach an' engagement o' campaigns x-axis Low Reach --\u003e High Reach y-axis Low Engagement --\u003e High Engagement quadrant-1 We should expand quadrant-2 Need t' promote quadrant-3 Re-evaluate quadrant-4 May be improved Campaign A: [0.3, 0.6] Campaign B: [0.45, 0.23] Campaign C: [0.57, 0.69] Campaign D: [0.78, 0.34] Campaign E: [0.40, 0.34] Campaign F: [0.35, 0.78] Requirement Diagram {{\u003c mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req {{\u003c /mermaid \u003e}} requirementDiagram requirement test_req { id: 1 text: th' test text. risk: high verifymethod: test } element test_entity { type: simulat'n } test_entity - satisfies -\u003e test_req Git Graph {{\u003c mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit {{\u003c /mermaid \u003e}} gitGraph commit commit branch develop checkout develop commit commit checkout main merge develop commit commit C4 Diagrams {{\u003c mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") {{\u003c /mermaid \u003e}} C4Context title System Context diagram fer Internet Bank'n System Enterprise_Boundary(b0, \"BankBoundary0\") { Person(customerA, \"Bank'n Customer A\", \"A customer o' th' bank, wit' personal bank accounts.\") Person(customerB, \"Bank'n Customer B\") Person_Ext(customerC, \"Bank'n Customer C\", \"desc\") Person(customerD, \"Bank'n Customer D\", \"A customer o' th' bank, \u003cbr/\u003e wit' personal bank accounts.\") System(SystemAA, \"Internet Bank'n System\", \"Allows customers t' view informat'n about their bank accounts, an' make payments.\") Enterprise_Boundary(b1, \"BankBoundary\") { SystemDb_Ext(SystemE, \"Mainframe Bank'n System\", \"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.\") System_Boundary(b2, \"BankBoundary2\") { System(SystemA, \"Bank'n System A\") System(SystemB, \"Bank'n System B\", \"A system o' th' bank, wit' personal bank accounts. next line.\") } System_Ext(SystemC, \"E-mail system\", \"The internal Microsoft Exchange e-mail system.\") SystemDb(SystemD, \"Bank'n System D Database\", \"A system o' th' bank, wit' personal bank accounts.\") Boundary(b3, \"BankBoundary3\", \"boundary\") { SystemQueue(SystemF, \"Bank'n System F Queue\", \"A system o' th' bank.\") SystemQueue_Ext(SystemG, \"Bank'n System G Queue\", \"A system o' th' bank, wit' personal bank accounts.\") } } } BiRel(customerA, SystemAA, \"Uses\") BiRel(SystemAA, SystemE, \"Uses\") Rel(SystemAA, SystemC, \"Sends e-mails\", \"SMTP\") Rel(SystemC, customerA, \"Sends e-mails to\") UpdateElementStyle(customerA, $fontColor=\"red\", $bgColor=\"grey\", $borderColor=\"red\") UpdateRelStyle(customerA, SystemAA, $textColor=\"blue\", $lineColor=\"blue\", $offsetX=\"5\") UpdateRelStyle(SystemAA, SystemE, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-10\") UpdateRelStyle(SystemAA, SystemC, $textColor=\"blue\", $lineColor=\"blue\", $offsetY=\"-40\", $offsetX=\"-50\") UpdateRelStyle(SystemC, customerA, $textColor=\"red\", $lineColor=\"red\", $offsetX=\"-50\", $offsetY=\"20\") UpdateLayoutConfig($c4ShapeInRow=\"3\", $c4BoundaryInRow=\"1\") Mindmaps {{\u003c mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::ay'con(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003ean' features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid {{\u003c /mermaid \u003e}} mindmap root((mindmap)) Origins Long history ::icon(fa fa-book) Popularisat'n British popular psychology author Tony Buzan Research On effectiveness\u003cbr/\u003eand features On Automatic creat'n Uses Creative techniques Strategic plann'n Argument mapp'n Tools Pen an' paper Merrrmaid Timeline {{\u003c mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter {{\u003c /mermaid \u003e}} timeline title History o' Social Media Platform 2002 : LinkedIn 2004 : Facebook : Google 2005 : Youtube 2006 : Twitter Sankey {{\u003c mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 {{\u003c /mermaid \u003e}} sankey-beta %% source,target,value Electricity grid,Over generat'n / exports,104.453 Electricity grid,Heat'n an' cool'n - homes,113.726 Electricity grid,H2 conversion,27.14 XYChart {{\u003c mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] {{\u003c /mermaid \u003e}} xychart-beta title \"Sales Revenue\" x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec] y-axis \"Revenue (in $)\" 4000 --\u003e 11000 bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000] ", "description": "", "tags": null, "title": "Merrrmaid", @@ -552,7 +552,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Shorrrtcodes", - "content": " Th' siteparam shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from config.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\nNested parameter wit' Marrrkdown an' HTML formatt'n T' use formatted parameter, add this 'n yer config.toml:\n[marrrkup.goldmark.renderer] unsafe = true ​ config.toml [params] [params.siteparam.test] text = \"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting\" Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n\n", + "content": " Th' siteparam shortcode prints values o' ship params.\nUsage While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.\n​ shortcode shortcode (positional) partial {{% siteparam name=\"editURL\" %}} {{% siteparam \"editURL\" %}} {{ partial \"shortcodes/siteparam.html\" (dict \"page\" . \"name\" \"editURL\" )}} Parameter Name Posit'n Default Notes name 1 \u003cempty\u003e Th' name o' th' ship param t' be displayed. Examples editURL from hugo.toml `editURL` value: {{% siteparam name=\"editURL\" %}}editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\nNested parameter wit' Marrrkdown an' HTML formatt'n T' use formatted parameter, add this 'n yer hugo.toml:\n[marrrkup.goldmark.renderer] unsafe = true ​ hugo.toml [params] [params.siteparam.test] text = \"A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting\" Formatted parameter: {{% siteparam name=\"siteparam.test.text\" %}}Formatted parameter: A nested opt'n \u003cb\u003ewith\u003c/b\u003e formatt'n\n", "description": "", "tags": null, "title": "SiteParam", @@ -576,7 +576,7 @@ var relearn_search_index = [ }, { "breadcrumb": "", - "content": " Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. Aswell ye can define optional title an' singulartitle that will override th' values from yer config.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.\n", + "content": " Ye can define optional rrrambl'n 'n yer overridden taxonomy plank. Aswell ye can define optional title an' singulartitle that will override th' values from yer hugo.toml or o' yer translat'n files.\nJust an example head'n Th' TOC will contain this head'n an' th' index head'ns below.\n", "description": "", "tags": null, "title": "Tag-a-taggs", diff --git a/pir/more/credits/index.html b/pir/more/credits/index.html index 02931c6d8c..1f7415739e 100644 --- a/pir/more/credits/index.html +++ b/pir/more/credits/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/more/credits/index.print.html b/pir/more/credits/index.print.html index 66bbfe5702..c7a47fa64e 100644 --- a/pir/more/credits/index.print.html +++ b/pir/more/credits/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/search.html b/pir/search.html index b41222f3dd..1b9bf039c9 100644 --- a/pir/search.html +++ b/pir/search.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index 559fd54dde..45766becf4 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -26,21 +26,21 @@ Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Ca - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.print.html b/pir/shortcodes/attachments/index.print.html index 41c96296f1..21600ca66f 100644 --- a/pir/shortcodes/attachments/index.print.html +++ b/pir/shortcodes/attachments/index.print.html @@ -26,22 +26,22 @@ Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Ca - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/badge/index.html b/pir/shortcodes/badge/index.html index be1b21954a..34455d2051 100644 --- a/pir/shortcodes/badge/index.html +++ b/pir/shortcodes/badge/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/badge/index.print.html b/pir/shortcodes/badge/index.print.html index e563f61f80..b66a9cdc4e 100644 --- a/pir/shortcodes/badge/index.print.html +++ b/pir/shortcodes/badge/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index d797a2d67e..02b225b7d9 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/button/index.print.html b/pir/shortcodes/button/index.print.html index 2c30512392..5d43e8cde8 100644 --- a/pir/shortcodes/button/index.print.html +++ b/pir/shortcodes/button/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index a1e6ca0121..37fe54ae9c 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html index a85dcdf968..c23aad84bc 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 86218e8019..0ce16a4ba9 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html index e19c50cfa9..05aa58647a 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index fee9676f49..e18514ea65 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html index 413471d5e5..a92ee03387 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index 538e1836ec..15c1c49690 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html index 6cf2ae502d..c6cda49aeb 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index e234388b5e..ec17566754 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html index 1c445f0c54..80049a52f5 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index 88f95c8c60..6b04755a05 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html index 95e46705fe..07aca4e98e 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index d8609707aa..a15497243f 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html index 864439e988..8fc1c837ff 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/index.html index 921276b6dd..7f8e595e63 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/index.print.html index a30adda4c7..3622da6f00 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/index.html b/pir/shortcodes/children/children-1/index.html index 98db09d8c9..eff06cc65a 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/index.print.html b/pir/shortcodes/children/children-1/index.print.html index cd19ada86b..23d6875b4c 100644 --- a/pir/shortcodes/children/children-1/index.print.html +++ b/pir/shortcodes/children/children-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-2/index.html b/pir/shortcodes/children/children-2/index.html index e86872c7f4..7a237cbd5c 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-2/index.print.html b/pir/shortcodes/children/children-2/index.print.html index 5a23b89309..984e685048 100644 --- a/pir/shortcodes/children/children-2/index.print.html +++ b/pir/shortcodes/children/children-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 05721e68de..53aa7d9425 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/index.print.html b/pir/shortcodes/children/children-3/index.print.html index b2164ca0a9..0bdad72c5b 100644 --- a/pir/shortcodes/children/children-3/index.print.html +++ b/pir/shortcodes/children/children-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.html b/pir/shortcodes/children/children-3/test3/index.html index 8e7e88bccd..6c96a74ac7 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.print.html b/pir/shortcodes/children/children-3/test3/index.print.html index 617484afd8..4e73f5ae22 100644 --- a/pir/shortcodes/children/children-3/test3/index.print.html +++ b/pir/shortcodes/children/children-3/test3/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index a8a7402fa4..e0f74cf9fe 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-4/index.print.html b/pir/shortcodes/children/children-4/index.print.html index d34f7183d8..6eaa799116 100644 --- a/pir/shortcodes/children/children-4/index.print.html +++ b/pir/shortcodes/children/children-4/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index 17bb777b83..24aada4e58 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/index.print.html b/pir/shortcodes/children/index.print.html index 2796eeb1a5..14bf01fe33 100644 --- a/pir/shortcodes/children/index.print.html +++ b/pir/shortcodes/children/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index 2f670bdfea..66e8cd3052 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -27,21 +27,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/test/index.print.html b/pir/shortcodes/children/test/index.print.html index 897a7e02c0..e7685fbf9e 100644 --- a/pir/shortcodes/children/test/index.print.html +++ b/pir/shortcodes/children/test/index.print.html @@ -27,22 +27,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index 00a1ca5878..0d0d5d1301 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -40,21 +40,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/pir/shortcodes/expand/index.print.html b/pir/shortcodes/expand/index.print.html index d9230acba0..2228f8c114 100644 --- a/pir/shortcodes/expand/index.print.html +++ b/pir/shortcodes/expand/index.print.html @@ -40,22 +40,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/highlight/index.html b/pir/shortcodes/highlight/index.html index 8a6e3e9719..aaf8f3fad5 100644 --- a/pir/shortcodes/highlight/index.html +++ b/pir/shortcodes/highlight/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/highlight/index.print.html b/pir/shortcodes/highlight/index.print.html index b0a1749de7..9c498aabd8 100644 --- a/pir/shortcodes/highlight/index.print.html +++ b/pir/shortcodes/highlight/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/icon/index.html b/pir/shortcodes/icon/index.html index 8090cae819..d7ea7b2278 100644 --- a/pir/shortcodes/icon/index.html +++ b/pir/shortcodes/icon/index.html @@ -28,21 +28,21 @@ Usage While th' examples be us'n shorrrtcodes wit' positional parame - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/icon/index.print.html b/pir/shortcodes/icon/index.print.html index f83e429acb..eaa70ba887 100644 --- a/pir/shortcodes/icon/index.print.html +++ b/pir/shortcodes/icon/index.print.html @@ -28,22 +28,22 @@ Usage While th' examples be us'n shorrrtcodes wit' positional parame - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/include/index.html b/pir/shortcodes/include/index.html index bf5b6a65d9..a45f8fca91 100644 --- a/pir/shortcodes/include/index.html +++ b/pir/shortcodes/include/index.html @@ -28,21 +28,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/include/index.print.html b/pir/shortcodes/include/index.print.html index 037b2c26e2..5487ea7b15 100644 --- a/pir/shortcodes/include/index.print.html +++ b/pir/shortcodes/include/index.print.html @@ -28,22 +28,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/index.html b/pir/shortcodes/index.html index 6f885e1a16..595e3af4df 100644 --- a/pir/shortcodes/index.html +++ b/pir/shortcodes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/index.print.html b/pir/shortcodes/index.print.html index ef83530648..0f526d9064 100644 --- a/pir/shortcodes/index.print.html +++ b/pir/shortcodes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/pir/shortcodes/math/index.html b/pir/shortcodes/math/index.html index 8f7a3bbe87..8aa3fcf96f 100644 --- a/pir/shortcodes/math/index.html +++ b/pir/shortcodes/math/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter i - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + diff --git a/pir/shortcodes/math/index.print.html b/pir/shortcodes/math/index.print.html index 396e8a55b8..d7f8ef7a38 100644 --- a/pir/shortcodes/math/index.print.html +++ b/pir/shortcodes/math/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter i - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - + + diff --git a/pir/shortcodes/mermaid/index.html b/pir/shortcodes/mermaid/index.html index 14e04cc04e..fa5e0fc385 100644 --- a/pir/shortcodes/mermaid/index.html +++ b/pir/shortcodes/mermaid/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter i - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/shortcodes/mermaid/index.print.html b/pir/shortcodes/mermaid/index.print.html index 194052a5f3..b65fea88b9 100644 --- a/pir/shortcodes/mermaid/index.print.html +++ b/pir/shortcodes/mermaid/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter i - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/shortcodes/notice/index.html b/pir/shortcodes/notice/index.html index adcc8c821e..b4e9abba2c 100644 --- a/pir/shortcodes/notice/index.html +++ b/pir/shortcodes/notice/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/notice/index.print.html b/pir/shortcodes/notice/index.print.html index 989c5a9705..2ae4e29f97 100644 --- a/pir/shortcodes/notice/index.print.html +++ b/pir/shortcodes/notice/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/openapi/index.html b/pir/shortcodes/openapi/index.html index a9a6303ee5..51693a76ac 100644 --- a/pir/shortcodes/openapi/index.html +++ b/pir/shortcodes/openapi/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + - + diff --git a/pir/shortcodes/openapi/index.print.html b/pir/shortcodes/openapi/index.print.html index 758080fe4a..37777c8977 100644 --- a/pir/shortcodes/openapi/index.print.html +++ b/pir/shortcodes/openapi/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - + + - + diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index bd0ac38557..accf818597 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -28,21 +28,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/siteparam/index.print.html b/pir/shortcodes/siteparam/index.print.html index 527a699b16..09ff19c3da 100644 --- a/pir/shortcodes/siteparam/index.print.html +++ b/pir/shortcodes/siteparam/index.print.html @@ -28,22 +28,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/tab/index.html b/pir/shortcodes/tab/index.html index f3df267103..b9a41385b2 100644 --- a/pir/shortcodes/tab/index.html +++ b/pir/shortcodes/tab/index.html @@ -30,21 +30,21 @@ If ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/tab/index.print.html b/pir/shortcodes/tab/index.print.html index f05c22ce31..b2a5804245 100644 --- a/pir/shortcodes/tab/index.print.html +++ b/pir/shortcodes/tab/index.print.html @@ -30,22 +30,22 @@ If ye want multiple tabs grouped together ye can wrap yer tabs into th' tabs - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/tabs/index.html b/pir/shortcodes/tabs/index.html index 84a6687ca2..e836a70b0f 100644 --- a/pir/shortcodes/tabs/index.html +++ b/pir/shortcodes/tabs/index.html @@ -30,21 +30,21 @@ hello. py sh c print("Hello World!") echo "Hello World!" printf( - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/tabs/index.print.html b/pir/shortcodes/tabs/index.print.html index 34241b9079..44a8fede28 100644 --- a/pir/shortcodes/tabs/index.print.html +++ b/pir/shortcodes/tabs/index.print.html @@ -30,22 +30,22 @@ hello. py sh c print("Hello World!") echo "Hello World!" printf( - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/showcase/index.html b/pir/showcase/index.html index 8038205152..9b697b51a5 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/showcase/index.print.html b/pir/showcase/index.print.html index ecf7b7c27d..04f34de888 100644 --- a/pir/showcase/index.print.html +++ b/pir/showcase/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index 551d4f11d8..beed1a7126 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/config/index.html b/pir/tags/config/index.html index 74a138c2f3..e1bdd1d057 100644 --- a/pir/tags/config/index.html +++ b/pir/tags/config/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/config/index.xml b/pir/tags/config/index.xml index 42054fede2..845c9c1e65 100644 --- a/pir/tags/config/index.xml +++ b/pir/tags/config/index.xml @@ -12,9 +12,9 @@ https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/configuration/index.html - On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer config.toml. Th' defaults be written 'n th' comments o' each opt'n. + On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer hugo.toml. Th' defaults be written 'n th' comments o' each opt'n. Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n. -​ config.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. +​ hugo.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. \ No newline at end of file diff --git a/pir/tags/content/index.html b/pir/tags/content/index.html index 5328c7fd13..81559902d6 100644 --- a/pir/tags/content/index.html +++ b/pir/tags/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index e6528fd579..ab1dbd723e 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -19,21 +19,21 @@ documentat'n :: Tagga :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/headless/index.html b/pir/tags/headless/index.html index 2041bb012a..624215461e 100644 --- a/pir/tags/headless/index.html +++ b/pir/tags/headless/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/index.html b/pir/tags/index.html index 03efd7c7a8..f4ec990f23 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/its-hidden/index.html b/pir/tags/its-hidden/index.html index 132fda7439..c43a8d147a 100644 --- a/pir/tags/its-hidden/index.html +++ b/pir/tags/its-hidden/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index fed960cd2a..c42f990499 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index f21ddd7175..810d69b66c 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -19,21 +19,21 @@ tutorrrial :: Tagga :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/search.html b/search.html index 5771def8cc..4f953c4b9c 100644 --- a/search.html +++ b/search.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index 878dd7f0bb..18d5638125 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.print.html b/shortcodes/attachments/index.print.html index 9cb61b8df3..ea57a74c69 100644 --- a/shortcodes/attachments/index.print.html +++ b/shortcodes/attachments/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/badge/index.html b/shortcodes/badge/index.html index ab0d0832f6..bf9cd80ad6 100644 --- a/shortcodes/badge/index.html +++ b/shortcodes/badge/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/badge/index.print.html b/shortcodes/badge/index.print.html index 02246a0249..517923158a 100644 --- a/shortcodes/badge/index.print.html +++ b/shortcodes/badge/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index efa65884f7..730a3f4841 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/button/index.print.html b/shortcodes/button/index.print.html index 962bf5be41..85e9c9d070 100644 --- a/shortcodes/button/index.print.html +++ b/shortcodes/button/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index 1f5da04bf8..40eaa37e80 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html index ac639035ce..d50e56953f 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 26a3110464..00c98f26af 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html index 69fc49456b..d7d76d3ad8 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index e00f410272..43fd15c86f 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html index 226250bc35..db4514127d 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index 33dc74dad9..aaa7c5ab4e 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html index a52fb0eb1d..8e1ea912c0 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index 61cbbea40c..02041d1405 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html index 8c256e1ce8..12302ddaa8 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index 201582884c..0b8834b362 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html index 7baba08908..25446422ff 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index bb07180626..51b7de129a 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html index f2b876cb9f..75a4c50517 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index 77dae6c741..d4a8ea0061 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/children-1-1/index.print.html b/shortcodes/children/children-1/children-1-1/index.print.html index dd02e09627..ea3c5c1009 100644 --- a/shortcodes/children/children-1/children-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index 815c68a649..3f39dd7a96 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/index.print.html b/shortcodes/children/children-1/index.print.html index db72d56a9a..1808e57014 100644 --- a/shortcodes/children/children-1/index.print.html +++ b/shortcodes/children/children-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index 627f1e8aa1..9354655a1a 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-2/index.print.html b/shortcodes/children/children-2/index.print.html index 802a57c523..e98c045aab 100644 --- a/shortcodes/children/children-2/index.print.html +++ b/shortcodes/children/children-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index 716110da45..b3a08393b5 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/index.print.html b/shortcodes/children/children-3/index.print.html index 7d21c04e6a..74d603cea0 100644 --- a/shortcodes/children/children-3/index.print.html +++ b/shortcodes/children/children-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/test3/index.html b/shortcodes/children/children-3/test3/index.html index bcd1ea03be..0f83f3f85b 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/test3/index.print.html b/shortcodes/children/children-3/test3/index.print.html index 947e90a907..745cc6c1d7 100644 --- a/shortcodes/children/children-3/test3/index.print.html +++ b/shortcodes/children/children-3/test3/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index 10c95217f0..53b4d3e0a3 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-4/index.print.html b/shortcodes/children/children-4/index.print.html index 16569dbaf1..aeaf7ea2d1 100644 --- a/shortcodes/children/children-4/index.print.html +++ b/shortcodes/children/children-4/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index 693283f049..04e5e80ff4 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/index.print.html b/shortcodes/children/index.print.html index b21ce9415c..424d701f88 100644 --- a/shortcodes/children/index.print.html +++ b/shortcodes/children/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index a471455061..23583b5c97 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -27,21 +27,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/test/index.print.html b/shortcodes/children/test/index.print.html index 985bce90b2..6035ac1f81 100644 --- a/shortcodes/children/test/index.print.html +++ b/shortcodes/children/test/index.print.html @@ -27,22 +27,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index 34e59ecedf..125bcbb453 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/shortcodes/expand/index.print.html b/shortcodes/expand/index.print.html index b6fe050048..772997814f 100644 --- a/shortcodes/expand/index.print.html +++ b/shortcodes/expand/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/highlight/index.html b/shortcodes/highlight/index.html index 6eb5c853e3..bf00671a0f 100644 --- a/shortcodes/highlight/index.html +++ b/shortcodes/highlight/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/highlight/index.print.html b/shortcodes/highlight/index.print.html index 2479ab299a..e61736a4e7 100644 --- a/shortcodes/highlight/index.print.html +++ b/shortcodes/highlight/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/icon/index.html b/shortcodes/icon/index.html index af03d572a9..dde7719532 100644 --- a/shortcodes/icon/index.html +++ b/shortcodes/icon/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/icon/index.print.html b/shortcodes/icon/index.print.html index e1fd48fc71..2029950c56 100644 --- a/shortcodes/icon/index.print.html +++ b/shortcodes/icon/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include/index.html b/shortcodes/include/index.html index 9c0f40d101..bd204e27d7 100644 --- a/shortcodes/include/index.html +++ b/shortcodes/include/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/include/index.print.html b/shortcodes/include/index.print.html index 85c1214c30..ad5e4c9d4f 100644 --- a/shortcodes/include/index.print.html +++ b/shortcodes/include/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include_me/index.html b/shortcodes/include_me/index.html index 14b1710604..1ba4867638 100644 --- a/shortcodes/include_me/index.html +++ b/shortcodes/include_me/index.html @@ -24,21 +24,21 @@ Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a L - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/include_me/index.print.html b/shortcodes/include_me/index.print.html index 263980352d..c8425119f1 100644 --- a/shortcodes/include_me/index.print.html +++ b/shortcodes/include_me/index.print.html @@ -24,22 +24,22 @@ Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a L - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/index.html b/shortcodes/index.html index 38fa50ee2b..f03031a0b3 100644 --- a/shortcodes/index.html +++ b/shortcodes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/index.print.html b/shortcodes/index.print.html index 8097f83927..4127a0de00 100644 --- a/shortcodes/index.print.html +++ b/shortcodes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/shortcodes/math/index.html b/shortcodes/math/index.html index 91873a5941..9310e6b849 100644 --- a/shortcodes/math/index.html +++ b/shortcodes/math/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + diff --git a/shortcodes/math/index.print.html b/shortcodes/math/index.print.html index ff05dd9c6d..18f4922aea 100644 --- a/shortcodes/math/index.print.html +++ b/shortcodes/math/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - + + diff --git a/shortcodes/mermaid/index.html b/shortcodes/mermaid/index.html index 1213a854e0..c5ee9a96f7 100644 --- a/shortcodes/mermaid/index.html +++ b/shortcodes/mermaid/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/mermaid/index.print.html b/shortcodes/mermaid/index.print.html index 3aee8ed498..94ed38acc8 100644 --- a/shortcodes/mermaid/index.print.html +++ b/shortcodes/mermaid/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/notice/index.html b/shortcodes/notice/index.html index 3c333e2bf4..3ea01ea149 100644 --- a/shortcodes/notice/index.html +++ b/shortcodes/notice/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/notice/index.print.html b/shortcodes/notice/index.print.html index 1306bdf4f7..a0c88e5a71 100644 --- a/shortcodes/notice/index.print.html +++ b/shortcodes/notice/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/openapi/index.html b/shortcodes/openapi/index.html index 3c592f7527..795608df04 100644 --- a/shortcodes/openapi/index.html +++ b/shortcodes/openapi/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + - + diff --git a/shortcodes/openapi/index.print.html b/shortcodes/openapi/index.print.html index f3e5cad119..fe5722837e 100644 --- a/shortcodes/openapi/index.print.html +++ b/shortcodes/openapi/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - + + - + diff --git a/shortcodes/siteparam/index.html b/shortcodes/siteparam/index.html index 6be6d36a77..b34fafcb4e 100644 --- a/shortcodes/siteparam/index.html +++ b/shortcodes/siteparam/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/siteparam/index.print.html b/shortcodes/siteparam/index.print.html index 30a7aaad5e..9681d35288 100644 --- a/shortcodes/siteparam/index.print.html +++ b/shortcodes/siteparam/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tab/index.html b/shortcodes/tab/index.html index 25a9e602bc..d5a5f0bee2 100644 --- a/shortcodes/tab/index.html +++ b/shortcodes/tab/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tab/index.print.html b/shortcodes/tab/index.print.html index e6292062b7..966ccae3f6 100644 --- a/shortcodes/tab/index.print.html +++ b/shortcodes/tab/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tabs/index.html b/shortcodes/tabs/index.html index 1c4dff31b8..8f57b50908 100644 --- a/shortcodes/tabs/index.html +++ b/shortcodes/tabs/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tabs/index.print.html b/shortcodes/tabs/index.print.html index b6e3e162d6..5abc2b5395 100644 --- a/shortcodes/tabs/index.print.html +++ b/shortcodes/tabs/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/showcase/index.html b/showcase/index.html index 175b147e5f..14c1f630db 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/showcase/index.print.html b/showcase/index.print.html index 02bdaba5c2..8daa227ebc 100644 --- a/showcase/index.print.html +++ b/showcase/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/tags/children/index.html b/tags/children/index.html index 514f67e43a..18c32bf7aa 100644 --- a/tags/children/index.html +++ b/tags/children/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/config/index.html b/tags/config/index.html index b814c29e89..0adf806f18 100644 --- a/tags/config/index.html +++ b/tags/config/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/config/index.xml b/tags/config/index.xml index 6604c8ebcc..bd6bac24cd 100644 --- a/tags/config/index.xml +++ b/tags/config/index.xml @@ -12,9 +12,9 @@ https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/configuration/index.html - On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your config.toml. The defaults are written in the comments of each option. + On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml. The defaults are written in the comments of each option. Note that some of these options are explained in detail in other sections of this documentation. -​ config.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. +​ hugo.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. \ No newline at end of file diff --git a/tags/content/index.html b/tags/content/index.html index 2ba194636b..13c7745022 100644 --- a/tags/content/index.html +++ b/tags/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/documentation/index.html b/tags/documentation/index.html index 6aacc2fc6b..1ae3cf88e0 100644 --- a/tags/documentation/index.html +++ b/tags/documentation/index.html @@ -19,21 +19,21 @@ documentation :: Tag :: Hugo Relearn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/headless/index.html b/tags/headless/index.html index c9c9d88434..23e72efe00 100644 --- a/tags/headless/index.html +++ b/tags/headless/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/index.html b/tags/index.html index 499eb54972..c1c74d9e7f 100644 --- a/tags/index.html +++ b/tags/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/its-hidden/index.html b/tags/its-hidden/index.html index 7246c4916e..ab760eeac3 100644 --- a/tags/its-hidden/index.html +++ b/tags/its-hidden/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/non-hidden/index.html b/tags/non-hidden/index.html index be4f33c9f5..9b687a0d5a 100644 --- a/tags/non-hidden/index.html +++ b/tags/non-hidden/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/tutorial/index.html b/tags/tutorial/index.html index 42f3e68955..0cb6bb6428 100644 --- a/tags/tutorial/index.html +++ b/tags/tutorial/index.html @@ -19,21 +19,21 @@ tutorial :: Tag :: Hugo Relearn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + +