Navigation home option (#381)

* enabled mermaid by default

* implemented logic to use internal oder cdn mermaid

* added english documentation

* added french translation for the mermaid options

* Removed useless test print

* Hugo does not use upper case letters in params

* fixed false sample link

* improved mermaid pages

* fixed always load mermaid if no frontmatter specified

* applied 3 new params to default config

* Implemented Home Button logic

* Applied default style

* applied same landingpage ref to logo partials

* added sample image, how the button will looks like

* added en documentation on how to configure the button

* translated home button configuration to french via deepl

* applied home button style to theme variants

* set button disabled by default

* fixed mermaid samples

* removed obsolete css files

* changed default version of mermaid cdn

* renamed mermaidURL to customMermaidURL and removed css link

* improved mermaid configuration description

Co-authored-by: Arthur Ferdinand Lindner <Arthur-Ferdinand.Lindner@Telekom.de>
Co-authored-by: Arthur Ferdinand Lindner <arthur.lindner@outlook.de>

4 files changed, 72 insertions, 14 deletions

diff --git a/static/css/theme-blue.css b/static/css/theme-blue.css
index 9771ae5..1ee1423 100644
--- a/static/css/theme-blue.css
+++ b/static/css/theme-blue.css
@@ -1,14 +1,17 @@
 
 :root{
-    
+
     --MAIN-TEXT-color:#323232; /* Color of text by default */
     --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
     --MAIN-LINK-color:#1C90F3; /* Color of links */
     --MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
     --MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
 
+    --MENU-HOME-LINK-color: #323232; /* Color of the home button text */
+    --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */
+
     --MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */
-    --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */ 
+    --MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */
 
     --MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */
     --MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */
@@ -23,7 +26,7 @@
 
     --MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */
     --MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
-    
+
 }
 
 body {
@@ -103,9 +106,23 @@ a:hover {
 }
 
 #body .tags a.tag-link {
-    background-color: var(--MENU-HEADER-BG-color);    
+    background-color: var(--MENU-HEADER-BG-color);
 }
 
 #body .tags a.tag-link:before {
     border-right-color: var(--MENU-HEADER-BG-color);
+}
+
+#homelinks {
+  background: var(--MENU-HEADER-BG-color);
+  background-color: var(--MENU-HEADER-BORDER-color);
+  border-bottom-color: var(--MENU-HEADER-BORDER-color);
+}
+
+#homelinks a {
+  color: var(--MENU-HOME-LINK-color);
+}
+
+#homelinks a:hover {
+  color: var(--MENU-HOME-LINK-HOVERED-color);
 }
\ No newline at end of file
diff --git a/static/css/theme-green.css b/static/css/theme-green.css
index 3b0b1f7..c074679 100644
--- a/static/css/theme-green.css
+++ b/static/css/theme-green.css
@@ -1,15 +1,18 @@
 
 :root{
-    
+
     --MAIN-TEXT-color:#323232; /* Color of text by default */
     --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
     --MAIN-LINK-color:#599a3e; /* Color of links */
     --MAIN-LINK-HOVER-color:#3f6d2c; /* Color of hovered links */
     --MAIN-ANCHOR-color: #599a3e; /* color of anchors on titles */
 
+    --MENU-HOME-LINK-color: #323232; /* Color of the home button text */
+    --MENU-HOME-LINK-HOVER-color: #5e5e5e; /* Color of the hovered home button text */
+
     --MENU-HEADER-BG-color:#74b559; /* Background color of menu header */
-    --MENU-HEADER-BORDER-color:#9cd484; /*Color of menu header border */ 
-    
+    --MENU-HEADER-BORDER-color:#9cd484; /*Color of menu header border */
+
     --MENU-SEARCH-BG-color:#599a3e; /* Search field background color (by default borders + icons) */
     --MENU-SEARCH-BOX-color: #84c767; /* Override search field border color */
     --MENU-SEARCH-BOX-ICONS-color: #c7f7c4; /* Override search field icons color */
@@ -23,7 +26,7 @@
 
     --MENU-VISITED-color: #599a3e; /* Color of 'page visited' icons in menu */
     --MENU-SECTION-HR-color: #18211c; /* Color of <hr> separator in menu */
-    
+
 }
 
 body {
@@ -103,9 +106,23 @@ a:hover {
 }
 
 #body .tags a.tag-link {
-    background-color: var(--MENU-HEADER-BG-color);    
+    background-color: var(--MENU-HEADER-BG-color);
 }
 
 #body .tags a.tag-link:before {
     border-right-color: var(--MENU-HEADER-BG-color);
