From a47f8c47aa68fc9f17e02710cb965a353c532c82 Mon Sep 17 00:00:00 2001 From: McShelby Date: Mon, 20 Nov 2023 23:54:13 +0000 Subject: [PATCH] deploy: 98cbf97fcb5e37737ad0bcf6901424d239709a2e --- 404.html | 26 +- basics/branding/index.html | 510 ++++++++++++++ basics/branding/index.print.html | 204 ++++++ basics/branding/index.xml | 11 + basics/changelog/index.html | 47 +- basics/changelog/index.print.html | 34 +- basics/configuration/index.html | 171 +---- basics/configuration/index.print.html | 129 +--- .../home_button_defaults.png | Bin basics/customization/index.html | 250 +++---- basics/customization/index.print.html | 216 +++--- .../search_page.png | Bin basics/generator/index.html | 79 +-- basics/generator/index.print.html | 66 +- basics/history/index.html | 47 +- basics/history/index.print.html | 34 +- basics/index.html | 47 +- basics/index.print.html | 425 ++++++------ basics/index.xml | 23 +- basics/installation/index.html | 51 +- basics/installation/index.print.html | 38 +- basics/migration/index.html | 83 +-- basics/migration/index.print.html | 70 +- basics/requirements/index.html | 51 +- basics/requirements/index.print.html | 38 +- basics/topbar/index.html | 59 +- basics/topbar/index.print.html | 46 +- categories/basic/index.html | 47 +- categories/content/index.html | 47 +- categories/custom/index.html | 53 +- categories/custom/index.xml | 12 +- categories/index.html | 47 +- categories/taxonomy/index.html | 47 +- categories/theming/index.html | 53 +- categories/theming/index.xml | 14 +- config/_default/params.toml | 2 +- cont/archetypes/index.html | 59 +- cont/archetypes/index.print.html | 46 +- cont/i18n/index.html | 51 +- cont/i18n/index.print.html | 38 +- cont/imageeffects/index.html | 67 +- cont/imageeffects/index.print.html | 54 +- cont/index.html | 47 +- cont/index.print.html | 134 ++-- cont/markdown/index.html | 107 +-- cont/markdown/index.print.html | 94 +-- cont/menushortcuts/index.html | 47 +- cont/menushortcuts/index.print.html | 34 +- cont/pages/index.html | 51 +- cont/pages/index.print.html | 38 +- cont/taxonomy/index.html | 47 +- cont/taxonomy/index.print.html | 34 +- dev/contributing/index.html | 47 +- dev/contributing/index.print.html | 34 +- dev/index.html | 47 +- dev/index.print.html | 46 +- dev/maintaining/index.html | 47 +- dev/maintaining/index.print.html | 34 +- dev/screenshots/index.html | 59 +- dev/screenshots/index.print.html | 46 +- en/sitemap.xml | 6 + index.html | 61 +- index.print.html | 629 ++++++++--------- index.search.js | 16 +- more/credits/index.html | 47 +- more/credits/index.print.html | 34 +- pir/404.html | 26 +- pir/basics/branding/index.html | 512 ++++++++++++++ pir/basics/branding/index.print.html | 206 ++++++ pir/basics/branding/index.xml | 11 + pir/basics/configuration/index.html | 171 +---- pir/basics/configuration/index.print.html | 129 +--- .../home_button_defaults.png | Bin pir/basics/customization/index.html | 250 +++---- pir/basics/customization/index.print.html | 216 +++--- .../search_page.png | Bin pir/basics/generator/index.html | 79 +-- pir/basics/generator/index.print.html | 66 +- pir/basics/history/index.html | 47 +- pir/basics/history/index.print.html | 34 +- pir/basics/index.html | 47 +- pir/basics/index.print.html | 431 ++++++------ pir/basics/index.xml | 20 +- pir/basics/installation/index.html | 51 +- pir/basics/installation/index.print.html | 38 +- pir/basics/migration/index.html | 83 +-- pir/basics/migration/index.print.html | 70 +- pir/basics/requirements/index.html | 51 +- pir/basics/requirements/index.print.html | 38 +- pir/basics/topbar/index.html | 59 +- pir/basics/topbar/index.print.html | 46 +- pir/categories/basic/index.html | 47 +- pir/categories/content/index.html | 47 +- pir/categories/custom/index.html | 53 +- pir/categories/custom/index.xml | 11 +- pir/categories/index.html | 47 +- pir/categories/taxonomy/index.html | 47 +- pir/categories/theming/index.html | 53 +- pir/categories/theming/index.xml | 13 +- pir/cont/archetypes/index.html | 59 +- pir/cont/archetypes/index.print.html | 46 +- pir/cont/i18n/index.html | 51 +- pir/cont/i18n/index.print.html | 38 +- pir/cont/imageeffects/index.html | 67 +- pir/cont/imageeffects/index.print.html | 54 +- pir/cont/index.html | 47 +- pir/cont/index.print.html | 134 ++-- pir/cont/markdown/index.html | 107 +-- pir/cont/markdown/index.print.html | 94 +-- pir/cont/menushortcuts/index.html | 47 +- pir/cont/menushortcuts/index.print.html | 34 +- pir/cont/pages/index.html | 51 +- pir/cont/pages/index.print.html | 38 +- pir/cont/taxonomy/index.html | 47 +- pir/cont/taxonomy/index.print.html | 34 +- pir/dev/contributing/index.html | 47 +- pir/dev/contributing/index.print.html | 34 +- pir/dev/index.html | 47 +- pir/dev/index.print.html | 46 +- pir/dev/maintaining/index.html | 47 +- pir/dev/maintaining/index.print.html | 34 +- pir/dev/screenshots/index.html | 59 +- pir/dev/screenshots/index.print.html | 46 +- pir/index.html | 61 +- pir/index.print.html | 635 +++++++++--------- pir/index.search.js | 16 +- pir/more/credits/index.html | 47 +- pir/more/credits/index.print.html | 34 +- pir/search.html | 47 +- pir/shortcodes/attachments/index.html | 47 +- pir/shortcodes/attachments/index.print.html | 34 +- pir/shortcodes/badge/index.html | 47 +- pir/shortcodes/badge/index.print.html | 34 +- pir/shortcodes/button/index.html | 47 +- pir/shortcodes/button/index.print.html | 34 +- .../children-1-1-1-1-1-1/index.html | 47 +- .../children-1-1-1-1-1-1/index.print.html | 34 +- .../children-1-1-1-1-1/index.html | 47 +- .../children-1-1-1-1-1/index.print.html | 34 +- .../children-1-1-1-1/index.html | 47 +- .../children-1-1-1-1/index.print.html | 34 +- .../children-1-1/children-1-1-1/index.html | 47 +- .../children-1-1-1/index.print.html | 34 +- .../children-1-1-2-1/index.html | 47 +- .../children-1-1-2-1/index.print.html | 34 +- .../children-1-1-2-2/index.html | 47 +- .../children-1-1-2-2/index.print.html | 34 +- .../children-1-1/children-1-1-3/index.html | 47 +- .../children-1-1-3/index.print.html | 34 +- .../children-1/children-1-1/index.html | 47 +- .../children-1/children-1-1/index.print.html | 34 +- pir/shortcodes/children/children-1/index.html | 47 +- .../children/children-1/index.print.html | 34 +- pir/shortcodes/children/children-2/index.html | 47 +- .../children/children-2/index.print.html | 34 +- pir/shortcodes/children/children-3/index.html | 47 +- .../children/children-3/index.print.html | 34 +- .../children/children-3/test3/index.html | 47 +- .../children-3/test3/index.print.html | 34 +- pir/shortcodes/children/children-4/index.html | 47 +- .../children/children-4/index.print.html | 34 +- pir/shortcodes/children/index.html | 49 +- pir/shortcodes/children/index.print.html | 36 +- pir/shortcodes/children/test/index.html | 47 +- pir/shortcodes/children/test/index.print.html | 34 +- pir/shortcodes/expand/index.html | 71 +- pir/shortcodes/expand/index.print.html | 58 +- pir/shortcodes/highlight/index.html | 55 +- pir/shortcodes/highlight/index.print.html | 42 +- pir/shortcodes/icon/index.html | 47 +- pir/shortcodes/icon/index.print.html | 34 +- pir/shortcodes/include/index.html | 47 +- pir/shortcodes/include/index.print.html | 34 +- pir/shortcodes/index.html | 47 +- pir/shortcodes/index.print.html | 146 ++-- pir/shortcodes/math/index.html | 49 +- pir/shortcodes/math/index.print.html | 36 +- pir/shortcodes/mermaid/index.html | 69 +- pir/shortcodes/mermaid/index.print.html | 56 +- pir/shortcodes/notice/index.html | 47 +- pir/shortcodes/notice/index.print.html | 34 +- pir/shortcodes/openapi/index.html | 57 +- pir/shortcodes/openapi/index.print.html | 44 +- pir/shortcodes/siteparam/index.html | 51 +- pir/shortcodes/siteparam/index.print.html | 38 +- pir/shortcodes/tab/index.html | 71 +- pir/shortcodes/tab/index.print.html | 58 +- pir/shortcodes/tabs/index.html | 63 +- pir/shortcodes/tabs/index.print.html | 50 +- pir/showcase/index.html | 47 +- pir/showcase/index.print.html | 34 +- pir/sitemap.xml | 6 + pir/tags/children/index.html | 47 +- pir/tags/config/index.html | 47 +- pir/tags/config/index.xml | 4 +- pir/tags/content/index.html | 47 +- pir/tags/documentatn/index.html | 47 +- pir/tags/headless/index.html | 47 +- pir/tags/index.html | 47 +- pir/tags/its-hidden/index.html | 47 +- pir/tags/non-hidden/index.html | 47 +- pir/tags/tutorrrial/index.html | 47 +- search.html | 47 +- shortcodes/attachments/index.html | 47 +- shortcodes/attachments/index.print.html | 34 +- shortcodes/badge/index.html | 47 +- shortcodes/badge/index.print.html | 34 +- shortcodes/button/index.html | 47 +- shortcodes/button/index.print.html | 34 +- .../children-1-1-1-1-1-1/index.html | 47 +- .../children-1-1-1-1-1-1/index.print.html | 34 +- .../children-1-1-1-1-1/index.html | 47 +- .../children-1-1-1-1-1/index.print.html | 34 +- .../children-1-1-1-1/index.html | 47 +- .../children-1-1-1-1/index.print.html | 34 +- .../children-1-1/children-1-1-1/index.html | 47 +- .../children-1-1-1/index.print.html | 34 +- .../children-1-1-2-1/index.html | 47 +- .../children-1-1-2-1/index.print.html | 34 +- .../children-1-1-2-2/index.html | 47 +- .../children-1-1-2-2/index.print.html | 34 +- .../children-1-1/children-1-1-3/index.html | 47 +- .../children-1-1-3/index.print.html | 34 +- .../children-1/children-1-1/index.html | 47 +- .../children-1/children-1-1/index.print.html | 34 +- shortcodes/children/children-1/index.html | 47 +- .../children/children-1/index.print.html | 34 +- shortcodes/children/children-2/index.html | 47 +- .../children/children-2/index.print.html | 34 +- shortcodes/children/children-3/index.html | 47 +- .../children/children-3/index.print.html | 34 +- .../children/children-3/test3/index.html | 47 +- .../children-3/test3/index.print.html | 34 +- shortcodes/children/children-4/index.html | 47 +- .../children/children-4/index.print.html | 34 +- shortcodes/children/index.html | 49 +- shortcodes/children/index.print.html | 36 +- shortcodes/children/test/index.html | 47 +- shortcodes/children/test/index.print.html | 34 +- shortcodes/expand/index.html | 71 +- shortcodes/expand/index.print.html | 58 +- shortcodes/highlight/index.html | 55 +- shortcodes/highlight/index.print.html | 42 +- shortcodes/icon/index.html | 47 +- shortcodes/icon/index.print.html | 34 +- shortcodes/include/index.html | 47 +- shortcodes/include/index.print.html | 34 +- shortcodes/include_me/index.html | 47 +- shortcodes/include_me/index.print.html | 34 +- shortcodes/index.html | 47 +- shortcodes/index.print.html | 146 ++-- shortcodes/math/index.html | 49 +- shortcodes/math/index.print.html | 36 +- shortcodes/mermaid/index.html | 69 +- shortcodes/mermaid/index.print.html | 56 +- shortcodes/notice/index.html | 47 +- shortcodes/notice/index.print.html | 34 +- shortcodes/openapi/index.html | 57 +- shortcodes/openapi/index.print.html | 44 +- shortcodes/siteparam/index.html | 51 +- shortcodes/siteparam/index.print.html | 38 +- shortcodes/tab/index.html | 71 +- shortcodes/tab/index.print.html | 58 +- shortcodes/tabs/index.html | 63 +- shortcodes/tabs/index.print.html | 50 +- showcase/index.html | 47 +- showcase/index.print.html | 34 +- tags/children/index.html | 47 +- tags/config/index.html | 47 +- tags/config/index.xml | 6 +- tags/content/index.html | 47 +- tags/documentation/index.html | 47 +- tags/headless/index.html | 47 +- tags/index.html | 47 +- tags/its-hidden/index.html | 47 +- tags/non-hidden/index.html | 47 +- tags/tutorial/index.html | 47 +- 277 files changed, 9187 insertions(+), 7822 deletions(-) create mode 100644 basics/branding/index.html create mode 100644 basics/branding/index.print.html create mode 100644 basics/branding/index.xml rename basics/{configuration => customization}/home_button_defaults.png (100%) rename basics/{configuration => customization}/search_page.png (100%) create mode 100644 pir/basics/branding/index.html create mode 100644 pir/basics/branding/index.print.html create mode 100644 pir/basics/branding/index.xml rename pir/basics/{configuration => customization}/home_button_defaults.png (100%) rename pir/basics/{configuration => customization}/search_page.png (100%) diff --git a/404.html b/404.html index 42b6067746..e4f0801045 100644 --- a/404.html +++ b/404.html @@ -19,20 +19,20 @@ 404 Page not found :: Hugo Relearn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Branding

