Merge pull request #523 from gethinode/develop

Fix rendering of button title

exampleSite/go.sum

@@ -10,6 +10,8 @@ github.com/gethinode/mod-flexsearch v1.3.0 h1:RbfEDw219Y1rOVp9lHmy5ePdF9lyPalDu2
 github.com/gethinode/mod-flexsearch v1.3.0/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-flexsearch v1.4.0 h1:5e/NVRLyWzUZ9fO/fNsM5o+O7nw+xyln2rfEOtbgfWc=
 github.com/gethinode/mod-flexsearch v1.4.0/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
+github.com/gethinode/mod-flexsearch v1.4.1 h1:z+GKvhJ4v6BsZsWVZRgbO9WcmSZEVUkb3Q9a09yXtd8=
+github.com/gethinode/mod-flexsearch v1.4.1/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-fontawesome v1.2.4 h1:SqE3CQ+boaBIhrVh3MPu4nz0uoHPfEH5t60nNY1CfsI=
 github.com/gethinode/mod-fontawesome v1.2.4/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.2.5 h1:RqkLRj6+s+gM4nKd0IwNMMDA8cRmxfp0fxkVH4FdAGU=
@@ -18,8 +20,12 @@ github.com/gethinode/mod-fontawesome v1.3.0 h1:oudeDBlAKu8vqYxumWuq5SG5F5itm33Ng
 github.com/gethinode/mod-fontawesome v1.3.0/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.3.1 h1:EdnBuG2B+bi06OcYmcL1NfSxHpRMEGu8TXUqEEpVH4g=
 github.com/gethinode/mod-fontawesome v1.3.1/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
+github.com/gethinode/mod-fontawesome v1.3.2 h1:qLJSbAFR2T33BuBtC2Iulm9wZql3cy7AhXjxc2YGzBU=
+github.com/gethinode/mod-fontawesome v1.3.2/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-katex v1.0.1/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-katex v1.0.2 h1:pIG4n3qLl/IVe7BEiwn+GL8r5lOCtF6FDxlcrPKdAXk=
 github.com/gethinode/mod-katex v1.0.2/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-leaflet v0.3.4 h1:oY+YQ0JiJuhFQNrk9XgFdg0NMsTUQPXNfnILp4ia4r4=
 github.com/gethinode/mod-leaflet v0.3.4/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=
+github.com/gethinode/mod-leaflet v0.3.5 h1:69Bv/6zRXhbcTzo7TMr58h3ry47srHRpM1k81LrLbYU=
+github.com/gethinode/mod-leaflet v0.3.5/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=

go.mod

@@ -4,8 +4,8 @@ go 1.19
 
 require (
 	github.com/gethinode/mod-bootstrap v1.2.1 // indirect
-	github.com/gethinode/mod-flexsearch v1.4.0 // indirect
-	github.com/gethinode/mod-fontawesome v1.3.1 // indirect
+	github.com/gethinode/mod-flexsearch v1.4.1 // indirect
+	github.com/gethinode/mod-fontawesome v1.3.2 // indirect
 	github.com/gethinode/mod-katex v1.0.2 // indirect
-	github.com/gethinode/mod-leaflet v0.3.4 // indirect
+	github.com/gethinode/mod-leaflet v0.3.5 // indirect
 )

go.sum

@@ -26,6 +26,8 @@ github.com/gethinode/mod-flexsearch v1.3.0 h1:RbfEDw219Y1rOVp9lHmy5ePdF9lyPalDu2
 github.com/gethinode/mod-flexsearch v1.3.0/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-flexsearch v1.4.0 h1:5e/NVRLyWzUZ9fO/fNsM5o+O7nw+xyln2rfEOtbgfWc=
 github.com/gethinode/mod-flexsearch v1.4.0/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
+github.com/gethinode/mod-flexsearch v1.4.1 h1:z+GKvhJ4v6BsZsWVZRgbO9WcmSZEVUkb3Q9a09yXtd8=
+github.com/gethinode/mod-flexsearch v1.4.1/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-fontawesome v1.0.2 h1:ZSK6D20/w4y5GnfYfTBB58uHD0ChIfkpKfRGwioS9rg=
 github.com/gethinode/mod-fontawesome v1.0.2/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.1.0 h1:rsDzUI+3ZlS/do2ff3ne8/z3KwHeysmuA+WsXlumXXk=