+}
+
+#homelinks {
+  background: var(--MENU-HEADER-BG-color);
+  background-color: var(--MENU-HEADER-BORDER-color);
+  border-bottom-color: var(--MENU-HEADER-BORDER-color);
+}
+
+#homelinks a {
+  color: var(--MENU-HOME-LINK-color);
+}
+
+#homelinks a:hover {
+  color: var(--MENU-HOME-LINK-HOVERED-color);
 }
\ No newline at end of file
diff --git a/static/css/theme-red.css b/static/css/theme-red.css
index 36c9278..c5f2674 100644
--- a/static/css/theme-red.css
+++ b/static/css/theme-red.css
@@ -1,14 +1,17 @@
 
 :root{
-    
+
     --MAIN-TEXT-color:#323232; /* Color of text by default */
     --MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
     --MAIN-LINK-color:#f31c1c; /* Color of links */
     --MAIN-LINK-HOVER-color:#d01616; /* Color of hovered links */
     --MAIN-ANCHOR-color: #f31c1c; /* color of anchors on titles */
 
+    --MENU-HOME-LINK-color: #ccc; /* Color of the home button text */
+    --MENU-HOME-LINK-HOVER-color: #e6e6e6; /* Color of the hovered home button text */
+
     --MENU-HEADER-BG-color:#dc1010; /* Background color of menu header */
-    --MENU-HEADER-BORDER-color:#e23131; /*Color of menu header border */ 
+    --MENU-HEADER-BORDER-color:#e23131; /*Color of menu header border */
 
     --MENU-SEARCH-BG-color:#b90000; /* Search field background color (by default borders + icons) */
     --MENU-SEARCH-BOX-color: #ef2020; /* Override search field border color */
@@ -20,10 +23,10 @@
     --MENU-SECTIONS-LINK-HOVER-color: #e6e6e6;  /* Color of links in menu, when hovered */
     --MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
     --MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
-    
+
     --MENU-VISITED-color: #ff3333; /* Color of 'page visited' icons in menu */
     --MENU-SECTION-HR-color: #2b2020; /* Color of <hr> separator in menu */
-    
+
 }
 
 body {
@@ -103,9 +106,23 @@ a:hover {
 }
 
 #body .tags a.tag-link {
-    background-color: var(--MENU-HEADER-BG-color);    
+    background-color: var(--MENU-HEADER-BG-color);
 }
 
 #body .tags a.tag-link:before {
     border-right-color: var(--MENU-HEADER-BG-color);
+}
+
+#homelinks {
+  background: var(--MENU-HEADER-BG-color);
+  background-color: var(--MENU-HEADER-BORDER-color);
+  border-bottom-color: var(--MENU-HEADER-BORDER-color);
+}
+
+#homelinks a {
+  color: var(--MENU-HOME-LINK-color);
+}
+
+#homelinks a:hover {
+  color: var(--MENU-HOME-LINK-HOVERED-color);
 }
\ No newline at end of file
diff --git a/static/css/theme.css b/static/css/theme.css
index abdf041..98a5584 100644
--- a/static/css/theme.css
+++ b/static/css/theme.css
@@ -1127,6 +1127,13 @@ pre .copy-to-clipboard:hover {
     padding-left: 1rem;
 }
 
+#homelinks {
+  background-color: #9c6fb6;
+  color: #fff;
+  padding: 7px 0;
+  border-bottom: 4px solid #9c6fb6;
+}
+
 #searchResults {
     text-align: left;
 }