+ +

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.toml.

+

The 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.

+

Once configured in your config.toml, you can select them with the variant selector at the bottom of the menu.

+

Change 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.

+
[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.

+

If 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!

+
+
+

Multiple 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.

+
[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!

+

Although all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.

+
+
+

Adjust 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. That’s it.

+

You 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.

+
[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.

+

In the above example, you would end with red for light mode and the default of relearn-dark for dark mode.

+

If 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.

+
[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.

+

If 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.

+

If 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.

+

If 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:

+
<link rel="icon" href="/images/favicon.bmp" type="image/bmp">
+

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!

+ +
+
Note
+
+ +

The size of the logo will adapt automatically.

+
+
+

Syntax highlightning

+

If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation. Then, @import the syntax highlightning stylesheet in your color variant stylesheet.

+

For an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.

+

If you want to reconfigure just the syntax highlighting of an existing color variant, you need to copy the file to your site’s directory and adjust it accordingly.

+

Change 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.

+

Like 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.

+

Again, 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.

+
[params]
+  themeVariant = [ "relearn-light", "relearn-dark" ]

you now write it that way:

+
[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.

+

Parameter

+ + + + + + + + + + + + + + + + + + + + +
NameDefaultNotes
identifier<empty>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-<IDENTIFIER>.css.
namesee notesThe name to be displayed in the variant selector. If not set, the identifier is used in a human readable form.
+ + +
+
+
+
+ + + + + + diff --git a/basics/branding/index.print.html b/basics/branding/index.print.html new file mode 100644 index 0000000000..6c74491b61 --- /dev/null +++ b/basics/branding/index.print.html @@ -0,0 +1,204 @@ + + + + + + + + + + + + + + + + + + + + Branding :: Hugo Relearn Theme + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Branding

+ +

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.toml.

+

The 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.

+

Once configured in your config.toml, you can select them with the variant selector at the bottom of the menu.

+

Change 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.

+
[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.

+

If 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!

+
+
+

Multiple 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.

+
[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!

+

Although all options documented here are still working, the advanced configuration options are the recommended way to configure your color variants. See below.

+
+
+

Adjust 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. That’s it.

+

You 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.

+
[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.

+

In the above example, you would end with red for light mode and the default of relearn-dark for dark mode.

+

If 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.

+
[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.

+

If 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.

+

If 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.

+

If 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:

+
<link rel="icon" href="/images/favicon.bmp" type="image/bmp">
+

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!

+ +
+
Note
+
+ +

The size of the logo will adapt automatically.

+
+
+

Syntax highlightning

+

If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation. Then, @import the syntax highlightning stylesheet in your color variant stylesheet.

+

For an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.

+

If you want to reconfigure just the syntax highlighting of an existing color variant, you need to copy the file to your site’s directory and adjust it accordingly.

+

Change 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.

+

Like 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.

+

Again, 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.

+
[params]
+  themeVariant = [ "relearn-light", "relearn-dark" ]

you now write it that way:

+
[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.

+

Parameter

+ + + + + + + + + + + + + + + + + + + + +
NameDefaultNotes
identifier<empty>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-<IDENTIFIER>.css.
namesee notesThe name to be displayed in the variant selector. If not set, the identifier is used in a human readable form.
+ + +
+ +
+
+
+ + + + + diff --git a/basics/branding/index.xml b/basics/branding/index.xml new file mode 100644 index 0000000000..2c0c0ea02c --- /dev/null +++ b/basics/branding/index.xml @@ -0,0 +1,11 @@ + + + + Branding on Hugo Relearn Theme + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + Recent content in Branding on Hugo Relearn Theme + Hugo -- gohugo.io + en + + + \ No newline at end of file diff --git a/basics/changelog/index.html b/basics/changelog/index.html index 5c62b7a1ec..69ec520dd7 100644 --- a/basics/changelog/index.html +++ b/basics/changelog/index.html @@ -20,20 +20,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/changelog/index.print.html b/basics/changelog/index.print.html index 3134f4f4bb..a67754afdc 100644 --- a/basics/changelog/index.print.html +++ b/basics/changelog/index.print.html @@ -20,21 +20,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/index.html b/basics/configuration/index.html index 5feaf24849..16eaa04c8b 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/configuration/index.print.html b/basics/configuration/index.print.html index d0677dbfaf..e99fde415c 100644 --- a/basics/configuration/index.print.html +++ b/basics/configuration/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/home_button_defaults.png b/basics/customization/home_button_defaults.png similarity index 100% rename from basics/configuration/home_button_defaults.png rename to basics/customization/home_button_defaults.png diff --git a/basics/customization/index.html b/basics/customization/index.html index 24d8eb5d78..909bc76d04 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/customization/index.print.html b/basics/customization/index.print.html index b02051ec44..2174c4b62d 100644 --- a/basics/customization/index.print.html +++ b/basics/customization/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/search_page.png b/basics/customization/search_page.png similarity index 100% rename from basics/configuration/search_page.png rename to basics/customization/search_page.png diff --git a/basics/generator/index.html b/basics/generator/index.html index 2e09ecf8ba..fd89355099 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.print.html b/basics/generator/index.print.html index de74f3f922..508f571dbc 100644 --- a/basics/generator/index.print.html +++ b/basics/generator/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index f87d660695..53bf93b884 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/history/index.print.html b/basics/history/index.print.html index b3b07c18a3..428c121193 100644 --- a/basics/history/index.print.html +++ b/basics/history/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/index.html b/basics/index.html index a30de8f446..3611f200f5 100644 --- a/basics/index.html +++ b/basics/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/index.print.html b/basics/index.print.html index fd90efdfb7..1a8d047e1c 100644 --- a/basics/index.print.html +++ b/basics/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/index.xml b/basics/index.xml index c54dcb97c0..4aa959fba9 100644 --- a/basics/index.xml +++ b/basics/index.xml @@ -40,19 +40,26 @@ This theme&rsquo;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 - Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default). -Note that some of these parameters are explained in details in other sections of this documentation. -&#8203; 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. + On top of Hugo&rsquo;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. +Note that some of these options are explained in detail in other sections of this documentation. +&#8203; 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. + + + Branding + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + Mon, 01 Jan 0001 00:00:00 +0000 + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + The Relearn theme provides configuration options to change your your site&rsquo;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. 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 - The Relearn theme has been built to be as configurable as possible by defining multiple partials -In themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don&rsquo;t change the code directly. Instead follow this page. You&rsquo;d create a new partial in the layouts/partials folder of your local project. This partial will have the priority. -This theme defines the following partials : -header.html: the header of the page. + 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 +baseURL = &#34;https://example.com/mysite/&#34; 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&rsquo;ll need the following configuration in your config. Stylesheet generator @@ -60,7 +67,7 @@ header.html: the header of the page. Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/generator/index.html This interactive tool may help you to generate your own color variant stylesheet. -Show usage instructions To get started, first select a color variant from the variant switch in the lower left sidebar that fits you best as a starting point. +Show 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. The 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. diff --git a/basics/installation/index.html b/basics/installation/index.html index 49e0dd223c..5fae4f7ba5 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/installation/index.print.html b/basics/installation/index.print.html index d1c4f56782..5b43f394bc 100644 --- a/basics/installation/index.print.html +++ b/basics/installation/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/migration/index.html b/basics/migration/index.html index 3ccf135bd9..2685725a9c 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/migration/index.print.html b/basics/migration/index.print.html index 4d6257044e..301f229905 100644 --- a/basics/migration/index.print.html +++ b/basics/migration/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index d92bba0578..56d2902806 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/requirements/index.print.html b/basics/requirements/index.print.html index 15e592d59c..f32a8ae2cc 100644 --- a/basics/requirements/index.print.html +++ b/basics/requirements/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/basics/topbar/index.html b/basics/topbar/index.html index 9bee40cb9c..e6f62a1dc9 100644 --- a/basics/topbar/index.html +++ b/basics/topbar/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/topbar/index.print.html b/basics/topbar/index.print.html index b4453a5eb8..8b08f7e337 100644 --- a/basics/topbar/index.print.html +++ b/basics/topbar/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/categories/basic/index.html b/categories/basic/index.html index d0c543dcc4..43abef9f69 100644 --- a/categories/basic/index.html +++ b/categories/basic/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/content/index.html b/categories/content/index.html index 55f1baee54..f922db02da 100644 --- a/categories/content/index.html +++ b/categories/content/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.html b/categories/custom/index.html index 1e27b36d9f..3c4ad64c3e 100644 --- a/categories/custom/index.html +++ b/categories/custom/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.xml b/categories/custom/index.xml index bed83e9d66..031cd22b99 100644 --- a/categories/custom/index.xml +++ b/categories/custom/index.xml @@ -8,14 +8,12 @@ en - Customization - https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html + Branding + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 - https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html - The Relearn theme has been built to be as configurable as possible by defining multiple partials -In themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don&rsquo;t change the code directly. Instead follow this page. You&rsquo;d create a new partial in the layouts/partials folder of your local project. This partial will have the priority. -This theme defines the following partials : -header.html: the header of the page. + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + The Relearn theme provides configuration options to change your your site&rsquo;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. \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index 55c5a675ce..2cb5de09fb 100644 --- a/categories/index.html +++ b/categories/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/taxonomy/index.html b/categories/taxonomy/index.html index 544b35400f..db37bb5ba7 100644 --- a/categories/taxonomy/index.html +++ b/categories/taxonomy/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.html b/categories/theming/index.html index 07c001e919..18d62aa53c 100644 --- a/categories/theming/index.html +++ b/categories/theming/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.xml b/categories/theming/index.xml index 67d08a030d..6d4ec97ffb 100644 --- a/categories/theming/index.xml +++ b/categories/theming/index.xml @@ -8,14 +8,12 @@ en - Customization - https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html + Branding + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 - https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html - The Relearn theme has been built to be as configurable as possible by defining multiple partials -In themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don&rsquo;t change the code directly. Instead follow this page. You&rsquo;d create a new partial in the layouts/partials folder of your local project. This partial will have the priority. -This theme defines the following partials : -header.html: the header of the page. + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + The Relearn theme provides configuration options to change your your site&rsquo;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. Stylesheet generator @@ -23,7 +21,7 @@ header.html: the header of the page. Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/basics/generator/index.html This interactive tool may help you to generate your own color variant stylesheet. -Show usage instructions To get started, first select a color variant from the variant switch in the lower left sidebar that fits you best as a starting point. +Show 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. The 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. diff --git a/config/_default/params.toml b/config/_default/params.toml index edfadda378..93d1111d5f 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -75,7 +75,7 @@ themeVariant = [ # The color variants used for auto mode. # Default: [ "relearn-light", "relearn-dark" ], overwritten by the first -# two non-auto options from themeVariant if existant. +# two non-auto options of your `themeVariant` option if present. # The auto variant defines how your site adjusts to your selected OS settings # for light/dark mode. The first array element is the variant for light mode, # the second for dark mode. diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index f7a2c72027..c851776911 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.print.html b/cont/archetypes/index.print.html index a490ea2e1e..9d8a52f83d 100644 --- a/cont/archetypes/index.print.html +++ b/cont/archetypes/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/i18n/index.html b/cont/i18n/index.html index b33f8908a1..d8befe86fd 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/i18n/index.print.html b/cont/i18n/index.print.html index cbda0f82ae..67f366338c 100644 --- a/cont/i18n/index.print.html +++ b/cont/i18n/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/imageeffects/index.html b/cont/imageeffects/index.html index 5d434d539d..beab94547e 100644 --- a/cont/imageeffects/index.html +++ b/cont/imageeffects/index.html @@ -32,20 +32,20 @@ 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 b5d431d0c9..7ec92de82e 100644 --- a/cont/imageeffects/index.print.html +++ b/cont/imageeffects/index.print.html @@ -32,21 +32,21 @@ Without any settings in your config.toml this defaults to"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/index.html b/cont/index.html index 44a54ac6f2..973042dacf 100644 --- a/cont/index.html +++ b/cont/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/index.print.html b/cont/index.print.html index 21760df032..603291fce0 100644 --- a/cont/index.print.html +++ b/cont/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 10ed2dbe24..14d7633f09 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -30,20 +30,20 @@ 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 a269c001e7..0046dc4ee2 100644 --- a/cont/markdown/index.print.html +++ b/cont/markdown/index.print.html @@ -30,21 +30,21 @@ 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 4035586d66..968cce3c32 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -30,20 +30,20 @@ Example from the current website: - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/menushortcuts/index.print.html b/cont/menushortcuts/index.print.html index 0ddae961a6..928449b50d 100644 --- a/cont/menushortcuts/index.print.html +++ b/cont/menushortcuts/index.print.html @@ -30,21 +30,21 @@ Example from the current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/index.html b/cont/pages/index.html index 3c2d1d33f7..842ab9d3ad 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/pages/index.print.html b/cont/pages/index.print.html index 5d2c737187..3701361f4b 100644 --- a/cont/pages/index.print.html +++ b/cont/pages/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/cont/taxonomy/index.html b/cont/taxonomy/index.html index ec82a268d8..36a8f18a17 100644 --- a/cont/taxonomy/index.html +++ b/cont/taxonomy/index.html @@ -30,20 +30,20 @@ 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 ca84822470..387b70392c 100644 --- a/cont/taxonomy/index.print.html +++ b/cont/taxonomy/index.print.html @@ -30,21 +30,21 @@ The categories are displayed at the bottom of the page in alphabetical order in - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 8c7fa65db2..da49a17c88 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/contributing/index.print.html b/dev/contributing/index.print.html index e66c74b099..ea54a8ce88 100644 --- a/dev/contributing/index.print.html +++ b/dev/contributing/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/index.html b/dev/index.html index d340cfa59d..18137df371 100644 --- a/dev/index.html +++ b/dev/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/index.print.html b/dev/index.print.html index 8a9777451c..69b864ed02 100644 --- a/dev/index.print.html +++ b/dev/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/maintaining/index.html b/dev/maintaining/index.html index c209a0746f..2054a0530a 100644 --- a/dev/maintaining/index.html +++ b/dev/maintaining/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/maintaining/index.print.html b/dev/maintaining/index.print.html index 3f7e735fe6..3f0ca8ce6f 100644 --- a/dev/maintaining/index.print.html +++ b/dev/maintaining/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/dev/screenshots/index.html b/dev/screenshots/index.html index 29c883c4fc..e89da81f20 100644 --- a/dev/screenshots/index.html +++ b/dev/screenshots/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/screenshots/index.print.html b/dev/screenshots/index.print.html index 319274224d..2d8f2fa7bf 100644 --- a/dev/screenshots/index.print.html +++ b/dev/screenshots/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/en/sitemap.xml b/en/sitemap.xml index 83daef6720..2dd137de0c 100644 --- a/en/sitemap.xml +++ b/en/sitemap.xml @@ -102,6 +102,12 @@ + + https://McShelby.github.io/hugo-theme-relearn/basics/branding/index.html + + + + https://McShelby.github.io/hugo-theme-relearn/basics/customization/index.html diff --git a/index.html b/index.html index 000abd1e97..582591cecb 100644 --- a/index.html +++ b/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/index.print.html b/index.print.html index 7c4540eed6..801f6fbbb4 100644 --- a/index.print.html +++ b/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/index.search.js b/index.search.js index 9afaf710d7..868a09cc91 100644 --- a/index.search.js +++ b/index.search.js @@ -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.95.0 The minimum required Hugo version.\nBreaking A change that requires action by you after upgrading to assure the site is still functional.\nChange A change in default behavior that may requires action by you if you want to revert it.\nNew Marks new behavior you might find interesting or comes configurable.\n5.24.0.beta Change 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.\nNew You now can configure options for every theme variant. This allows for optional extended functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe extended 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 provide an extended way to configure the automatic switch of variants based on 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 switch will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant switch will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant switcher 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 guessSyntax=true is set. 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.95.0 The minimum required Hugo version.\nBreaking A change that requires action by you after upgrading to assure the site is still functional.\nChange A change in default behavior that may requires action by you if you want to revert it.\nNew Marks new behavior you might find interesting or comes configurable.\n5.24.0.beta Change 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.\nNew You now can configure options for every theme variant. This allows for optional extended functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe extended 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 provide an extended way to configure the automatic switch of variants based on 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 guessSyntax=true is set. 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", "description": "", "tags": null, "title": "What's New", @@ -138,7 +138,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n​ 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: \"auto\", \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". The auto variant is somewhat special. See the # option for themeVariantAuto below. # 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 = \"auto\" }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] # The color variants used for auto mode. # Default: [ \"relearn-light\", \"relearn-dark\" ], overwritten by the first # two non-auto options from themeVariant if existant. # The auto variant defines how your site adjusts to your selected OS settings # for light/dark mode. The first array element is the variant for light mode, # the second for dark mode. themeVariantAuto = [ \"relearn-light\", \"relearn-dark\" ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 but behaves # like any other page for all other functionality in Hugo. # 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" 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 branch 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 the same 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.\nMathJax The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Math for additional documentation.\nExample MathJax is globally disabled. By default it won’t be loaded by any page.\nOn page “Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.\nYou also can disable MathJax for specific pages while globally enabled.\nMermaid The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.\nExample Mermaid is globally disabled. By default it won’t be loaded by any page.\nOn page “Architecture” you coded some JavaScript to dynamically generate a class diagram. You can set the Mermaid parameters locally to load mermaid on this page.\nYou also can disable Mermaid for specific pages while globally enabled.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:\n[languages] [languages.en] ... [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 those params are 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.\n", + "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: \"auto\", \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". The auto variant is somewhat special. See the # option for themeVariantAuto below. # 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 = \"auto\" }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] # The color variants used for auto mode. # Default: [ \"relearn-light\", \"relearn-dark\" ], overwritten by the first # two non-auto options of your `themeVariant` option if present. # The auto variant defines how your site adjusts to your selected OS settings # for light/dark mode. The first array element is the variant for light mode, # the second for dark mode. themeVariantAuto = [ \"relearn-light\", \"relearn-dark\" ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 but behaves # like any other page for all other functionality in Hugo. # 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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" @@ -159,7 +159,15 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\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. Change the Logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNote The size of the logo will adapt automatically\nChange the Favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectively.\nAdditionally, if you want your site to use light \u0026 dark theme favicons that follow the OS’ (and in some cases, the browser’s) color scheme, add the image files to your local static/images/ folder and name them eg. favicon-light.svg and/or favicon-dark.svg respectively corresponding to your file format. In case one of the files is missing, the theme falls back to eg. favicon.svg for the missing file. All supplied favicons must be of the same file format.\nWarning IE and old browser versions do not support media queries, which are necessary for the light \u0026 dark theme favicon option. If you have requirements to support IE and/or older browser versions, use one of the other options.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003eChange 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; }Change the Colors The Relearn theme lets you choose between some predefined color variants in light or dark mode, but feel free to add one yourself!\nYou can preview the shipped variants by changing them in the variant selector at the bottom of the menu.\nSingle Variant Set the themeVariant value with the name of your theme file. That’s it!\n[params] themeVariant = \"relearn-light\"In the above example your theme file has to be named theme-relearn-light.css\nMultiple Variants You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer.\n[params] # Change default color scheme with a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Tip If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation, and @import this stylesheet in your color variant stylesheet. For an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.\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. That’s it.\nIf you’ve set multiple variants, you can drop auto at any position, but usually it makes sense to set it in the first position and make it the default.\n[params] themeVariant = [ \"auto\", \"red\" ]If you don’t configure anything else, the theme will use relearn-light for light mode and relearn-dark for dark mode.\nIf you don’t like that, you can set themeVariantAuto. The first element is the variant for light mode, the second for dark mode\n[params] themeVariantAuto = [ \"learn\", \"neon\" ] Note This is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nJavaScript Once a variant is fully loaded, either initially or by switching the 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` });Roll your Own If you are not happy with the shipped variants you can either copy and rename one of the shipped files from themes/hugo-theme-relearn/static/css to static/css, edit them afterwards to your liking in a text editor and configure the themeVariant parameter in your config.toml or just use the interactive variant generator.\nOwn 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. To provide this behavior to the user and extending it for his own shortcodes this can be configured.\nSay 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.\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 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[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[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. 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[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[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\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003eChange 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, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation. Then, @import the syntax highlightning stylesheet in your color variant stylesheet.\nFor an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.\nIf you want to reconfigure just the syntax highlighting of an existing color variant, you need to copy the file to your site’s directory and adjust it accordingly.\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[params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ]you now write it that way:\n[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. ", + "description": "", + "tags": null, + "title": "Branding", + "uri": "/basics/branding/index.html" + }, + { + "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. ", "description": "", "tags": null, "title": "Customization", @@ -167,7 +175,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 switch 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 switch 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 Graph Download variant Reset variant ", + "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 Graph Download variant Reset variant ", "description": "", "tags": null, "title": "Stylesheet generator", diff --git a/more/credits/index.html b/more/credits/index.html index 28e4d991d6..154e46681c 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/more/credits/index.print.html b/more/credits/index.print.html index 13192475c2..a5577dd687 100644 --- a/more/credits/index.print.html +++ b/more/credits/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/404.html b/pir/404.html index ee808f801b..2647756184 100644 --- a/pir/404.html +++ b/pir/404.html @@ -19,20 +19,20 @@ 404 Page not found :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Brrrand'n

+ + +

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.toml.

+

Th' 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.

+

Once configured 'n yer config.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.

+

Change 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.

+
[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.

+

If 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!

+
+
+

Multiple 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.

+
[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!

+

Although 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.

+
+
+

Adjust 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. That’s it.

+

Ye 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.

+
[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.

+

In th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.

+

If 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.

+
[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.

+

If 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.

+

If 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.

+

If 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:

+
<link rel="icon" href="/images/favicon.bmp" type="image/bmp">
+

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!

+ +
+
Avast
+
+ +

Th' size o' th' logo will adapt automatically.

+
+
+

Rules highlightn'n

+

If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n. Then, @import th' rules highlightn'n stylesheet 'n yer color variant stylesheet.

+

For an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.

+

If ye want t' reconfigure just th' rules highlight'n o' an exist'n color variant, ye need t' copy th' file t' yer site’s directory an' adjust it accordingly.

+

Change 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.

+

Like 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.

+

Again, '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.

+
[params]
+  themeVariant = [ "relearn-light", "relearn-dark" ]

ye now write it that way:

+
[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.

+

Parameter

+ + + + + + + + + + + + + + + + + + + + +
NameDefaultNotes
identifier<empty>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-<IDENTIFIER>.css.
namesee notesTh' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form.
+ + + +
+
+
+
+ + + + + + diff --git a/pir/basics/branding/index.print.html b/pir/basics/branding/index.print.html new file mode 100644 index 0000000000..e2cac44635 --- /dev/null +++ b/pir/basics/branding/index.print.html @@ -0,0 +1,206 @@ + + + + + + + + + + + + + + + + + + + + Brrrand'n :: Cap'n Hugo Relearrrn Theme + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Brrrand'n

+ + +

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.toml.

+

Th' 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.

+

Once configured 'n yer config.toml, ye can select them wit' th' variant selector at th' bottom o' th' menu.

+

Change 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.

+
[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.

+

If 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!

+
+
+

Multiple 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.

+
[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!

+

Although 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.

+
+
+

Adjust 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. That’s it.

+

Ye 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.

+
[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.

+

In th' above example, ye would end wit' red fer light mode an' th' default o' relearn-dark fer dark mode.

+

If 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.

+
[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.

+

If 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.

+

If 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.

+

If 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:

+
<link rel="icon" href="/images/favicon.bmp" type="image/bmp">
+

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!

+ +
+
Avast
+
+ +

Th' size o' th' logo will adapt automatically.

+
+
+

Rules highlightn'n

+

If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n. Then, @import th' rules highlightn'n stylesheet 'n yer color variant stylesheet.

+

For an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.

+

If ye want t' reconfigure just th' rules highlight'n o' an exist'n color variant, ye need t' copy th' file t' yer site’s directory an' adjust it accordingly.

+

Change 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.

+

Like 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.

+

Again, '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.

+
[params]
+  themeVariant = [ "relearn-light", "relearn-dark" ]

ye now write it that way:

+
[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.

+

Parameter

+ + + + + + + + + + + + + + + + + + + + +
NameDefaultNotes
identifier<empty>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-<IDENTIFIER>.css.
namesee notesTh' name t' be displayed 'n th' variant selector. If not set, th' identifier be used 'n a human read'ble form.
+ + + +
+ +
+
+
+ + + + + diff --git a/pir/basics/branding/index.xml b/pir/basics/branding/index.xml new file mode 100644 index 0000000000..8dd8b3bec2 --- /dev/null +++ b/pir/basics/branding/index.xml @@ -0,0 +1,11 @@ + + + + Brrrand'n on Cap'n Hugo Relearrrn Theme + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html + Recent content in Brrrand'n on Cap'n Hugo Relearrrn Theme + Hugo -- gohugo.io + pir + + + \ No newline at end of file diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index 412bcdf0be..31ba9576f4 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/configuration/index.print.html b/pir/basics/configuration/index.print.html index 5dcb5b90af..4436d3c7db 100644 --- a/pir/basics/configuration/index.print.html +++ b/pir/basics/configuration/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/home_button_defaults.png b/pir/basics/customization/home_button_defaults.png similarity index 100% rename from pir/basics/configuration/home_button_defaults.png rename to pir/basics/customization/home_button_defaults.png diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index 3244027029..88ae2c6cff 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/customization/index.print.html b/pir/basics/customization/index.print.html index ec0dcc15db..005c526bea 100644 --- a/pir/basics/customization/index.print.html +++ b/pir/basics/customization/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/search_page.png b/pir/basics/customization/search_page.png similarity index 100% rename from pir/basics/configuration/search_page.png rename to pir/basics/customization/search_page.png diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index 14405d6d71..49c3cbd206 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/generator/index.print.html b/pir/basics/generator/index.print.html index c87e9a960d..e5f30a5fce 100644 --- a/pir/basics/generator/index.print.html +++ b/pir/basics/generator/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index 5659bf55fc..2098186ccb 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/history/index.print.html b/pir/basics/history/index.print.html index 78a96cd708..c9607f3996 100644 --- a/pir/basics/history/index.print.html +++ b/pir/basics/history/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/index.html b/pir/basics/index.html index 07910b1365..0f8157b51a 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/index.print.html b/pir/basics/index.print.html index 4c3b0ac032..b8b74390f8 100644 --- a/pir/basics/index.print.html +++ b/pir/basics/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/index.xml b/pir/basics/index.xml index a7456d5648..1287a77b54 100644 --- a/pir/basics/index.xml +++ b/pir/basics/index.xml @@ -40,18 +40,26 @@ This theme&rsquo;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 - Global ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default). -Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n. + On top o' Hugo&rsquo;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. +Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n. &#8203; 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. + + + Brrrand'n + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html + Mon, 01 Jan 0001 00:00:00 +0000 + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html + Th' Relearrrn theme provides configurat'n opt'ns t' change yer your site&rsquo;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. 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 - Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials -In themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don&rsquo;t change th' code directly. Instead follow this plank. You&rsquo;d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority. -This theme defines th' follow'n partials : + 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 +baseURL = &#34;https://example.com/mysite/&#34; 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&rsquo;ll need th' follow'n configurat'n 'n yer config. Stylesheet generrrat'r @@ -59,7 +67,7 @@ This theme defines th' follow'n partials : Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/generator/index.html This interactive tool may help ye t' generate yer own color variant stylesheet. -Show usage instruct'ns T' get started, first select a color variant from th' variant switch 'n th' lower left sidebar that fits ye best as a start'n point. +Show 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. Th' 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. diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index c0d26da04c..825bb9fcdd 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/installation/index.print.html b/pir/basics/installation/index.print.html index d849a44644..220cc7ba41 100644 --- a/pir/basics/installation/index.print.html +++ b/pir/basics/installation/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index b1ae445779..5e1482435e 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/migration/index.print.html b/pir/basics/migration/index.print.html index 8400ff262b..181274e2c6 100644 --- a/pir/basics/migration/index.print.html +++ b/pir/basics/migration/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index 0bbf476fdf..51e974ab28 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/requirements/index.print.html b/pir/basics/requirements/index.print.html index bcdccbbf50..e409b08f95 100644 --- a/pir/basics/requirements/index.print.html +++ b/pir/basics/requirements/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/topbar/index.html b/pir/basics/topbar/index.html index 84ef09fd40..afad5866a4 100644 --- a/pir/basics/topbar/index.html +++ b/pir/basics/topbar/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/topbar/index.print.html b/pir/basics/topbar/index.print.html index 6bfb9f8575..071455f644 100644 --- a/pir/basics/topbar/index.print.html +++ b/pir/basics/topbar/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/categories/basic/index.html b/pir/categories/basic/index.html index dfa58a89ed..5313ac06cd 100644 --- a/pir/categories/basic/index.html +++ b/pir/categories/basic/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/content/index.html b/pir/categories/content/index.html index 46eb29fb6a..b7cd319756 100644 --- a/pir/categories/content/index.html +++ b/pir/categories/content/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.html b/pir/categories/custom/index.html index 7b8874dc96..31ff87f83d 100644 --- a/pir/categories/custom/index.html +++ b/pir/categories/custom/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.xml b/pir/categories/custom/index.xml index 633b9a86db..e85d5b8e75 100644 --- a/pir/categories/custom/index.xml +++ b/pir/categories/custom/index.xml @@ -8,13 +8,12 @@ pir - Customizat'n - https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html + Brrrand'n + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 - https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html - Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials -In themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don&rsquo;t change th' code directly. Instead follow this plank. You&rsquo;d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority. -This theme defines th' follow'n partials : + 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&rsquo;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. \ No newline at end of file diff --git a/pir/categories/index.html b/pir/categories/index.html index c0d89f3056..a013d17816 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/taxonomy/index.html b/pir/categories/taxonomy/index.html index db7b1ba435..71e0d41dd7 100644 --- a/pir/categories/taxonomy/index.html +++ b/pir/categories/taxonomy/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.html b/pir/categories/theming/index.html index ad14eeea77..d7a77b7e6a 100644 --- a/pir/categories/theming/index.html +++ b/pir/categories/theming/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.xml b/pir/categories/theming/index.xml index b5f2a540de..55e8feea35 100644 --- a/pir/categories/theming/index.xml +++ b/pir/categories/theming/index.xml @@ -8,13 +8,12 @@ pir - Customizat'n - https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html + Brrrand'n + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html Mon, 01 Jan 0001 00:00:00 +0000 - https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html - Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials -In themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don&rsquo;t change th' code directly. Instead follow this plank. You&rsquo;d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority. -This theme defines th' follow'n partials : + 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&rsquo;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. Stylesheet generrrat'r @@ -22,7 +21,7 @@ This theme defines th' follow'n partials : Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/pir/basics/generator/index.html This interactive tool may help ye t' generate yer own color variant stylesheet. -Show usage instruct'ns T' get started, first select a color variant from th' variant switch 'n th' lower left sidebar that fits ye best as a start'n point. +Show 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. Th' 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. diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index 9efc28427b..fff2b92e20 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/archetypes/index.print.html b/pir/cont/archetypes/index.print.html index 2c31200e29..9523fb7bb4 100644 --- a/pir/cont/archetypes/index.print.html +++ b/pir/cont/archetypes/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index 2ee911b1f2..7adec453d4 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/i18n/index.print.html b/pir/cont/i18n/index.print.html index 7b0e42053d..fb14773ec5 100644 --- a/pir/cont/i18n/index.print.html +++ b/pir/cont/i18n/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/imageeffects/index.html b/pir/cont/imageeffects/index.html index 056e78271c..4c0a9e6b84 100644 --- a/pir/cont/imageeffects/index.html +++ b/pir/cont/imageeffects/index.html @@ -32,20 +32,20 @@ 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 2889cb060c..73d4aa55c2 100644 --- a/pir/cont/imageeffects/index.print.html +++ b/pir/cont/imageeffects/index.print.html @@ -32,21 +32,21 @@ Without any sett'ns 'n yer config.toml this defaults t'"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.html b/pir/cont/index.html index 209b9aa5c1..b6a1c567a6 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/index.print.html b/pir/cont/index.print.html index 81828addb9..86e7208eb9 100644 --- a/pir/cont/index.print.html +++ b/pir/cont/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index 8735677f8b..6fd59c2e6f 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -30,20 +30,20 @@ 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 598ea3507d..e11084e0ea 100644 --- a/pir/cont/markdown/index.print.html +++ b/pir/cont/markdown/index.print.html @@ -30,21 +30,21 @@ 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 b1ac2ef853..39bca110eb 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -30,20 +30,20 @@ Example from th' current website: - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/menushortcuts/index.print.html b/pir/cont/menushortcuts/index.print.html index d887b3b2c8..cf6679eeb8 100644 --- a/pir/cont/menushortcuts/index.print.html +++ b/pir/cont/menushortcuts/index.print.html @@ -30,21 +30,21 @@ Example from th' current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index d67826f00d..108dda30c4 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/pages/index.print.html b/pir/cont/pages/index.print.html index 7f5a9ced0c..1b94dfd384 100644 --- a/pir/cont/pages/index.print.html +++ b/pir/cont/pages/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/taxonomy/index.html b/pir/cont/taxonomy/index.html index 2659c1fff6..0fba2c1853 100644 --- a/pir/cont/taxonomy/index.html +++ b/pir/cont/taxonomy/index.html @@ -30,20 +30,20 @@ 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 2cf2437013..fef41d89d1 100644 --- a/pir/cont/taxonomy/index.print.html +++ b/pir/cont/taxonomy/index.print.html @@ -30,21 +30,21 @@ 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 5e963908cf..d08f10a9e3 100644 --- a/pir/dev/contributing/index.html +++ b/pir/dev/contributing/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/contributing/index.print.html b/pir/dev/contributing/index.print.html index 1af19c844c..2c0c6c3c6a 100644 --- a/pir/dev/contributing/index.print.html +++ b/pir/dev/contributing/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/index.html b/pir/dev/index.html index 6a830cddff..7a56bfaec6 100644 --- a/pir/dev/index.html +++ b/pir/dev/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/index.print.html b/pir/dev/index.print.html index f9237d1e13..3446155bed 100644 --- a/pir/dev/index.print.html +++ b/pir/dev/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/maintaining/index.html b/pir/dev/maintaining/index.html index ba4afabdb1..cf4daf19b4 100644 --- a/pir/dev/maintaining/index.html +++ b/pir/dev/maintaining/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/maintaining/index.print.html b/pir/dev/maintaining/index.print.html index 8719179a46..63e12d24bd 100644 --- a/pir/dev/maintaining/index.print.html +++ b/pir/dev/maintaining/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/screenshots/index.html b/pir/dev/screenshots/index.html index 5302c5ffe6..0eae280e03 100644 --- a/pir/dev/screenshots/index.html +++ b/pir/dev/screenshots/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/screenshots/index.print.html b/pir/dev/screenshots/index.print.html index 7a44919482..51f77e0356 100644 --- a/pir/dev/screenshots/index.print.html +++ b/pir/dev/screenshots/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/index.html b/pir/index.html index 62acb3459b..77c50a0a51 100644 --- a/pir/index.html +++ b/pir/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/index.print.html b/pir/index.print.html index 9ae032a467..ef982017f5 100644 --- a/pir/index.print.html +++ b/pir/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/pir/index.search.js b/pir/index.search.js index a9461b300b..3e48bb6313 100644 --- a/pir/index.search.js +++ b/pir/index.search.js @@ -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.95.0 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n5.24.0.beta Change 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.\nNew Ye now can configure opt'ns fer every theme variant. This allows fer optional extended 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' extended 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' provide an extended way t' configure th' automatic switch o' variants based on 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 switch will be shown 'n th' menu footer. See th' documentat'n fer configurat'n.\nAvast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher 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 guessSyntax=true be set. 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.95.0 Th' minimum required Cap'n Hugo version.\nBreak'n A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.\nChange A change 'n default behavior that may requires act'n by ye if ye want t' revert it.\nNew Marks new behavior ye might find interest'n or comes configur'ble.\n5.24.0.beta Change 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.\nNew Ye now can configure opt'ns fer every theme variant. This allows fer optional extended 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' extended 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' provide an extended way t' configure th' automatic switch o' variants based on 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 guessSyntax=true be set. 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", "description": "", "tags": null, "title": "What's New", @@ -138,7 +138,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Global ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default).\nAvast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.\n​ 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: \"auto\", \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". Th' auto variant be somewhat special. See th' # opt'n fer themeVariantAuto below. # 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 = \"auto\" }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] # Th' color variants used fer auto mode. # Default: [ \"relearn-light\", \"relearn-dark\" ], overwritten by th' first # two non-auto opt'ns from themeVariant if existant. # Th' auto variant defines how yer ship adjusts t' yer selected OS sett'ns # fer light/dark mode. Th' first array element be th' variant fer light mode, # th' second fer dark mode. themeVariantAuto = [ \"relearn-light\", \"relearn-dark\" ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 but behaves # like any other plank fer all other functionality 'n Hugo. # 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" 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 branch 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 th' same 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.\nMathJax Th' MathJax configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Math fer additional documentat'n.\nExample MathJax be globally disabled. By default it won’t be boarded by any plank.\nOn plank “Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.\nYe also can dis'ble MathJax fer specific planks while globally enabled.\nMerrrmaid Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See Merrrmaid fer additional documentat'n.\nExample Merrrmaid be globally disabled. By default it won’t be boarded by any plank.\nOn plank “Architecture” ye coded some JavaScript t' dynamically generate a class diagram. Ye can set th' Merrrmaid parameters locally t' board mermaid on this plank.\nYe also can dis'ble Merrrmaid fer specific planks while globally enabled.\nHome Button Configurat'n If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure two parameters fer th' defined languages:\n[languages] [languages.en] ... [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 those params 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.\n", + "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: \"auto\", \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". Th' auto variant be somewhat special. See th' # opt'n fer themeVariantAuto below. # 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 = \"auto\" }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] # Th' color variants used fer auto mode. # Default: [ \"relearn-light\", \"relearn-dark\" ], overwritten by th' first # two non-auto opt'ns o' yer `themeVariant` opt'n if present. # Th' auto variant defines how yer ship adjusts t' yer selected OS sett'ns # fer light/dark mode. Th' first array element be th' variant fer light mode, # th' second fer dark mode. themeVariantAuto = [ \"relearn-light\", \"relearn-dark\" ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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 but behaves # like any other plank fer all other functionality 'n Hugo. # 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 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # 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" @@ -159,7 +159,15 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead follow this plank. You’d create a new partial 'n th' layouts/partials folder o' yer local project. This partial will have th' priority.\nThis theme defines th' follow'n partials :\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. Change th' Logo Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. Ye could use an img HTML tag an' reference an image created under th' static folder, or ye could paste a SVG definit'n!\nAvast Th' size o' th' logo will adapt automatically\nChange th' Favicon If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico respectively.\nAdditionally, if ye want yer ship t' use light \u0026 dark theme favicons that follow th' OS’ (and 'n some cases, th' browser’s) color scheme, add th' image files t' yer local static/images/ folder an' name them eg. favicon-light.svg and/or favicon-dark.svg respectively correspond'n t' yer file format. In case one o' th' files be miss'n, th' theme falls back t' eg. favicon.svg fer th' miss'n file. All supplied favicons must be o' th' same file format.\nArrr IE an' old browser versions do not support media queries, which be necessary fer th' light \u0026 dark theme favicon opt'n. If ye have requirements t' support IE and/or older browser versions, use one o' th' other opt'ns.\nIf no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.\nIf ye need t' change this default behavior, create a new file 'n layouts/partials/ named favicon.html. Then write someth'n like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003eChange 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; }Change th' Colors Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!\nYe can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.\nSingle Variant Set th' themeVariant value wit' th' name o' yer theme file. That’s it!\n[params] themeVariant = \"relearn-light\"In th' above example yer theme file has t' be named theme-relearn-light.css\nMultiple Variants Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer.\n[params] # Change default color scheme wit' a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Smarrrt Arrrse If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n, an' @import this stylesheet 'n yer color variant stylesheet. For an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.\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. That’s it.\nIf you’ve set multiple variants, ye can drop auto at any posit'n, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.\n[params] themeVariant = [ \"auto\", \"red\" ]If ye don’t configure anyth'n else, th' theme will use relearn-light fer light mode an' relearn-dark fer dark mode.\nIf ye don’t like that, ye can set themeVariantAuto. Th' first element be th' variant fer light mode, th' second fer dark mode\n[params] themeVariantAuto = [ \"learn\", \"neon\" ] Avast This be not supported fer Internet Explorer 11, which still displays 'n th' relearn-light variant.\nJavaScript Once a variant be fully boarded, either initially or by switch'n th' 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` });Roll yer Own If ye be not happy wit' th' shipped variants ye can either copy an' rename one o' th' shipped files from themes/hugo-theme-relearn/static/css t' static/css, edit them afterwards t' yer lik'n 'n a text editor an' configure th' themeVariant parameter 'n yer config.toml or just use th' interactive variant generator.\nOwn 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. T' provide this behavior t' th' user an' extend'n it fer his own shorrrtcodes this can be configured.\nSay 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.\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 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[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[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. 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[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[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\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\"\u003eChange 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, generate a rules highlight'n stylesheet an' configure yer installat'n accord'n t' Hugo’s documentat'n. Then, @import th' rules highlightn'n stylesheet 'n yer color variant stylesheet.\nFor an example, take a look into theme-relearn-light.css an' config.toml o' th' exampleSite.\nIf ye want t' reconfigure just th' rules highlight'n o' an exist'n color variant, ye need t' copy th' file t' yer site’s directory an' adjust it accordingly.\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[params] themeVariant = [ \"relearn-light\", \"relearn-dark\" ]ye now write it that way:\n[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. ", + "description": "", + "tags": null, + "title": "Brrrand'n", + "uri": "/pir/basics/branding/index.html" + }, + { + "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. ", "description": "", "tags": null, "title": "Customizat'n", @@ -167,7 +175,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 switch '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 switch 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 Graph Download variant Reset variant ", + "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 Graph Download variant Reset variant ", "description": "", "tags": null, "title": "Stylesheet generrrat'r", diff --git a/pir/more/credits/index.html b/pir/more/credits/index.html index 84d337df57..58ce87735b 100644 --- a/pir/more/credits/index.html +++ b/pir/more/credits/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/more/credits/index.print.html b/pir/more/credits/index.print.html index 0a8c26f72c..eb671494d8 100644 --- a/pir/more/credits/index.print.html +++ b/pir/more/credits/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/search.html b/pir/search.html index 4e79a73406..8ffb5ea03c 100644 --- a/pir/search.html +++ b/pir/search.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index 98ffd8c8ec..5aa8049882 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -26,20 +26,20 @@ 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 00337edaf4..a35a561bee 100644 --- a/pir/shortcodes/attachments/index.print.html +++ b/pir/shortcodes/attachments/index.print.html @@ -26,21 +26,21 @@ 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 b1c2b3cb18..54ba8f6307 100644 --- a/pir/shortcodes/badge/index.html +++ b/pir/shortcodes/badge/index.html @@ -30,20 +30,20 @@ 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 2c4ae1826b..4935e55330 100644 --- a/pir/shortcodes/badge/index.print.html +++ b/pir/shortcodes/badge/index.print.html @@ -30,21 +30,21 @@ 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 8a4847ec73..f330716908 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -28,20 +28,20 @@ Get Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n s - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/button/index.print.html b/pir/shortcodes/button/index.print.html index 5eebb44a55..faf36d16f2 100644 --- a/pir/shortcodes/button/index.print.html +++ b/pir/shortcodes/button/index.print.html @@ -28,21 +28,21 @@ Get Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n s - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 001d37c403..c1ea831ddc 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 cc3c024043..8f448b084c 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,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.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 4a424b4e24..a85e0e9c23 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 b34416a7ea..d4e1eefd9b 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 49026ba969..39a8f0fdbc 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 13c5e84fb2..293e5f7e42 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 9af78e926e..b519561c3d 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 00b6d4929c..fe3880b5d8 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 980220fda5..8184201c1b 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 a2475329b4..9d8ca2697d 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 2619d2b500..0d6329126c 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 45dd1e5610..f086f531f7 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 aa97d07af6..2a68b43e3b 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 a7b4a5d691..4c6aacc1a2 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 114a5afee6..6db32c0c2d 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 4770e8a148..87871e4b74 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/index.html b/pir/shortcodes/children/children-1/index.html index af8bc516c5..3f480e0a60 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/index.print.html b/pir/shortcodes/children/children-1/index.print.html index 480f634aad..27160bafb4 100644 --- a/pir/shortcodes/children/children-1/index.print.html +++ b/pir/shortcodes/children/children-1/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-2/index.html b/pir/shortcodes/children/children-2/index.html index 5c604e23e2..f24f1c429c 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-2/index.print.html b/pir/shortcodes/children/children-2/index.print.html index 86cc322e36..13cc460509 100644 --- a/pir/shortcodes/children/children-2/index.print.html +++ b/pir/shortcodes/children/children-2/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 7385d17ef3..159f768819 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/index.print.html b/pir/shortcodes/children/children-3/index.print.html index 984584ad89..1d4c479075 100644 --- a/pir/shortcodes/children/children-3/index.print.html +++ b/pir/shortcodes/children/children-3/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.html b/pir/shortcodes/children/children-3/test3/index.html index c0a66124fb..5f7b080389 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.print.html b/pir/shortcodes/children/children-3/test3/index.print.html index fc2d0ec494..68e60f715b 100644 --- a/pir/shortcodes/children/children-3/test3/index.print.html +++ b/pir/shortcodes/children/children-3/test3/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index 0bbffa545b..45fb4e2aa1 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-4/index.print.html b/pir/shortcodes/children/children-4/index.print.html index c8ee69f92f..d03ddf50ce 100644 --- a/pir/shortcodes/children/children-4/index.print.html +++ b/pir/shortcodes/children/children-4/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index 7a1f20d4c7..e279cad5db 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/index.print.html b/pir/shortcodes/children/index.print.html index 5c03460865..974a737a70 100644 --- a/pir/shortcodes/children/index.print.html +++ b/pir/shortcodes/children/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index e85d7dd963..3561179a96 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -27,20 +27,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/test/index.print.html b/pir/shortcodes/children/test/index.print.html index c5cb951e51..e4d3cdd4bf 100644 --- a/pir/shortcodes/children/test/index.print.html +++ b/pir/shortcodes/children/test/index.print.html @@ -27,21 +27,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index 66b07361c3..b2cee246db 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -40,20 +40,20 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + +
  • Requirrrements
  • Installat'n
  • Configurrrat'n
    • +
  • Brrrand'n
  • Customizat'n
  • Stylesheet generrrat'r
  • Topbarrr Modificat'n
    • @@ -605,13 +606,13 @@ No need t' press ye! setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/pir/shortcodes/expand/index.print.html b/pir/shortcodes/expand/index.print.html index cced2a47b5..a94182c79e 100644 --- a/pir/shortcodes/expand/index.print.html +++ b/pir/shortcodes/expand/index.print.html @@ -40,21 +40,21 @@ 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 231c88b0c5..d61a48d69f 100644 --- a/pir/shortcodes/highlight/index.html +++ b/pir/shortcodes/highlight/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/highlight/index.print.html b/pir/shortcodes/highlight/index.print.html index 0cfb4ce7f6..3602140f70 100644 --- a/pir/shortcodes/highlight/index.print.html +++ b/pir/shortcodes/highlight/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/icon/index.html b/pir/shortcodes/icon/index.html index e666cefb96..559703c8d7 100644 --- a/pir/shortcodes/icon/index.html +++ b/pir/shortcodes/icon/index.html @@ -28,20 +28,20 @@ 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 83f842f90c..9f823707c3 100644 --- a/pir/shortcodes/icon/index.print.html +++ b/pir/shortcodes/icon/index.print.html @@ -28,21 +28,21 @@ 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 8f3dc830af..1747e1b926 100644 --- a/pir/shortcodes/include/index.html +++ b/pir/shortcodes/include/index.html @@ -28,20 +28,20 @@ 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 dc1e6986f7..0585f55e9d 100644 --- a/pir/shortcodes/include/index.print.html +++ b/pir/shortcodes/include/index.print.html @@ -28,21 +28,21 @@ 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 b259abdcbe..0f39f628c8 100644 --- a/pir/shortcodes/index.html +++ b/pir/shortcodes/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/index.print.html b/pir/shortcodes/index.print.html index faf1a759f0..a9165570c3 100644 --- a/pir/shortcodes/index.print.html +++ b/pir/shortcodes/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/pir/shortcodes/math/index.html b/pir/shortcodes/math/index.html index 3979e9ca02..30cf0233db 100644 --- a/pir/shortcodes/math/index.html +++ b/pir/shortcodes/math/index.html @@ -30,20 +30,20 @@ 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 f9dc2055b9..547754dda2 100644 --- a/pir/shortcodes/math/index.print.html +++ b/pir/shortcodes/math/index.print.html @@ -30,21 +30,21 @@ 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 882d68c15c..5f2628fde4 100644 --- a/pir/shortcodes/mermaid/index.html +++ b/pir/shortcodes/mermaid/index.html @@ -30,20 +30,20 @@ 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 c018d931b3..5159dc9f37 100644 --- a/pir/shortcodes/mermaid/index.print.html +++ b/pir/shortcodes/mermaid/index.print.html @@ -30,21 +30,21 @@ 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 f70ee67876..2732cc20d1 100644 --- a/pir/shortcodes/notice/index.html +++ b/pir/shortcodes/notice/index.html @@ -30,20 +30,20 @@ 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 0a48b86b43..b99dca4e6c 100644 --- a/pir/shortcodes/notice/index.print.html +++ b/pir/shortcodes/notice/index.print.html @@ -30,21 +30,21 @@ 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 10edab2e0a..d174038626 100644 --- a/pir/shortcodes/openapi/index.html +++ b/pir/shortcodes/openapi/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + - + diff --git a/pir/shortcodes/openapi/index.print.html b/pir/shortcodes/openapi/index.print.html index 6ca20d43c8..8b502bdf55 100644 --- a/pir/shortcodes/openapi/index.print.html +++ b/pir/shortcodes/openapi/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - + + - + diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index 8d53afec92..e50ecc421d 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -28,20 +28,20 @@ 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 13f7c071ab..49906078d4 100644 --- a/pir/shortcodes/siteparam/index.print.html +++ b/pir/shortcodes/siteparam/index.print.html @@ -28,21 +28,21 @@ 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 7e192d54df..9a7b88365a 100644 --- a/pir/shortcodes/tab/index.html +++ b/pir/shortcodes/tab/index.html @@ -30,20 +30,20 @@ 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 0abfaf470d..4e23762992 100644 --- a/pir/shortcodes/tab/index.print.html +++ b/pir/shortcodes/tab/index.print.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/tabs/index.html b/pir/shortcodes/tabs/index.html index ecfdbcb2b4..855c7fe046 100644 --- a/pir/shortcodes/tabs/index.html +++ b/pir/shortcodes/tabs/index.html @@ -30,20 +30,20 @@ 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 a30dd556c5..f5178bbd67 100644 --- a/pir/shortcodes/tabs/index.print.html +++ b/pir/shortcodes/tabs/index.print.html @@ -30,21 +30,21 @@ hello. py sh c print("Hello World!") echo "Hello World!" printf( - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/showcase/index.html b/pir/showcase/index.html index a68fda9621..446cff2d05 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/showcase/index.print.html b/pir/showcase/index.print.html index 5dcbc55351..4110cb6fbb 100644 --- a/pir/showcase/index.print.html +++ b/pir/showcase/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/pir/sitemap.xml b/pir/sitemap.xml index e4dc61e353..311364ee97 100644 --- a/pir/sitemap.xml +++ b/pir/sitemap.xml @@ -102,6 +102,12 @@ + + https://McShelby.github.io/hugo-theme-relearn/pir/basics/branding/index.html + + + + https://McShelby.github.io/hugo-theme-relearn/pir/basics/customization/index.html diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index cf6d0747d5..334f4643d5 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/config/index.html b/pir/tags/config/index.html index 471a315ab6..8f400ab3b5 100644 --- a/pir/tags/config/index.html +++ b/pir/tags/config/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/config/index.xml b/pir/tags/config/index.xml index 9ba7a8c5cd..1d614de466 100644 --- a/pir/tags/config/index.xml +++ b/pir/tags/config/index.xml @@ -12,8 +12,8 @@ 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 - Global ship parameters On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default). -Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n. + On top o' Hugo&rsquo;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. +Avast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n. &#8203; 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.     diff --git a/pir/tags/content/index.html b/pir/tags/content/index.html index 40bbc2cae0..a05c9d2c07 100644 --- a/pir/tags/content/index.html +++ b/pir/tags/content/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index 49e24bc0c6..7caa865966 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -19,20 +19,20 @@ documentat'n :: Tagga :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/headless/index.html b/pir/tags/headless/index.html index d852e71453..7b2c9796c6 100644 --- a/pir/tags/headless/index.html +++ b/pir/tags/headless/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/index.html b/pir/tags/index.html index bb8668487d..77385c7348 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/its-hidden/index.html b/pir/tags/its-hidden/index.html index 622547cdd7..0a6ff03093 100644 --- a/pir/tags/its-hidden/index.html +++ b/pir/tags/its-hidden/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index 5844c03584..7d78292a6a 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index 6d1b5e4aee..e692a36c9d 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -19,20 +19,20 @@ tutorrrial :: Tagga :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/search.html b/search.html index b62c69171a..5b4e664b7f 100644 --- a/search.html +++ b/search.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index b7b07b36b8..0b1ad212df 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/attachments/index.print.html b/shortcodes/attachments/index.print.html index 5bf0ddb9f6..1273a5f187 100644 --- a/shortcodes/attachments/index.print.html +++ b/shortcodes/attachments/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/badge/index.html b/shortcodes/badge/index.html index dbdae3bac0..f356fb7cb3 100644 --- a/shortcodes/badge/index.html +++ b/shortcodes/badge/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/badge/index.print.html b/shortcodes/badge/index.print.html index bd6ad86435..b7630e8e66 100644 --- a/shortcodes/badge/index.print.html +++ b/shortcodes/badge/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index be6395008c..0f6f789004 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/button/index.print.html b/shortcodes/button/index.print.html index e0bf432188..a67c5663d9 100644 --- a/shortcodes/button/index.print.html +++ b/shortcodes/button/index.print.html @@ -24,21 +24,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.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 0e37f18062..c7eba6b072 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 ccded83a72..7a3caa9c8e 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,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.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 acea38a9be..4efac75f7a 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 3efcc6db3d..4596c759d5 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 333637a38f..6f62225733 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 d6356aa137..135c04d090 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 a5d86eb94e..6d08587b65 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,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 04a01bf4b9..9cfbaf8fb4 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,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 ae4ff821dd..42b242ee02 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 b6b148bc51..1476351322 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 2922d6e4fa..fa4549ff6a 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 39750e51e7..21413cf207 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + 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 335e2eed0f..74a1ad4600 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,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 555318e7bf..20fa2d5834 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,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index e0691281bd..040d852be9 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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 f64dd37b85..aaecf7fef3 100644 --- a/shortcodes/children/children-1/children-1-1/index.print.html +++ b/shortcodes/children/children-1/children-1-1/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index a16fb34963..76fa10a6a6 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-1/index.print.html b/shortcodes/children/children-1/index.print.html index f28abf3d05..9535979433 100644 --- a/shortcodes/children/children-1/index.print.html +++ b/shortcodes/children/children-1/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index 1592dc539a..f7c01772f9 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-2/index.print.html b/shortcodes/children/children-2/index.print.html index 1837f00c08..ad2da2ef76 100644 --- a/shortcodes/children/children-2/index.print.html +++ b/shortcodes/children/children-2/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index c6c06716cf..ba42bb3b18 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/index.print.html b/shortcodes/children/children-3/index.print.html index 68b3fc45eb..b9e0f94e79 100644 --- a/shortcodes/children/children-3/index.print.html +++ b/shortcodes/children/children-3/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-3/test3/index.html b/shortcodes/children/children-3/test3/index.html index c358a4dd48..7bae2c7e27 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-3/test3/index.print.html b/shortcodes/children/children-3/test3/index.print.html index 7077ac2166..6134f86b85 100644 --- a/shortcodes/children/children-3/test3/index.print.html +++ b/shortcodes/children/children-3/test3/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index ffd6dfbdc2..c9dab6c180 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/children-4/index.print.html b/shortcodes/children/children-4/index.print.html index 335a727929..6df960f051 100644 --- a/shortcodes/children/children-4/index.print.html +++ b/shortcodes/children/children-4/index.print.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index 7f04f3e289..47bbbdd785 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/index.print.html b/shortcodes/children/index.print.html index 39be6b0d1a..9916923db3 100644 --- a/shortcodes/children/index.print.html +++ b/shortcodes/children/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index c925acee1f..ef124c6edb 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -27,20 +27,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/children/test/index.print.html b/shortcodes/children/test/index.print.html index 8d384624c2..d6e79dbdcf 100644 --- a/shortcodes/children/test/index.print.html +++ b/shortcodes/children/test/index.print.html @@ -27,21 +27,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index ae01679bba..2f52ccb15e 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + +
  • Requirements
  • Installation
  • Configuration
    • +
  • Branding
  • Customization
  • Stylesheet generator
  • Topbar Modification
    • @@ -587,13 +588,13 @@ No need to press you! setTimeout( githubButtonsInit, 400 ); }); - + - - - + + + diff --git a/shortcodes/expand/index.print.html b/shortcodes/expand/index.print.html index 474a36ace1..591030426a 100644 --- a/shortcodes/expand/index.print.html +++ b/shortcodes/expand/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/highlight/index.html b/shortcodes/highlight/index.html index 4a2a9ae076..07750d4b58 100644 --- a/shortcodes/highlight/index.html +++ b/shortcodes/highlight/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/highlight/index.print.html b/shortcodes/highlight/index.print.html index bf0e6d7df7..ed09c19010 100644 --- a/shortcodes/highlight/index.print.html +++ b/shortcodes/highlight/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/icon/index.html b/shortcodes/icon/index.html index 09303ce922..2336e5db2c 100644 --- a/shortcodes/icon/index.html +++ b/shortcodes/icon/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/icon/index.print.html b/shortcodes/icon/index.print.html index ca55cec9d1..629beb4603 100644 --- a/shortcodes/icon/index.print.html +++ b/shortcodes/icon/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include/index.html b/shortcodes/include/index.html index 377df38dca..97e3c2a617 100644 --- a/shortcodes/include/index.html +++ b/shortcodes/include/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/include/index.print.html b/shortcodes/include/index.print.html index af4ad04b90..feff1e3312 100644 --- a/shortcodes/include/index.print.html +++ b/shortcodes/include/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/include_me/index.html b/shortcodes/include_me/index.html index dcc37d1709..b14a47d6d2 100644 --- a/shortcodes/include_me/index.html +++ b/shortcodes/include_me/index.html @@ -24,20 +24,20 @@ 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 e60d1c7757..8e20db2b87 100644 --- a/shortcodes/include_me/index.print.html +++ b/shortcodes/include_me/index.print.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/index.html b/shortcodes/index.html index 828b59f783..c5ad57ecb9 100644 --- a/shortcodes/index.html +++ b/shortcodes/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/index.print.html b/shortcodes/index.print.html index 3d26573092..1b43242f7c 100644 --- a/shortcodes/index.print.html +++ b/shortcodes/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/shortcodes/math/index.html b/shortcodes/math/index.html index 645fc85fcf..ff42ba37e3 100644 --- a/shortcodes/math/index.html +++ b/shortcodes/math/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + diff --git a/shortcodes/math/index.print.html b/shortcodes/math/index.print.html index 8439d794ea..bc2b78dd82 100644 --- a/shortcodes/math/index.print.html +++ b/shortcodes/math/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - + + diff --git a/shortcodes/mermaid/index.html b/shortcodes/mermaid/index.html index 3d1a8674e7..ad418c7d69 100644 --- a/shortcodes/mermaid/index.html +++ b/shortcodes/mermaid/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/mermaid/index.print.html b/shortcodes/mermaid/index.print.html index d693784bb7..864be2d7f5 100644 --- a/shortcodes/mermaid/index.print.html +++ b/shortcodes/mermaid/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/shortcodes/notice/index.html b/shortcodes/notice/index.html index bc86347e98..5a02ad7486 100644 --- a/shortcodes/notice/index.html +++ b/shortcodes/notice/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/notice/index.print.html b/shortcodes/notice/index.print.html index b346703488..9a40eae816 100644 --- a/shortcodes/notice/index.print.html +++ b/shortcodes/notice/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/openapi/index.html b/shortcodes/openapi/index.html index 7664ff1d27..167e5b5de2 100644 --- a/shortcodes/openapi/index.html +++ b/shortcodes/openapi/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - + + - - + + - + diff --git a/shortcodes/openapi/index.print.html b/shortcodes/openapi/index.print.html index f80c7fcfde..6413ad7571 100644 --- a/shortcodes/openapi/index.print.html +++ b/shortcodes/openapi/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + - - + + - + diff --git a/shortcodes/siteparam/index.html b/shortcodes/siteparam/index.html index b60bfa8068..b318f26cb7 100644 --- a/shortcodes/siteparam/index.html +++ b/shortcodes/siteparam/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/siteparam/index.print.html b/shortcodes/siteparam/index.print.html index 2cef3cd967..902155d959 100644 --- a/shortcodes/siteparam/index.print.html +++ b/shortcodes/siteparam/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tab/index.html b/shortcodes/tab/index.html index 382138c726..ad575a2e88 100644 --- a/shortcodes/tab/index.html +++ b/shortcodes/tab/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tab/index.print.html b/shortcodes/tab/index.print.html index 8cbfec5cdd..7979729863 100644 --- a/shortcodes/tab/index.print.html +++ b/shortcodes/tab/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/shortcodes/tabs/index.html b/shortcodes/tabs/index.html index f7dacba218..dd06b3d182 100644 --- a/shortcodes/tabs/index.html +++ b/shortcodes/tabs/index.html @@ -24,20 +24,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/shortcodes/tabs/index.print.html b/shortcodes/tabs/index.print.html index 12eaf502ab..1148d3c372 100644 --- a/shortcodes/tabs/index.print.html +++ b/shortcodes/tabs/index.print.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/showcase/index.html b/showcase/index.html index b76cf87af7..69c629d0b7 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -23,20 +23,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/showcase/index.print.html b/showcase/index.print.html index bca3da115e..c5d5ad23b4 100644 --- a/showcase/index.print.html +++ b/showcase/index.print.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + diff --git a/tags/children/index.html b/tags/children/index.html index f500bff937..2860563e04 100644 --- a/tags/children/index.html +++ b/tags/children/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/config/index.html b/tags/config/index.html index 4db1cf2fee..0102dd7ae3 100644 --- a/tags/config/index.html +++ b/tags/config/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/config/index.xml b/tags/config/index.xml index f2e8f85f31..6604c8ebcc 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 - Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default). -Note that some of these parameters are explained in details in other sections of this documentation. -&#8203; 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. + On top of Hugo&rsquo;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. +Note that some of these options are explained in detail in other sections of this documentation. +&#8203; 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. \ No newline at end of file diff --git a/tags/content/index.html b/tags/content/index.html index 4d16a54181..2752587fae 100644 --- a/tags/content/index.html +++ b/tags/content/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/documentation/index.html b/tags/documentation/index.html index f0f2dfea82..a54dc02ad0 100644 --- a/tags/documentation/index.html +++ b/tags/documentation/index.html @@ -19,20 +19,20 @@ documentation :: Tag :: Hugo Relearn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/headless/index.html b/tags/headless/index.html index b887285330..6bebf0d391 100644 --- a/tags/headless/index.html +++ b/tags/headless/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/index.html b/tags/index.html index ff622ab8f7..3d8d3e87e8 100644 --- a/tags/index.html +++ b/tags/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/its-hidden/index.html b/tags/its-hidden/index.html index d5f0280542..44af5c3166 100644 --- a/tags/its-hidden/index.html +++ b/tags/its-hidden/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/non-hidden/index.html b/tags/non-hidden/index.html index 260691a0a8..b66f2c275a 100644 --- a/tags/non-hidden/index.html +++ b/tags/non-hidden/index.html @@ -22,20 +22,20 @@ - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/tags/tutorial/index.html b/tags/tutorial/index.html index 5003d34600..135417d5fc 100644 --- a/tags/tutorial/index.html +++ b/tags/tutorial/index.html @@ -19,20 +19,20 @@ tutorial :: Tag :: Hugo Relearn Theme - + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + - - - + + +