From 4d4a9a239e2d7ebf334384e5772b6908fd89be5d Mon Sep 17 00:00:00 2001 From: McShelby Date: Mon, 14 Feb 2022 21:20:12 +0000 Subject: [PATCH] deploy: 9eb44953d9ed47bc9fc444ef2d3dbde5c5315f03 --- 404.html | 22 ++-- basics/changelog/index.html | 44 ++++---- basics/configuration/index.html | 48 ++++---- basics/customization/images/learn-variant.png | Bin 0 -> 135534 bytes .../images/standard-dark-variant.png | Bin 0 -> 135534 bytes basics/customization/index.html | 104 ++++++++++-------- basics/history/index.html | 44 ++++---- basics/index.html | 44 ++++---- basics/index.xml | 2 +- basics/installation/index.html | 44 ++++---- basics/migration/index.html | 65 ++++++----- basics/requirements/index.html | 44 ++++---- categories/index.html | 44 ++++---- cont/archetypes/index.html | 44 ++++---- cont/i18n/index.html | 44 ++++---- cont/icons/index.html | 44 ++++---- cont/index.html | 44 ++++---- cont/markdown/index.html | 44 ++++---- cont/menushortcuts/index.html | 44 ++++---- cont/pages/index.html | 44 ++++---- cont/syntaxhighlight/index.html | 44 ++++---- cont/tags/index.html | 44 ++++---- credits/index.html | 44 ++++---- css/theme.css | 58 +++++----- css/variant.css | 25 ++--- index.html | 44 ++++---- index.json | 6 +- pir/404.html | 22 ++-- pir/basics/configuration/index.html | 48 ++++---- pir/basics/customization/index.html | 102 +++++++++-------- pir/basics/history/index.html | 44 ++++---- pir/basics/index.html | 44 ++++---- pir/basics/installation/index.html | 44 ++++---- pir/basics/migration/index.html | 65 ++++++----- pir/basics/requirements/index.html | 44 ++++---- pir/categories/index.html | 44 ++++---- pir/cont/archetypes/index.html | 44 ++++---- pir/cont/i18n/index.html | 44 ++++---- pir/cont/icons/index.html | 44 ++++---- pir/cont/index.html | 44 ++++---- pir/cont/markdown/index.html | 44 ++++---- pir/cont/menushortcuts/index.html | 44 ++++---- pir/cont/pages/index.html | 44 ++++---- pir/cont/syntaxhighlight/index.html | 44 ++++---- pir/cont/tags/index.html | 44 ++++---- pir/credits/index.html | 44 ++++---- pir/index.html | 44 ++++---- pir/index.json | 6 +- pir/shortcodes/attachments/index.html | 44 ++++---- pir/shortcodes/button/index.html | 44 ++++---- .../children-1-1-1-1-1-1/index.html | 44 ++++---- .../children-1-1-1-1-1/index.html | 44 ++++---- .../children-1-1-1-1/index.html | 44 ++++---- .../children-1-1/children-1-1-1/index.html | 44 ++++---- .../children-1-1-2-1/index.html | 44 ++++---- .../children-1-1-2-2/index.html | 44 ++++---- .../children-1-1/children-1-1-2/index.html | 44 ++++---- .../children-1-1/children-1-1-3/index.html | 44 ++++---- .../children-1/children-1-1/index.html | 44 ++++---- pir/shortcodes/children/children-1/index.html | 44 ++++---- pir/shortcodes/children/children-2/index.html | 44 ++++---- pir/shortcodes/children/children-3/index.html | 44 ++++---- .../children/children-3/test3/index.html | 44 ++++---- pir/shortcodes/children/children-4/index.html | 44 ++++---- pir/shortcodes/children/index.html | 44 ++++---- pir/shortcodes/children/test/index.html | 44 ++++---- pir/shortcodes/expand/index.html | 44 ++++---- pir/shortcodes/include/index.html | 44 ++++---- pir/shortcodes/index.html | 44 ++++---- pir/shortcodes/mermaid/index.html | 44 ++++---- pir/shortcodes/notice/index.html | 44 ++++---- pir/shortcodes/siteparam/index.html | 44 ++++---- pir/shortcodes/tabs/index.html | 44 ++++---- pir/showcase/index.html | 44 ++++---- pir/tags/children/index.html | 44 ++++---- pir/tags/documentatn/index.html | 44 ++++---- pir/tags/hidden/index.html | 44 ++++---- pir/tags/index.html | 44 ++++---- pir/tags/non-hidden/index.html | 44 ++++---- pir/tags/tutorrrial/index.html | 44 ++++---- pir/yours/1/index.html | 44 ++++---- pir/yours/10/index.html | 44 ++++---- pir/yours/2/index.html | 44 ++++---- pir/yours/3/index.html | 44 ++++---- pir/yours/4/index.html | 44 ++++---- pir/yours/5/index.html | 44 ++++---- pir/yours/6/index.html | 44 ++++---- pir/yours/7/index.html | 44 ++++---- pir/yours/8/index.html | 44 ++++---- pir/yours/9/index.html | 44 ++++---- pir/yours/children-1/index.html | 44 ++++---- pir/yours/index.html | 44 ++++---- shortcodes/attachments/index.html | 44 ++++---- shortcodes/button/index.html | 44 ++++---- .../children-1-1-1-1-1-1/index.html | 44 ++++---- .../children-1-1-1-1-1/index.html | 44 ++++---- .../children-1-1-1-1/index.html | 44 ++++---- .../children-1-1/children-1-1-1/index.html | 44 ++++---- .../children-1-1-2-1/index.html | 44 ++++---- .../children-1-1-2-2/index.html | 44 ++++---- .../children-1-1/children-1-1-2/index.html | 44 ++++---- .../children-1-1/children-1-1-3/index.html | 44 ++++---- .../children-1/children-1-1/index.html | 44 ++++---- shortcodes/children/children-1/index.html | 44 ++++---- shortcodes/children/children-2/index.html | 44 ++++---- shortcodes/children/children-3/index.html | 44 ++++---- .../children/children-3/test3/index.html | 44 ++++---- shortcodes/children/children-4/index.html | 44 ++++---- shortcodes/children/index.html | 44 ++++---- shortcodes/children/test/index.html | 44 ++++---- shortcodes/expand/index.html | 44 ++++---- shortcodes/include/index.html | 44 ++++---- shortcodes/include_me/index.html | 44 ++++---- shortcodes/index.html | 44 ++++---- shortcodes/mermaid/index.html | 44 ++++---- shortcodes/notice/index.html | 44 ++++---- shortcodes/siteparam/index.html | 44 ++++---- shortcodes/tabs/index.html | 44 ++++---- showcase/index.html | 44 ++++---- tags/children/index.html | 44 ++++---- tags/documentation/index.html | 44 ++++---- tags/hidden/index.html | 44 ++++---- tags/index.html | 44 ++++---- tags/non-hidden/index.html | 44 ++++---- tags/tutorial/index.html | 44 ++++---- yours/1/index.html | 44 ++++---- yours/10/index.html | 44 ++++---- yours/11.de/index.html | 44 ++++---- yours/12.de/index.html | 44 ++++---- yours/13.de/index.html | 44 ++++---- yours/14.de/index.html | 44 ++++---- yours/15.de/index.html | 44 ++++---- yours/16.de/index.html | 44 ++++---- yours/17.de/index.html | 44 ++++---- yours/18.de/index.html | 44 ++++---- yours/19.de/index.html | 44 ++++---- yours/2/index.html | 44 ++++---- yours/20.de/index.html | 44 ++++---- yours/21.de/index.html | 44 ++++---- yours/22.de/index.html | 44 ++++---- yours/23.de/index.html | 44 ++++---- yours/24.de/index.html | 44 ++++---- yours/25.de/index.html | 44 ++++---- yours/26.de/index.html | 44 ++++---- yours/27.de/index.html | 44 ++++---- yours/28.de/index.html | 44 ++++---- yours/29.de/index.html | 44 ++++---- yours/3/index.html | 44 ++++---- yours/30.de/index.html | 44 ++++---- yours/4/index.html | 44 ++++---- yours/5/index.html | 44 ++++---- yours/6/index.html | 44 ++++---- yours/7/index.html | 44 ++++---- yours/8/index.html | 44 ++++---- yours/9/index.html | 44 ++++---- yours/children-1/index.html | 44 ++++---- yours/index.html | 44 ++++---- 157 files changed, 3434 insertions(+), 3387 deletions(-) create mode 100644 basics/customization/images/learn-variant.png create mode 100644 basics/customization/images/standard-dark-variant.png diff --git a/404.html b/404.html index 736657b0c0..8971f143f5 100644 --- a/404.html +++ b/404.html @@ -8,16 +8,16 @@ 404 Page not found :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + - + @@ -112,9 +112,9 @@ - - - + + +
- - - + + +
- - - + + +
    @@ -260,6 +260,8 @@
  • Change default colors
    • Standard variant
      • +
    • Standard dark variant
      • +
    • Learn variant
    • Red variant
    • Blue variant
    • Green variant
      • @@ -281,20 +283,20 @@

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

      This theme defines the following partials :

        -
      • content: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content.
        • -
      • header: the header of the content page (contains the breadcrumbs). Not meant to be overwritten
        • -
      • custom-header: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file
        • -
      • footer: the footer of the content page (contains the arrows). Not meant to be overwritten
        • -
      • custom-footer: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file
        • -
      • favicon: the favicon
        • -
      • logo: the logo, on top left hand corner.
        • -
      • meta: HTML meta tags, if you want to change default behavior
        • -
      • menu: left menu. Not meant to be overwritten
        • -
      • menu-pre: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account.
        • -
      • menu-post: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account.
        • -
      • menu-footer: footer of the the left menu
        • -
      • search: search box
        • -
      • toc: table of contents
        • +
      • content.html: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content.
        • +
      • header.html: the header of the content page (contains the breadcrumbs). 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
        • +
      • footer.html: the footer of the content page (contains the arrows). Not meant to be overwritten
        • +
      • custom-footer.html: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file
        • +
      • favicon.html: the favicon
        • +
      • logo.html: the logo, on top left hand corner
        • +
      • meta.html: HTML meta tags, if you want to change default behavior
        • +
      • menu.html: left menu. Not meant to be overwritten
        • +
      • menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account.
        • +
      • menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account.
        • +
      • menu-footer.html: footer of the the left menu
        • +
      • search.html: search box. Not meant to be overwritten
        • +
      • toc.html: table of contents

      Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. @@ -313,22 +315,32 @@ You could use an img HTML tag and reference an image created under

      The Relearn theme let you choose between some predefined color scheme variants, but feel free to add one yourself!

      Standard variant

      [params]