@@ -46,6 +48,8 @@ github.com/gethinode/mod-fontawesome v1.3.0 h1:oudeDBlAKu8vqYxumWuq5SG5F5itm33Ng
 github.com/gethinode/mod-fontawesome v1.3.0/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.3.1 h1:EdnBuG2B+bi06OcYmcL1NfSxHpRMEGu8TXUqEEpVH4g=
 github.com/gethinode/mod-fontawesome v1.3.1/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
+github.com/gethinode/mod-fontawesome v1.3.2 h1:qLJSbAFR2T33BuBtC2Iulm9wZql3cy7AhXjxc2YGzBU=
+github.com/gethinode/mod-fontawesome v1.3.2/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-katex v1.0.0 h1:me/3dIIZBkfk1mRIFt8QiAGYwYDoSG5bc2hHRtIutFc=
 github.com/gethinode/mod-katex v1.0.0/go.mod h1:byAfpI3wuqNJIooTGVEGc1cjBhhCy4+CcK1H6495MYg=
 github.com/gethinode/mod-katex v1.0.1 h1:809QUztxmKgMNchU+v03iMO7Ma+ISc3ZzhXYauc21rs=
@@ -60,3 +64,5 @@ github.com/gethinode/mod-leaflet v0.3.3 h1:isnjja6VRFvVWBatYSouh46TXSJg2C4/E2BQT
 github.com/gethinode/mod-leaflet v0.3.3/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=
 github.com/gethinode/mod-leaflet v0.3.4 h1:oY+YQ0JiJuhFQNrk9XgFdg0NMsTUQPXNfnILp4ia4r4=
 github.com/gethinode/mod-leaflet v0.3.4/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=
+github.com/gethinode/mod-leaflet v0.3.5 h1:69Bv/6zRXhbcTzo7TMr58h3ry47srHRpM1k81LrLbYU=
+github.com/gethinode/mod-leaflet v0.3.5/go.mod h1:uGggt87x4Fw7wBoJpSiUvNkYg+s/Ujne7klAX2rxMRk=

layouts/partials/assets/button.html

@@ -140,7 +140,7 @@
 
 {{- $attributes := .attributes -}}
 
-<a aria-label="{{ or $label $title }}" {{ if ne $state "disabled" }}{{ with $href }}href="{{ . }}"{{ end }}{{ end -}}
+<a aria-label="{{ (or $label $title) | safeHTML }}" {{ if ne $state "disabled" }}{{ with $href }}href="{{ . }}"{{ end }}{{ end -}}
     {{- with $id }} id="{{ . }}"{{ end -}}
     {{- with $target }} target="{{ . }}"{{ end }}{{ with $rel }} rel="{{ . }}"{{ end -}}
     {{- with $toast }} data-toast-target="{{ $toast }}"{{ end -}}
@@ -157,7 +157,7 @@
     {{- end -}}
     >
     <div class="d-flex justify-content-{{ $justify }}">
-        <div class="my-auto">{{ $title }}</div>
+        <div class="my-auto">{{ $title | safeHTML }}</div>
         {{- with $icon }}<div class="align-self-center{{ if $title }}{{ if eq $order "first" }} order-first pe-1{{ else }} ps-1{{ end }}{{ end }}">{{ partial "assets/icon.html" (dict "icon" $icon) }}</div>{{ end }}
     </div>
 

layouts/partials/assets/sidebar.html

@@ -9,9 +9,10 @@
     {{- $level := .level -}}
     {{- $baseURL := .baseURL -}}
     {{- $group := .group -}}
+    {{- $data := .menu -}}
 
     {{- $doc_slug := $group.title | urlize -}}
-    {{- $href := printf "%s/" (relLangURL (path.Join $baseURL $doc_slug)) -}}
+    {{- $href := or $group.link (printf "%s/" (relLangURL (path.Join $baseURL $doc_slug))) -}}
     {{- $collapsed := strings.HasPrefix $page.RelPermalink $href -}}
 
     <li class="mb-1">
@@ -28,6 +29,7 @@
                             "level" (add $level 1)
                             "baseURL" $href
                             "group" $item
+                            "menu" $data
                             )
                         }}
                     {{- else -}}
@@ -37,6 +39,8 @@
                             "level" $level
                             "baseURL" $href
                             "title" $item.title
+                            "href" $item.link
+                            "menu" $data
                             )
                         }}
                     {{ end -}}