-  # Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
-  themeVariant = ""
-

      Red variant

      + # Change default color scheme with a variant one. + themeVariant = "" # or themeVariant = "relearn" or themeVariant = "relearn-light" +

Standard variant

+

Standard dark variant

+
[params]
+  # Change default color scheme with a variant one.
+  themeVariant = "relearn-dark"
+

Dark variant

+

Learn variant

+
[params]
+  # Change default color scheme with a variant one.
+  themeVariant = "learn"
+

Learn variant

Red variant

[params]
-  # Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme with a variant one.
   themeVariant = "red"

Red variant

Blue variant

[params]
-  # Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme with a variant one.
   themeVariant = "blue"

Blue variant

Green variant

[params]
-  # Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme with a variant one.
   themeVariant = "green"

Green variant

‘Mine‘ variant

@@ -372,13 +384,13 @@ You could use an img HTML tag and reference an image created under }

Then, set the themeVariant value with the name of your custom theme file. That’s it!

[params]
-  # Change default color scheme with a variant one. Can be "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme with a variant one.
   themeVariant = "mine"

Multiple variants

-

You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme selector will be shown in the menu footer.

+

You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme switch will be shown in the menu footer.

[params]
-  # Change default color scheme with a variant one. Can be empty, "red", "blue", "green"  or an array like [ "blue", "green" ].
-  themeVariant = [ "red", "blue ]
+  # Change default color scheme with a variant one.
+  themeVariant = [ "relearn-light", "relearn-dark" ]
@@ -392,18 +404,18 @@ You could use an img HTML tag and reference an image created under
- - - - - - - + + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index 6f95444cda..b1f93edf45 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -9,16 +9,16 @@ History :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@ - - - + + +
    @@ -725,18 +725,18 @@
    - - - - - - - + + + + + + + - + diff --git a/basics/index.html b/basics/index.html index 1d4445f3a9..8176573e1e 100644 --- a/basics/index.html +++ b/basics/index.html @@ -9,16 +9,16 @@ Basics :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -272,18 +272,18 @@
    - - - - - - - + + + + + + + - + diff --git a/basics/index.xml b/basics/index.xml index 598941e032..f9c70bf949 100644 --- a/basics/index.xml +++ b/basics/index.xml @@ -53,7 +53,7 @@ Note that some of these parameters are explained in details in other sections of 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’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. This theme defines the following partials : - content: the content page itself. + content. History diff --git a/basics/installation/index.html b/basics/installation/index.html index 42c78a8691..14654e97bd 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -9,16 +9,16 @@ Installation :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -338,18 +338,18 @@ hugo new basics/second-content/_index.md
    - - - - - - - + + + + + + + - + diff --git a/basics/migration/index.html b/basics/migration/index.html index 0512e992e2..cc15c7d05c 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -9,16 +9,16 @@ What's new :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -285,11 +285,24 @@

    3.0.0

    • -

      Breaking: We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to provide additional styling in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.

      +

      Breaking: We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to provide additional styling in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.

      This 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).

    • -

      New: You can now set multiple color variants. In this case, the first variant is the default, choosen on first view and a theme selector will be shown in the menu footer. See the documentation for configuration.

      +

      Breaking: We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light greem menu header) as used in the official documentation.

      +

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

      +

      Note, that this will also affect your site if viewed with Internet Explorer 11 and can not reconfigured as it does not support CSS variables.

      +
      • +
    • +

      Change: Due to a bug, that we couldn’t fix in a general manner for all configurations, we decided to remove --MENU-SEARCH-BOX-ICONS-color.

      +
      • +
    • +

      New: With this release 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 apropriate default values are used by the theme. Nevertheless, the new colors allow for much more customization.

      +

      This feature was implemented to let the theme support dark color variants.

      +
      • +
    • +

      New: You can now configure multiple color variants in your config.toml. In this case, the first variant is the default, choosen on first view and a theme switch will be shown in the menu footer. See the documentation for configuration.

      +

      Note, that the new theme switch will not work with Internet Explorer 11 as it does not support CSS variables.

    2.9.0

    @@ -390,7 +403,7 @@

    2.5.0

      -
    • Change: Add new colors --MAIN-CODE-color and --MAIN-CODE-BG-color for syntax highlightning fallback in your stylesheet in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style.
      • +
    • Change: Add new colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color for a fallback of syntax highlightning in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style.

    2.4.0

    @@ -420,7 +433,7 @@

    2.1.0

    • -

      Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in exampleSite), they will now be ignored by the search.

      +

      Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search.

    • New: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.

      @@ -489,18 +502,18 @@
      - - - - - - - + + + + + + + - + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 0023aaf7ed..5800c4d5da 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -9,16 +9,16 @@ Requirements :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -272,18 +272,18 @@
    - - - - - - - + + + + + + + - + diff --git a/categories/index.html b/categories/index.html index 4eebeb05a2..ec463cb8e7 100644 --- a/categories/index.html +++ b/categories/index.html @@ -9,16 +9,16 @@ Categories :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -267,18 +267,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index a120294f73..c68e9a52a8 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -8,16 +8,16 @@ Archetypes :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -309,18 +309,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 07b4b38323..fdbc4a3ca2 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -9,16 +9,16 @@ Multilingual and i18n :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -339,18 +339,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/icons/index.html b/cont/icons/index.html index e76d9524f2..ca00649cfc 100644 --- a/cont/icons/index.html +++ b/cont/icons/index.html @@ -8,16 +8,16 @@ Icons and logos :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -300,18 +300,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/index.html b/cont/index.html index cfc56fd34d..a97c9a81b0 100644 --- a/cont/index.html +++ b/cont/index.html @@ -9,16 +9,16 @@ Content :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -272,18 +272,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 94b2e9187e..18e215ba8c 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -8,16 +8,16 @@ Markdown syntax :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -819,18 +819,18 @@ grunt.initConfig({
    - - - - - - - + + + + + + + - + diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index 3cf42ca299..cc53908ffd 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -8,16 +8,16 @@ Menu extra shortcuts :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -387,18 +387,18 @@ However, if you want to keep the title but change its value, it can be overriden
    - - - - - - - + + + + + + + - + diff --git a/cont/pages/index.html b/cont/pages/index.html index 885ecdd21e..7a8619d14b 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -9,16 +9,16 @@ Pages organization :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -418,18 +418,18 @@ We’ve added the menuTitle parameter for that purpose:

    - - - - - - - + + + + + + + - + diff --git a/cont/syntaxhighlight/index.html b/cont/syntaxhighlight/index.html index c9dbf1ae4c..51ca5d2f36 100644 --- a/cont/syntaxhighlight/index.html +++ b/cont/syntaxhighlight/index.html @@ -8,16 +8,16 @@ Code highlighting :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -325,18 +325,18 @@
    - - - - - - - + + + + + + + - + diff --git a/cont/tags/index.html b/cont/tags/index.html index 09f7fcdd4c..646a87d64d 100644 --- a/cont/tags/index.html +++ b/cont/tags/index.html @@ -8,16 +8,16 @@ Tags :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -301,18 +301,18 @@
    - - - - - - - + + + + + + + - + diff --git a/credits/index.html b/credits/index.html index f160932f25..76dbb32445 100644 --- a/credits/index.html +++ b/credits/index.html @@ -8,16 +8,16 @@ Credits :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -111,9 +111,9 @@
- - - + + +
    @@ -285,18 +285,18 @@
    - - - - - - - + + + + + + + - + diff --git a/css/theme.css b/css/theme.css index a6050c8e78..dfef2e50d0 100644 --- a/css/theme.css +++ b/css/theme.css @@ -40,7 +40,7 @@ body { background-color: #ffffff; /* var(--MAIN-BG-color) */ - color: #777777; /* var(--MAIN-TEXT-color) */ + color: #101010; /* var(--MAIN-TEXT-color) */ font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; font-size: 16.25px; font-weight: 300; @@ -63,12 +63,12 @@ body #chapter h1 { a, #toc-menu { - color: #00bdf3; /* var(--MAIN-LINK-color) */ + color: #486ac9; /* var(--MAIN-LINK-color) */ } a:hover, #toc-menu:hover { - color: #0082a7; /* var(--MAIN-LINK-HOVER-color) */ + color: #134fbf; /* var(--MAIN-LINK-HOVER-color) */ } pre { @@ -89,7 +89,7 @@ th { } #sidebar { - background-color: #322A38; /* var(--MENU-SECTIONS-BG-color) */ + background-color: #282830; /* var(--MENU-SECTIONS-BG-color) */ bottom: 0; display: flex; flex-direction: column; @@ -102,10 +102,10 @@ th { } #header-wrapper { - background-color: #8451a1; /* var(--MENU-HEADER-BG-color) */ - color: #ffffff; /* var(--MENU-SEARCH-color) */ + background-color: #7dc903; /* var(--MENU-HEADER-BG-color) */ + color: #efefef; /* var(--MENU-SEARCH-color) */ text-align: center; - border-bottom: 4px solid #9c6fb6; /* var(--MENU-HEADER-BORDER-color) */ + border-bottom: 4px solid #7dc903; /* var(--MENU-HEADER-BORDER-color) */ padding: 1rem; position: relative; } @@ -115,9 +115,9 @@ th { } .searchbox { - border: 1px solid #915eae; /* var(--MENU-SEARCH-BOX-color) */ + border: 1px solid #efefef; /* var(--MENU-SEARCH-BOX-color) */ border-radius: 4px; - background-color: #764890; /* var(--MENU-SEARCH-BG-color) */ + background-color: #3d414d; /* var(--MENU-SEARCH-BG-color) */ position: relative; margin-top: 1rem; } @@ -168,11 +168,11 @@ th { } #sidebar a { - color: #cccccc; /* var(--MENU-SECTIONS-LINK-color) */ + color: #bababa; /* var(--MENU-SECTIONS-LINK-color) */ } #sidebar a:hover { - color: #e6e6e6; /* var(--MENU-SECTIONS-LINK-HOVER-color) */ + color: #ffffff; /* var(--MENU-SECTIONS-LINK-HOVER-color) */ } #sidebar a.padding { @@ -226,7 +226,7 @@ th { } #sidebar ul.topics > li.parent { - background-color: #251f29; /* var(--MENU-SECTIONS-ACTIVE-BG-color) */ + background-color: #202028; /* var(--MENU-SECTIONS-ACTIVE-BG-color) */ margin-left: -1rem; margin-right: -1rem; padding-left: 1rem; @@ -235,7 +235,7 @@ th { #sidebar ul li.active > a { background-color: #ffffff; /* var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color) */ - color: #777777; /* var(--MENU-SECTION-ACTIVE-CATEGORY-color) */ + color: #444444; /* var(--MENU-SECTION-ACTIVE-CATEGORY-color) */ margin-left: -1rem; margin-right: -1rem; padding-left: 1rem; @@ -295,12 +295,12 @@ th { } #sidebar ul li.visited > a .read-icon { - color: #00bdf3; /* var(--MENU-VISITED-color) */ + color: #506397; /* var(--MENU-VISITED-color) */ display: inline; } #sidebar .nav-title { - color: #e6e6e6; /* var(--MENU-SECTIONS-LINK-HOVER-color) */ + color: #ffffff; /* var(--MENU-SECTIONS-LINK-HOVER-color) */ font-size: 2rem; font-weight: 200; letter-spacing: -1px; @@ -316,12 +316,12 @@ th { } #sidebar hr { - border-bottom: 1px solid #2a232f; /* var(--MENU-SECTION-HR-color) */ + border-bottom: 1px solid #606060; /* var(--MENU-SECTION-HR-color) */ margin: 1.5rem 1rem 1rem 1rem; } #footer { - color: #cccccc; /* var(--MENU-SECTIONS-LINK-color) */ + color: #bababa; /* var(--MENU-SECTIONS-LINK-color) */ } #body { @@ -464,7 +464,7 @@ th { } h2, h3, h4, h5, h6 { - color: #5e5e5e; /* var(--MAIN-TITLES-TEXT-color) */ + color: #444753; /* var(--MAIN-TITLES-TEXT-color) */ font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; letter-spacing: -1px; text-rendering: optimizeLegibility; @@ -712,10 +712,10 @@ code.copy-to-clipboard-inline { } pre { - background-color: #272822; /* var(--CODE-BLOCK-BG-color) */ - border: 1px solid #272822; /* var(--CODE-BLOCK-BORDER-color) */ + background-color: #f8f8f8; /* var(--CODE-BLOCK-BG-color) */ + border: 1px solid #d8d8d8; /* var(--CODE-BLOCK-BORDER-color) */ border-radius: 2px; - color: #f8f8f2; /* var(--CODE-BLOCK-color) */ + color: #000000; /* var(--CODE-BLOCK-color) */ -webkit-print-color-adjust: economy; color-adjust: economy; line-height: 1.15; @@ -1059,9 +1059,9 @@ a[aria-disabled="true"] { /* using our MAIN-TEXT and MAIN-BG colors here hopefully asserts for enough contrast */ pre .copy-to-clipboard { background-color: #ffffff; /* var(--MAIN-BG-color) */ - border-color: #272822; /* var(--MAIN-TEXT-color) */ + border-color: #101010; /* var(--MAIN-TEXT-color) */ border-radius: 2px; - color: #777777; /* var(--MAIN-TEXT-color) */ + color: #101010; /* var(--MAIN-TEXT-color) */ font-size: 120%; opacity: .5; padding: 5px 3px 5px 25px; @@ -1071,23 +1071,23 @@ pre .copy-to-clipboard { } pre .copy-to-clipboard:hover { - background-color: #777777; /* var(--MAIN-TEXT-color) */ + background-color: #101010; /* var(--MAIN-TEXT-color) */ color: #ffffff; /* var(--MAIN-BG-color) */ opacity: .5; } #homelinks { - background-color: #9c6fb6; /* var(--MENU-HEADER-BORDER-color) */ - border-bottom: 4px solid #9c6fb6; /* var(--MENU-HEADER-BORDER-color) */ + background-color: #7dc903; /* var(--MENU-HEADER-BORDER-color) */ + border-bottom: 4px solid #7dc903; /* var(--MENU-HEADER-BORDER-color) */ padding: 7px 0; } #homelinks a { - color: #cccccc /* var(--MENU-HOME-LINK-color) */ + color: #323232 /* var(--MENU-HOME-LINK-color) */ } #homelinks a:hover { - color: #e6e6e6 /* var(--MENU-HOME-LINK-HOVER-color) */; + color: #808080 /* var(--MENU-HOME-LINK-HOVER-color) */; } option { @@ -1307,7 +1307,7 @@ option { /* anchors */ .anchor { - color: #00bdf3; /* var(--MAIN-ANCHOR-color) */ + color: #486ac9; /* var(--MAIN-ANCHOR-color) */ cursor: pointer; font-size: .5em; margin-left: .66em; diff --git a/css/variant.css b/css/variant.css index 6b48a9c176..01e2daa401 100644 --- a/css/variant.css +++ b/css/variant.css @@ -20,7 +20,7 @@ a:hover, #header-wrapper { background-color: var(--MENU-HEADER-BG-color); - color: var(--MENU-SEARCH-color, #ffffff); + color: var(--MENU-SEARCH-color, #efefef); border-color: var(--MENU-HEADER-BORDER-color); } @@ -44,8 +44,7 @@ a:hover, #sidebar ul li.active > a { background-color: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color); - color: var(-- - ); + color: var(--MENU-SECTION-ACTIVE-CATEGORY-color); } #sidebar ul li.visited > a .read-icon { @@ -85,15 +84,15 @@ div.attachments.neutral > div.label { } code { - background-color: var(--CODE-INLINE-BG-color, #fff7dd); - border-color: var(--CODE-INLINE-BORDER-color, #fbf0cb); + background-color: var(--CODE-INLINE-BG-color, #fffae9); + border-color: var(--CODE-INLINE-BORDER-color, #f8e8c8); color: var(--CODE-INLINE-color, #5e5e5e); } pre { - background-color: var(--CODE-BLOCK-BG-color, var(--MAIN-CODE-BG-color, #282a36)); - border-color: var(--CODE-BLOCK-BORDER-color, var(--MAIN-CODE-BG-color, #282a36)); - color: var(--CODE-BLOCK-color, var(--MAIN-CODE-color, #e2e4e5)); + background-color: var(--CODE-BLOCK-BG-color, var(--MAIN-CODE-BG-color, #f8f8f8)); + border-color: var(--CODE-BLOCK-BORDER-color, var(--MAIN-CODE-BG-color, #f8f8f8)); + color: var(--CODE-BLOCK-color, var(--MAIN-CODE-color, #000000)); } div.featherlight .featherlight-content{ @@ -105,14 +104,14 @@ div.featherlight .featherlight-content{ } .copy-to-clipboard { - background-color: var(--CODE-INLINE-BG-color, #fff7dd); - border-color: var(--CODE-INLINE-BORDER-color, #fbf0cb); + background-color: var(--CODE-INLINE-BG-color, #fffae9); + border-color: var(--CODE-INLINE-BORDER-color, #f8e8c8); color: var(--CODE-INLINE-color, #5e5e5e); } .copy-to-clipboard:hover { background-color: var(--CODE-INLINE-color, #5e5e5e); - color: var(--CODE-INLINE-BG-color, #fff7dd); + color: var(--CODE-INLINE-BG-color, #fffae9); } /* using our MAIN-TEXT and MAIN-BG colors here hopefully asserts for enough contrast */ @@ -133,11 +132,11 @@ pre .copy-to-clipboard:hover { } #homelinks a { - color: var(--MENU-HOME-LINK-color, #cccccc); + color: var(--MENU-HOME-LINK-color, #323232); } #homelinks a:hover { - color: var(--MENU-HOME-LINK-HOVER-color, var(--MENU-HOME-LINK-HOVERED-color, #e6e6e6)); + color: var(--MENU-HOME-LINK-HOVER-color, var(--MENU-HOME-LINK-HOVERED-color, #808080)); } .anchor { diff --git a/index.html b/index.html index 37367b0e1b..c1abf45078 100644 --- a/index.html +++ b/index.html @@ -9,16 +9,16 @@ Relearn Theme for Hugo :: Documentation for Hugo Relearn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -287,18 +287,18 @@
    - - - - - - - + + + + + + + - + diff --git a/index.json b/index.json index f7e109445a..feb2c7ec34 100644 --- a/index.json +++ b/index.json @@ -21,7 +21,7 @@ "uri": "/hugo-theme-relearn/cont/" }, { - "content": "This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.\nBreaking: A change that requires action by you after upgrading to assure the site is still functional.\nChange: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.\nNew: Marks new behavior you might find interesting or comes configurable.\n 3.0.0 Breaking: We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to provide additional styling 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).\n New: You can now set multiple color variants. In this case, the first variant is the default, choosen on first view and a theme selector will be shown in the menu footer. See the documentation for configuration.\n 2.9.0 Breaking: This release removes the themes implementation of ref/relref in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.\nIn a standard complient form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\n Type Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configuration Leaf bundle basics/configuration/index.md basics/configuration Page basics/configuration.md basics/configuration If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": page not found In this case, you must apply one of two options:\n Copy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.\n Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all *.md files. This is the recommended choice.\n Type Search Replace by Branch bundle (ref\\s+\"[^\"]*)/_index\\.md\" $1\" Leaf bundle (ref\\s+\"[^\"]*)/index\\.md\" $1\" Page (ref\\s+\"[^\"]*)\\.md\" $1\" 2.8.0 Change: Although never officially documented, this release removes the font Novacento/Novecento from the release. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.\n New: The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\n New: You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.\n 2.7.0 New: Optional second parameter for notice shortcode to set title in box header. 2.6.0 New: Your site can now be served from a subfolder if you set baseURL and canonifyURLs=true in your config.toml. See the documentation for a detailed example. 2.5.0 Change: Add new colors --MAIN-CODE-color and --MAIN-CODE-BG-color for syntax highlightning fallback in your stylesheet in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style. 2.4.0 Change: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The documentation was adjusted accordingly.\n New: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.\n New: You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\n New: New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\n New: Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n 2.2.0 New: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your config.toml. 2.1.0 Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in exampleSite), they will now be ignored by the search.\n New: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.\n New: If a search term is found in an expand shortcode, the expand will be opened.\n New: The menu will scroll the active item into view on load.\n 2.0.0 Change: Syntaxhighlightning was switched to built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as describedd on in the Hugo documentation\n Change: In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color.\n Change: --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets.\n Change: Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\n Change: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\n Change: A page without a title will be treated as hidden=true.\n New: You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\n New: New partials for defining pre/post content for menu items and the content. See documentation for further reading.\n New: Shortcode children with new parameter containerstyle.\n New: New shortcode include to include arbitrary file content into a page.\n 1.2.0 New: Shortcode expand with new parameter to open on page load. 1.1.0 New: Mermaid config options can be set in config.toml. ", + "content": "This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.\nBreaking: A change that requires action by you after upgrading to assure the site is still functional.\nChange: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.\nNew: Marks new behavior you might find interesting or comes configurable.\n 3.0.0 Breaking: We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to provide additional styling 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).\n Breaking: We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light greem 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 and can not reconfigured as it does not support CSS variables.\n Change: Due to a bug, that we couldn’t fix in a general manner for all configurations, we decided to remove --MENU-SEARCH-BOX-ICONS-color.\n New: With this release 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 apropriate default values are used by the theme. Nevertheless, the new colors allow for much more customization.\nThis feature was implemented to let the theme support dark color variants.\n New: You can now configure multiple color variants in your config.toml. In this case, the first variant is the default, choosen on first view and a theme switch will be shown in the menu footer. See the documentation for configuration.\nNote, that the new theme switch will not work with Internet Explorer 11 as it does not support CSS variables.\n 2.9.0 Breaking: This release removes the themes implementation of ref/relref in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.\nIn a standard complient form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\n Type Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configuration Leaf bundle basics/configuration/index.md basics/configuration Page basics/configuration.md basics/configuration If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.\nIn the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.\nYou may see errors on the console after the update in the form:\nERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref \"basics/configuration/_index.md\": \"hugo-theme-relearn\\exampleSite\\content\\_index.en.md:19:22\": page not found In this case, you must apply one of two options:\n Copy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.\n Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all *.md files. This is the recommended choice.\n Type Search Replace by Branch bundle (ref\\s+\"[^\"]*)/_index\\.md\" $1\" Leaf bundle (ref\\s+\"[^\"]*)/index\\.md\" $1\" Page (ref\\s+\"[^\"]*)\\.md\" $1\" 2.8.0 Change: Although never officially documented, this release removes the font Novacento/Novecento from the release. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.\n New: The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\n New: You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.\n 2.7.0 New: Optional second parameter for notice shortcode to set title in box header. 2.6.0 New: Your site can now be served from a subfolder if you set baseURL and canonifyURLs=true in your config.toml. See the documentation for a detailed example. 2.5.0 Change: Add new colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color for a fallback of syntax highlightning in case guessSyntax=true is set. Ideally they are set to the same values as the ones from your chosen chroma style. 2.4.0 Change: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The documentation was adjusted accordingly.\n New: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.\n New: You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\n New: New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\n New: Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n 2.2.0 New: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your config.toml. 2.1.0 Change: In case the site’s structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search.\n New: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.\n New: If a search term is found in an expand shortcode, the expand will be opened.\n New: The menu will scroll the active item into view on load.\n 2.0.0 Change: Syntaxhighlightning was switched to built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as describedd on in the Hugo documentation\n Change: In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color.\n Change: --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets.\n Change: Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\n Change: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\n Change: A page without a title will be treated as hidden=true.\n New: You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\n New: New partials for defining pre/post content for menu items and the content. See documentation for further reading.\n New: Shortcode children with new parameter containerstyle.\n New: New shortcode include to include arbitrary file content into a page.\n 1.2.0 New: Shortcode expand with new parameter to open on page load. 1.1.0 New: Mermaid config options can be set in config.toml. ", "description": "", "tags": null, "title": "What's new", @@ -94,7 +94,7 @@ "uri": "/hugo-theme-relearn/cont/syntaxhighlight/" }, { - "content": "Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) in the # menu; if no setting is given, the first menu level is set to false, all others to true; # this can be overridden in the pages frontmatter alwaysopen = true # Prefix URL to edit current page. Will display an \"Edit this page\" button on top right hand corner of every page. # Useful to give opportunity to people to create merge request for your doc. # See the config.toml file from this documentation site to have an example. editURL = \"\" # Author of the site, will be used in meta information author = \"\" # Description of the site, will be used in meta information description = \"\" # Shows a checkmark for visited pages on the menu showVisitedLinks = false # Disable search function. It will hide search bar disableSearch = false # Disable search in hidden pages, otherwise they will be shown in search box disableSearchHiddenPages = false # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden disableTagHiddenPages = false # Javascript and CSS cache are automatically busted when new version of site is generated. # Set this to true to disable this behavior (some proxies don't handle well this optimization) disableAssetsBusting = false # Set this to true to disable copy-to-clipboard button for inline code. disableInlineCopyToClipBoard = false # A title for shortcuts in menu is set by default. Set this to true to disable it. disableShortcutsTitle = false # If set to false, a Home button will appear below the search bar on the menu. # It is redirecting to the landing page of the current language if specified. (Default is \"/\") disableLandingPageButton = true # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs in the header and only show the current page title disableBreadcrumb = true # If set to true, hide table of contents menu in the header of all pages disableToc = false # If set to true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic) disableMermaid = false # Specifies the remote location of the Mermaid js customMermaidURL = \"https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js\" # Initialization parameter for Mermaid, see Mermaid documentation mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # Hide Next and Previous page buttons normally displayed full height beside content disableNextPrev = true # Order sections in menu by \"weight\" or \"title\". Default to \"weight\"; # this can be overridden in the pages frontmatter ordersectionsby = \"weight\" # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"\" # Provide a list of custom css files to load relative from the `static/` folder in the site root. custom_css = [\"css/foo.css\", \"css/bar.css\"] # Change the title separator. Default to \"::\". titleSeparator = \"-\" A word on running your site in a subfolder The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nActivate search If not already present, add the follow lines in the same config.toml file.\n[outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.\n Hugo generate lunrjs index.json at the root of public folder. When you build the site with hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem\n Mermaid The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.\n Example:\nMermaid is globally disabled. By default it won’t be loaded by any page. On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).\n You also can disable Mermaid for specific pages while globally enabled.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:\n[Languages] [Languages.en] ... landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Languages.pir] ... landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ... If those params are not configured for a specific language, they will get their default values:\nlandingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" The home button is going to look like this:\n", + "content": "Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) in the # menu; if no setting is given, the first menu level is set to false, all others to true; # this can be overridden in the pages frontmatter alwaysopen = true # Prefix URL to edit current page. Will display an \"Edit this page\" button on top right hand corner of every page. # Useful to give opportunity to people to create merge request for your doc. # See the config.toml file from this documentation site to have an example. editURL = \"\" # Author of the site, will be used in meta information author = \"\" # Description of the site, will be used in meta information description = \"\" # Shows a checkmark for visited pages on the menu showVisitedLinks = false # Disable search function. It will hide search bar disableSearch = false # Disable search in hidden pages, otherwise they will be shown in search box disableSearchHiddenPages = false # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden disableTagHiddenPages = false # Javascript and CSS cache are automatically busted when new version of site is generated. # Set this to true to disable this behavior (some proxies don't handle well this optimization) disableAssetsBusting = false # Set this to true to disable copy-to-clipboard button for inline code. disableInlineCopyToClipBoard = false # A title for shortcuts in menu is set by default. Set this to true to disable it. disableShortcutsTitle = false # If set to false, a Home button will appear below the search bar on the menu. # It is redirecting to the landing page of the current language if specified. (Default is \"/\") disableLandingPageButton = true # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs in the header and only show the current page title disableBreadcrumb = true # If set to true, hide table of contents menu in the header of all pages disableToc = false # If set to true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic) disableMermaid = false # Specifies the remote location of the Mermaid js customMermaidURL = \"https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js\" # Initialization parameter for Mermaid, see Mermaid documentation mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # Hide Next and Previous page buttons normally displayed full height beside content disableNextPrev = true # Order sections in menu by \"weight\" or \"title\". Default to \"weight\"; # this can be overridden in the pages frontmatter ordersectionsby = \"weight\" # Change default color scheme with a variant one. Eg. can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"relearn-light\" # Provide a list of custom css files to load relative from the `static/` folder in the site root. custom_css = [\"css/foo.css\", \"css/bar.css\"] # Change the title separator. Default to \"::\". titleSeparator = \"-\" A word on running your site in a subfolder The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml\nbaseURL = \"https://example.com/mysite/\" canonifyURLs = true Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.\nActivate search If not already present, add the follow lines in the same config.toml file.\n[outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.\n Hugo generate lunrjs index.json at the root of public folder. When you build the site with hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem\n Mermaid The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See Mermaid for additional documentation.\n Example:\nMermaid is globally disabled. By default it won’t be loaded by any page. On page “Architecture” you need a class diagram. You can set the Mermaid parameters locally to only load mermaid on this page (not on the others).\n You also can disable Mermaid for specific pages while globally enabled.\nHome Button Configuration If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:\n[Languages] [Languages.en] ... landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" ... [Languages.pir] ... landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Homme\" ... If those params are not configured for a specific language, they will get their default values:\nlandingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" The home button is going to look like this:\n", "description": "", "tags": null, "title": "Configuration", @@ -111,7 +111,7 @@ "uri": "/hugo-theme-relearn/shortcodes/children/children-2/" }, { - "content": "The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\n content: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content. header: the header of the content page (contains the breadcrumbs). Not meant to be overwritten custom-header: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file footer: the footer of the content page (contains the arrows). Not meant to be overwritten custom-footer: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file favicon: the favicon logo: the logo, on top left hand corner. meta: HTML meta tags, if you want to change default behavior menu: left menu. Not meant to be overwritten menu-pre: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account. menu-post: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account. menu-footer: footer of the the left menu search: search box toc: table of contents Change the logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNote The size of the logo will adapt automatically\n Change the favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change default colors The Relearn theme let you choose between some predefined color scheme variants, but feel free to add one yourself!\nStandard variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"\" Red variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"red\" Blue variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"blue\" Green variant [params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"green\" ‘Mine‘ variant First, create a new CSS file in your local static/css folder prefixed by theme (e.g. with mine theme static/css/theme-mine.css). Copy the following content and modify colors in CSS variables.\n:root { --MAIN-TEXT-color: #101010; /* Color of text by default */ --MAIN-TITLES-TEXT-color: #444753; /* Color of titles h2-h3-h4-h5-h6 */ --MAIN-LINK-color: #486ac9; /* Color of links */ --MAIN-LINK-HOVER-color: #134fbf; /* Color of hovered links */ --MAIN-ANCHOR-color: #486ac9; /* color of anchors on titles */ --MAIN-BG-color: #ffffff; /* color of text by default */ /* adjusted to relearn-light chroma style */ --CODE-BLOCK-color: #000000; /* fallback color for block code text */ --CODE-BLOCK-BG-color: #f8f8f8; /* fallback color for block code background */ --CODE-BLOCK-BORDER-color: #d8d8d8; /* color of block code border */ --CODE-INLINE-color: #5e5e5e; /* color for inline code text */ --CODE-INLINE-BG-color: #fffae9; /* color for inline code background */ --CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */ --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ --MENU-HOME-LINK-HOVER-color: #808080; /* Color of the hovered home button text */ --MENU-HEADER-BG-color: #7dc903; /* Background color of menu header */ --MENU-HEADER-BORDER-color: #7dc903; /*Color of menu header border */ --MENU-SEARCH-color: #efefef; /* Color of search field text */ --MENU-SEARCH-BG-color: #3d414d; /* Search field background color (by default borders + icons) */ --MENU-SEARCH-BOX-color: #efefef; /* Override search field border color */ --MENU-SECTIONS-ACTIVE-BG-color: #202028; /* Background color of the active section and its children */ --MENU-SECTIONS-BG-color: #282830; /* Background color of other sections */ --MENU-SECTIONS-LINK-color: #bababa; /* Color of links in menu */ --MENU-SECTIONS-LINK-HOVER-color: #ffffff; /* Color of links in menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #444444; /* Color of active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #ffffff; /* Color of background for the active category (only) */ --MENU-VISITED-color: #506397; /* Color of 'page visited' icons in menu */ --MENU-SECTION-HR-color: #282830; /* Color of \u003chr\u003e separator in menu */ } Then, set the themeVariant value with the name of your custom theme file. That’s it!\n[params] # Change default color scheme with a variant one. Can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"mine\" Multiple variants You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme selector will be shown in the menu footer.\n[params] # Change default color scheme with a variant one. Can be empty, \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = [ \"red\", \"blue ] ", + "content": "The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\n content.html: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content. header.html: the header of the content page (contains the breadcrumbs). 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 footer.html: the footer of the content page (contains the arrows). Not meant to be overwritten custom-footer.html: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file favicon.html: the favicon logo.html: the logo, on top left hand corner meta.html: HTML meta tags, if you want to change default behavior menu.html: left menu. Not meant to be overwritten menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account. menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account. menu-footer.html: footer of the the left menu search.html: search box. Not meant to be overwritten toc.html: table of contents Change the logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\nNote The size of the logo will adapt automatically\n Change the favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change default colors The Relearn theme let you choose between some predefined color scheme variants, but feel free to add one yourself!\nStandard variant [params] # Change default color scheme with a variant one. themeVariant = \"\" # or themeVariant = \"relearn\" or themeVariant = \"relearn-light\" Standard dark variant [params] # Change default color scheme with a variant one. themeVariant = \"relearn-dark\" Learn variant [params] # Change default color scheme with a variant one. themeVariant = \"learn\" Red variant [params] # Change default color scheme with a variant one. themeVariant = \"red\" Blue variant [params] # Change default color scheme with a variant one. themeVariant = \"blue\" Green variant [params] # Change default color scheme with a variant one. themeVariant = \"green\" ‘Mine‘ variant First, create a new CSS file in your local static/css folder prefixed by theme (e.g. with mine theme static/css/theme-mine.css). Copy the following content and modify colors in CSS variables.\n:root { --MAIN-TEXT-color: #101010; /* Color of text by default */ --MAIN-TITLES-TEXT-color: #444753; /* Color of titles h2-h3-h4-h5-h6 */ --MAIN-LINK-color: #486ac9; /* Color of links */ --MAIN-LINK-HOVER-color: #134fbf; /* Color of hovered links */ --MAIN-ANCHOR-color: #486ac9; /* color of anchors on titles */ --MAIN-BG-color: #ffffff; /* color of text by default */ /* adjusted to relearn-light chroma style */ --CODE-BLOCK-color: #000000; /* fallback color for block code text */ --CODE-BLOCK-BG-color: #f8f8f8; /* fallback color for block code background */ --CODE-BLOCK-BORDER-color: #d8d8d8; /* color of block code border */ --CODE-INLINE-color: #5e5e5e; /* color for inline code text */ --CODE-INLINE-BG-color: #fffae9; /* color for inline code background */ --CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */ --MENU-HOME-LINK-color: #323232; /* Color of the home button text */ --MENU-HOME-LINK-HOVER-color: #808080; /* Color of the hovered home button text */ --MENU-HEADER-BG-color: #7dc903; /* Background color of menu header */ --MENU-HEADER-BORDER-color: #7dc903; /*Color of menu header border */ --MENU-SEARCH-color: #efefef; /* Color of search field text */ --MENU-SEARCH-BG-color: #3d414d; /* Search field background color (by default borders + icons) */ --MENU-SEARCH-BOX-color: #efefef; /* Override search field border color */ --MENU-SECTIONS-ACTIVE-BG-color: #202028; /* Background color of the active section and its children */ --MENU-SECTIONS-BG-color: #282830; /* Background color of other sections */ --MENU-SECTIONS-LINK-color: #bababa; /* Color of links in menu */ --MENU-SECTIONS-LINK-HOVER-color: #ffffff; /* Color of links in menu, when hovered */ --MENU-SECTION-ACTIVE-CATEGORY-color: #444444; /* Color of active category text */ --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #ffffff; /* Color of background for the active category (only) */ --MENU-VISITED-color: #506397; /* Color of 'page visited' icons in menu */ --MENU-SECTION-HR-color: #282830; /* Color of \u003chr\u003e separator in menu */ } Then, set the themeVariant value with the name of your custom theme file. That’s it!\n[params] # Change default color scheme with a variant one. themeVariant = \"mine\" Multiple variants You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme switch will be shown in the menu footer.\n[params] # Change default color scheme with a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\" ] ", "description": "", "tags": null, "title": "Customization", diff --git a/pir/404.html b/pir/404.html index c0ea15f599..6f9b8140c8 100644 --- a/pir/404.html +++ b/pir/404.html @@ -8,16 +8,16 @@ 404 Page not found :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + - + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -321,8 +321,8 @@ # Order sections 'n menu by "weight" or "title". Default t' "weight"; # this can be overridden 'n th' planks frontmatter ordersectionsby = "weight" - # Change default color scheme wit' a variant one. Can be "red", "blue", "green" or an array like [ "blue", "green" ]. - themeVariant = "" + # Change default color scheme wit' a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ]. + themeVariant = "relearn-light" # Provide a list o' custom css files t' board relative from th' `static/` folder 'n th' ship root. custom_css = ["css/foo.css", "css/bar.css"] # Change th' title separator. Default t' "::". @@ -384,18 +384,18 @@ default values:

    - - - - - - - + + + + + + + - + diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index f466e884e7..cc521614d4 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -9,16 +9,16 @@ Customizat'n :: Documentat'n fer Cap'n Hugo Relearrrn Theme - - - - - - - - - - + + + + + + + + + + - + @@ -112,9 +112,9 @@
- - - + + +
    @@ -272,20 +272,20 @@

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

    This theme defines th' follow'n partials :

      -
    • rrrambl'n: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n.
      • -
    • header: th' header o' th' rrrambl'n plank (contains th' breadcrumbs). Not meant t' be overwritten
      • -
    • custom-header: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include style HTML tag directive 'n yer file
      • -
    • footer: th' footer o' th' rrrambl'n plank (contains th' arrows). Not meant t' be overwritten
      • -
    • custom-footer: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Don’t forget t' include javascript HTML tag directive 'n yer file
      • -
    • favicon: th' favicon
      • -
    • logo: th' logo, on top left hand corner.
      • -
    • meta: HTML meta tags, if ye want t' change default behavior
      • -
    • menu: left menu. Not meant t' be overwritten
      • -
    • menu-pre: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s pre sett'n into account.
      • -
    • menu-post: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' page’s post sett'n into account.
      • -
    • menu-footer: footer o' th' the left menu
      • -
    • search: search box
      • -
    • toc: t'ble o' contents
      • +
    • rrrambl'n.html: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n.
      • +
    • header.html: th' header o' th' rrrambl'n plank (contains th' breadcrumbs). 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
      • +
    • footer.html: th' footer o' th' rrrambl'n plank (contains th' arrows). Not meant t' be overwritten
      • +
    • custom-footer.html: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Don’t forget t' include javascript HTML tag directive 'n yer file
      • +
    • favicon.html: th' favicon
      • +
    • logo.html: th' logo, on top left hand corner
      • +
    • meta.html: HTML meta tags, if ye want t' change default behavior
      • +
    • menu.html: left menu. Not meant t' be overwritten
      • +
    • menu-pre.html: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s pre sett'n into account.
      • +
    • menu-post.html: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' page’s post sett'n into account.
      • +
    • menu-footer.html: footer o' th' the left menu
      • +
    • search.html: search box. Not meant t' be overwritten
      • +
    • toc.html: t'ble o' contents

    Create a new file 'n layouts/partials/ named logo.html. Then write any HTML ye want. @@ -304,22 +304,32 @@ Ye could use an img HTML tag an' reference an image created under t

    Th' Relearrrn theme let ye choose between some predefined color scheme variants, but feel free t' add one yourself!

    Standard variant

    [params]
-  # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
-  themeVariant = ""
-

    Red variant

    + # Change default color scheme wit' a variant one. + themeVariant = "" # or themeVariant = "relearn" or themeVariant = "relearn-light" +

Standard variant

+

Standard dark variant

+
[params]
+  # Change default color scheme wit' a variant one.
+  themeVariant = "relearn-dark"
+

Dark variant

+

Learrrn variant

+
[params]
+  # Change default color scheme wit' a variant one.
+  themeVariant = "learn"
+

Learn variant

Red variant

[params]
-  # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme wit' a variant one.
   themeVariant = "red"

Red variant

Blue variant

[params]
-  # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme wit' a variant one.
   themeVariant = "blue"

Blue variant

Green variant

[params]
-  # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme wit' a variant one.
   themeVariant = "green"

Green variant

‘Mine‘ variant

@@ -363,13 +373,13 @@ Ye could use an img HTML tag an' reference an image created under t }

Then, set th' themeVariant value wit' th' name o' yer custom theme file. That’s it!

[params]
-  # Change default color scheme wit' a variant one. Can be "red", "blue", "green" or an array like [ "blue", "green" ].
+  # Change default color scheme wit' a variant one.
   themeVariant = "mine"

Multiple variants

-

Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a theme selector will be shown 'n th' menu footer.

+

Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a theme switch will be shown 'n th' menu footer.

[params]
-  # Change default color scheme wit' a variant one. Can be empty, "red", "blue", "green"  or an array like [ "blue", "green" ].
-  themeVariant = [ "red", "blue ]
+  # Change default color scheme wit' a variant one.
+  themeVariant = [ "relearn-light", "relearn-dark" ]