@@ -47,15 +51,17 @@
 {{ end -}}
 
 {{- define "partials/sidebar/item.html" -}}
-    {{ $page := .page }}
-    {{ $sectionBreak := .sectionBreak }}
+    {{- $page := .page -}}
+    {{- $sectionBreak := .sectionBreak -}}
     {{- $level := .level -}}
-    {{ $baseURL := .baseURL}}
-    {{ $title := .title}}
+    {{- $baseURL := .baseURL -}}
+    {{- $title := .title -}}
+    {{- $href := .href -}}
+    {{- $data := .menu -}}
 
     {{- $doc_slug := $title | urlize -}}
-    {{- $href := printf "%s/" (relLangURL (path.Join $baseURL $doc_slug)) -}}
-    {{ $active := eq $page.RelPermalink $href }}
+    {{- $href := or $href (printf "%s/" (relLangURL (path.Join $baseURL $doc_slug))) -}}
+    {{- $active := eq (strings.TrimSuffix "/" $page.RelPermalink) (strings.TrimSuffix "/" $href) -}}
 
     {{ if eq $level 0}}
         <li class="mt-1 mb-1 {{ if $sectionBreak }}border-top{{ end }}"></li>
@@ -63,17 +69,27 @@
         <li>
             <ul class="btn-toggle-nav list-unstyled fw-bold pb-1">
                 <li>
-                    <a href="{{ $href }}" class="sidebar-item text-decoration-none rounded {{ if $active }}active{{ end }}">
-                        {{ $title }}
-                    </a>      
+                    {{ $class := "sidebar-item text-decoration-none rounded" }}
+                    {{ if $active }}{{ $class = printf "%s active" $class }}{{ end }}
+                    {{ $link := partial "utilities/link.html" (dict "destination" $href "text" $title "class" $class "page" $page) }}
+                    {{ if $link }}
+                        {{ print $link | safeHTML }}
+                    {{ else }}
+                        {{- errorf "partial [utilities/sidebar.html] - Invalid link in file: %s" ($page.Scratch.Get "sidebarFilename") -}}
+                    {{ end }}
                 </li>
             </ul>
         </li>
     {{ else }}
         <li>
-            <a href="{{ $href }}" class="sidebar-item text-decoration-none rounded small {{ if $active }}active{{ end }}">
-                {{ $title }}
-            </a>      
+            {{ $class := "sidebar-item text-decoration-none rounded small" }}
+            {{ if $active }}{{ $class = printf "%s active" $class }}{{ end }}
+            {{ $link := partial "utilities/link.html" (dict "destination" $href "text" $title "class" $class "page" $page) }}
+            {{ if $link }}
+                {{ print $link | safeHTML }}
+            {{ else }}
+                {{- errorf "partial [utilities/sidebar.html] - Invalid link in file: %s" ($page.Scratch.Get "sidebarFilename") -}}
+            {{ end }}
         </li>
     {{ end }}
 {{ end -}}
@@ -94,6 +110,7 @@
                     "level" (add $level 1)
                     "baseURL" $baseURL
                     "group" $item
+                    "menu" $data
                     )
                 }}
             {{- else }}
@@ -103,6 +120,8 @@
                     "level" $level
                     "baseURL" $baseURL
                     "title" $item.title
+                    "href" $item.link
+                    "menu" $data
                     )
                 }}
             {{- end }}

layouts/partials/utilities/GetMenu.html

@@ -1,12 +1,17 @@
 {{- $page := .page -}}
 {{- $version := .version -}}
+{{- $sidebarFilename := "" -}}
 
 {{- $menu := "" -}}
 {{- if $page.IsPage -}}
-    {{- $menu = index site.Data (printf "%s-%s" $page.Section $version) -}}
+    {{- $sidebarFilename = printf "%s-%s" $page.Section $version -}}
+    {{- $menu = index site.Data $sidebarFilename -}}
     {{ if not $menu }}
-        {{ $menu = index site.Data $page.Section }}
+        {{- $sidebarFilename = $page.Section -}}
+        {{ $menu = index site.Data $sidebarFilename }}
     {{ end }}
 {{- end -}}
 
+{{ if $menu }}{{ with $sidebarFilename }}{{ $page.Scratch.Set "sidebarFilename" (path.Join "data" .) }}{{ end }}{{ end -}}
+
 {{- return $menu -}}

layouts/partials/utilities/link.html

@@ -3,6 +3,7 @@
     {{- errorf "partial [utilities/link.html] - Missing param 'destination'" -}}
 {{- end -}}
 
+{{- $error := false -}}
 {{- $target := "" -}}
 {{- $rel := "" -}}
 {{- $case := .case | default true }}
@@ -55,6 +56,7 @@
 
     {{- if not $ref -}}
         {{- errorf "partial [utilities/link.html] - Cannot find page: %s" $destination -}}
+        {{- $error = true -}}
     {{- else -}}
         {{- $destination = $ref.RelPermalink -}}
         {{- with $anchor }}{{ $destination = printf "%s#%s" (strings.TrimSuffix "/" $destination) . -}}{{ end -}}
@@ -69,4 +71,6 @@
     {{- end -}}
 {{- end -}}
 
-<a {{ with $class }}class="{{ . }}" {{ end }}href="{{ $destination | safeURL }}"{{ with $target }} target="{{ . }}"{{ end }}{{ with $rel }} rel="{{ . }}"{{ end }}>{{ $text }}</a>
+{{ if not $error }}
+    <a {{ with $class }}class="{{ . }}" {{ end }}href="{{ $destination | safeURL }}"{{ with $target }} target="{{ . }}"{{ end }}{{ with $rel }} rel="{{ . }}"{{ end }}>{{ $text }}</a>
+{{ end }}

layouts/shortcodes/nav.html

@@ -4,7 +4,7 @@
     "type"          Optional type of the tab group, either "tabs", "pills", or "underline".
     "vertical"      Optional flag to show vertical tabs instead of horizontal tabs (default).
     "fade"          Optional flag to make tab panes fade in.
-    "class":        Optional class attribute of the tab group, e.g. “nav-fill”.
+    "class"         Optional class attribute of the tab group, e.g. “nav-fill”.
 -->
 
 {{- $id := printf "nav-%d" .Ordinal -}}

netlify.toml

@@ -1,25 +1,15 @@
 # toml-docs-start netlify
 [build]
     publish = "exampleSite/public"
+    command = "npm run build:example"
 
 [build.environment]
-    NODE_VERSION = "18.17.1"
-    NPM_VERSION = "9.6.7"
-
-[context.production]
-    command = """\
-    curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
-    tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
-    rm dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
-    export PATH=/opt/build/repo/dart-sass:$PATH && \
-    npm run build:example \
-    """
-
-[context.production.environment]
     DART_SASS_VERSION = "1.66.1"
     HUGO_VERSION = "0.118.2"
     HUGO_ENV = "production"
     HUGO_ENABLEGITINFO = "true"
+    NODE_VERSION = "18.17.1"
+    NPM_VERSION = "9.6.7"
 # toml-docs-end netlify
 
 [[headers]]
@@ -81,3 +71,19 @@
     port = 8888
     publish = "public"
     autoLaunch = false
+
+# toml-docs-start plugins
+[[plugins]]
+    package = "@gethinode/netlify-plugin-dartsass"
+
+[[plugins]]
+    package = "netlify-plugin-hugo-cache-resources"
+	[plugins.inputs]
+	# Redirected in exampleSite/config/_default/hugo.toml
+	# srcdir = ""
+
+[[plugins]]
+    package = "@netlify/plugin-lighthouse"
+    # [plugins.inputs]
+    # output_path = "reports/lighthouse.html"
+# toml-docs-end plugins

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.20.0-alpha",
+  "version": "0.20.2",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",
@@ -67,16 +67,19 @@
   "homepage": "https://gethinode.com",
   "devDependencies": {
     "@fullhuman/postcss-purgecss": "^5.0.0",
+    "@gethinode/netlify-plugin-dartsass": "^0.2.0",
+    "@netlify/plugin-lighthouse": "^5.0.0",
     "autoprefixer": "^10.4.15",
     "cssnano": "^6.0.1",
     "cssnano-preset-advanced": "^6.0.1",
-    "eslint": "^8.48.0",
+    "eslint": "^8.49.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-n": "^16.0.2",
+    "eslint-plugin-n": "^16.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "hugo-bin": "^0.114.2",
     "markdownlint-cli2": "^0.9.2",
+    "netlify-plugin-hugo-cache-resources": "^0.2.1",
     "npm-run-all": "^4.1.5",
     "postcss-cli": "^10.1.0",
     "purgecss-whitelister": "^2.4.0",