Merge pull request #532 from gethinode/develop

Support custom icons
Bump package version
2025-10-07 18:14:28 +00:00 · 2023-09-25 08:12:58 +02:00 · 2023-09-25 07:39:01 +02:00 · 2023-09-25 07:38:54 +02:00 · 2023-09-25 07:38:11 +02:00 · 2023-09-25 07:34:08 +02:00
17 changed files with 67 additions and 28 deletions
--- a/.github/release.yml
+++ b/.github/release.yml
@@ -14,7 +14,7 @@ changelog:
      labels:
        - Semver-Minor
        - enhancement
-    - title: 🐛 Bug fixes
+    - title: 🐛 Bug Fixes
      labels:
        - fix
        - bugfix
--- a/config/_default/hugo.toml
+++ b/config/_default/hugo.toml
@@ -120,4 +120,6 @@ home = ["HTML", "RSS", "REDIR"]
    path = "github.com/gethinode/mod-katex"
  [[module.imports]]
    path = "github.com/gethinode/mod-leaflet"
+  [[module.imports]]
+    path = "github.com/gethinode/mod-lottie"
 # toml-docs-end modules
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -16,7 +16,7 @@
 # toml-docs-start modules
 [modules]
    core = ["bootstrap", "flexsearch", "fontawesome"]
-    optional = ["leaflet", "katex"]
+    optional = ["leaflet", "katex", "lottie"]
    excludeSCSS = ["bootstrap"]
    disableTemplate = ["katex"]
    [modules.fontawesome]
--- a/exampleSite/assets/svgs/custom/activity.svg
+++ b/exampleSite/assets/svgs/custom/activity.svg
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-activity" viewBox="0 0 16 16">
+  <path fill-rule="evenodd" d="M6 2a.5.5 0 0 1 .47.33L10 12.036l1.53-4.208A.5.5 0 0 1 12 7.5h3.5a.5.5 0 0 1 0 1h-3.15l-1.88 5.17a.5.5 0 0 1-.94 0L6 3.964 4.47 8.171A.5.5 0 0 1 4 8.5H.5a.5.5 0 0 1 0-1h3.15l1.88-5.17A.5.5 0 0 1 6 2Z"/>
+</svg>
--- a/exampleSite/config/_default/params.toml
+++ b/exampleSite/config/_default/params.toml
@@ -12,7 +12,7 @@

 [modules]
    core = ["bootstrap", "flexsearch", "fontawesome"]
-    optional = ["leaflet", "katex"]
+    optional = ["leaflet", "katex", "lottie"]
    excludeSCSS = ["bootstrap"]
    disableTemplate = ["katex"]
    [modules.fontawesome]
--- a/exampleSite/content/en/blog/bootstrap-elements.md
+++ b/exampleSite/content/en/blog/bootstrap-elements.md
@@ -241,13 +241,14 @@ Use the `file` shortcode to print and highlight the full content of a given inpu

 ## Icon

-As an example, the following shortcodes show a square check, a brand logo, and a circle check.
+As an example, the following shortcodes show a square check, a brand logo, a circle check, and a custom icon.

 <!-- markdownlint-disable MD037 -->
 {{< example lang="hugo" >}}
 {{</* fa square-check */>}}
 {{</* fab linkedin */>}}
 {{</* fas circle-check */>}}
+{{</* icon custom activity */>}}
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->

--- a/exampleSite/content/en/blog/components.md
+++ b/exampleSite/content/en/blog/components.md
@@ -1,7 +1,7 @@
 ---
 author: Mark Dumay
 title: Components
-date: 2023-07-21
+date: 2023-09-23
 description: Use shortcodes to add predefined components powered by external libraries.
 tags: ["bootstrap", "shortcode"]
 thumbnail:
@@ -10,11 +10,21 @@ thumbnail:
  authorURL: https://unsplash.com/@ryoji__iwata
  origin: Unsplash
  originURL: https://unsplash.com/photos/5siQcvSxCP8
-modules: ["katex", "leaflet"]
+modules: ["katex", "leaflet", "lottie"]
 ---

 Hinode provides several shortcodes on top of the common [Bootstrap elements]({{< relref "bootstrap-elements" >}}). Refer to the [official documentation]({{< param "links.hinode_docs" >}}) for more details.

+## Animation
+
+As an example, the following shortcode shows an animation that plays on hover.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* animation data="gatin.json" auto=false hover=true class="col-6 mx-auto" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Formula (KaTeX)

 As an example, the following markdown renders two formulas using the KaTeX typesetting library.
--- a/exampleSite/go.sum
+++ b/exampleSite/go.sum
@@ -22,6 +22,8 @@ github.com/gethinode/mod-fontawesome v1.3.1 h1:EdnBuG2B+bi06OcYmcL1NfSxHpRMEGu8T
 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-fontawesome v1.4.0 h1:JfmVYwQl19jmZxgxY64yvGqJAAEiFkKf2dbZ5Iv08Qw=
+github.com/gethinode/mod-fontawesome v1.4.0/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=
@@ -29,3 +31,7 @@ github.com/gethinode/mod-leaflet v0.3.4 h1:oY+YQ0JiJuhFQNrk9XgFdg0NMsTUQPXNfnILp
 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=
+github.com/gethinode/mod-lottie v1.0.0 h1:1CUZMcgN5FAyjjyuP3qkaOQ6M5sv6HUAbosW4sIT5VE=
+github.com/gethinode/mod-lottie v1.0.0/go.mod h1:erRCgSL2FCfKHI0jQbSpM+g0jXl7SjKVJrh7kWGteKs=
+github.com/gethinode/mod-lottie v1.0.1 h1:+IE7xtnSVQpJS56oBJq9RWKZeFEfxrOZAqE3BSrS/u0=
+github.com/gethinode/mod-lottie v1.0.1/go.mod h1:erRCgSL2FCfKHI0jQbSpM+g0jXl7SjKVJrh7kWGteKs=
--- a/exampleSite/hugo_stats.json
+++ b/exampleSite/hugo_stats.json
@@ -69,6 +69,8 @@
      "bg-opacity-10",
      "bg-primary",
      "bg-primary-subtle",
+      "bi",
+      "bi-activity",
      "border",
      "border-0",
      "border-1",
@@ -134,6 +136,7 @@
      "container",
      "container-fluid",
      "container-xxl",
+      "custom",
      "d-block",
      "d-flex",
      "d-grid",
@@ -164,6 +167,7 @@
      "fa-2x",
      "fa-2xs",
      "fa-4x",
+      "fa-activity",
      "fa-arrow-left",
      "fa-arrow-right",
      "fa-bootstrap",
@@ -245,6 +249,7 @@
      "link-secondary",
      "link-success",
      "link-warning",
+      "lottie-animation",
      "m-0",
      "main-nav-toggler",
      "mb-0",
@@ -420,6 +425,7 @@
      "accordéon",
      "alert",
      "alerte",
+      "animation",
      "badge",
      "barre-de-navigation",
      "body-docs-collapse-15",
@@ -460,6 +466,7 @@
      "leaflet-map-0",
      "lien",
      "link",
+      "lottie-animation-0",
      "map",
      "mark",
      "nav",
--- a/exampleSite/static/gatin.json
+++ b/exampleSite/static/gatin.json
--- a/go.mod
+++ b/go.mod
@@ -5,7 +5,8 @@ go 1.19
 require (
 	github.com/gethinode/mod-bootstrap v1.2.1 // indirect
 	github.com/gethinode/mod-flexsearch v1.4.1 // indirect
-	github.com/gethinode/mod-fontawesome v1.3.2 // indirect
+	github.com/gethinode/mod-fontawesome v1.4.0 // indirect
 	github.com/gethinode/mod-katex v1.0.2 // indirect
 	github.com/gethinode/mod-leaflet v0.3.5 // indirect
+	github.com/gethinode/mod-lottie v1.0.1 // indirect
 )
--- a/go.sum
+++ b/go.sum
@@ -50,6 +50,8 @@ github.com/gethinode/mod-fontawesome v1.3.1 h1:EdnBuG2B+bi06OcYmcL1NfSxHpRMEGu8T
 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-fontawesome v1.4.0 h1:JfmVYwQl19jmZxgxY64yvGqJAAEiFkKf2dbZ5Iv08Qw=
+github.com/gethinode/mod-fontawesome v1.4.0/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=
@@ -66,3 +68,7 @@ github.com/gethinode/mod-leaflet v0.3.4 h1:oY+YQ0JiJuhFQNrk9XgFdg0NMsTUQPXNfnILp
 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=
+github.com/gethinode/mod-lottie v1.0.0 h1:1CUZMcgN5FAyjjyuP3qkaOQ6M5sv6HUAbosW4sIT5VE=
+github.com/gethinode/mod-lottie v1.0.0/go.mod h1:erRCgSL2FCfKHI0jQbSpM+g0jXl7SjKVJrh7kWGteKs=
+github.com/gethinode/mod-lottie v1.0.1 h1:+IE7xtnSVQpJS56oBJq9RWKZeFEfxrOZAqE3BSrS/u0=
+github.com/gethinode/mod-lottie v1.0.1/go.mod h1:erRCgSL2FCfKHI0jQbSpM+g0jXl7SjKVJrh7kWGteKs=
--- a/layouts/partials/head/stylesheet.html
+++ b/layouts/partials/head/stylesheet.html
@@ -49,19 +49,21 @@
 {{- $options := (dict "transpiler" $transpiler "targetPath" $target "enableSourceMap" (not hugo.IsProduction) "vars" $vars) -}}
 {{- $bundle := partial "utilities/bundle" (dict "match" $source "filename" (printf "scss/bundle-%d.scss" now.UnixNano) "modules" $modules "basepath" "scss" "debugging" site.Params.debugging.showSCSS) -}}

-{{- $css := $bundle | resources.ExecuteAsTemplate $target . | toCSS $options -}}
+{{- if gt ($bundle.Content | len) 0 }}
+    {{- $css := $bundle | resources.ExecuteAsTemplate $target . | toCSS $options -}}

-{{ if $core }}
-    {{- partial "head/icons.html" (dict "css" $css) -}}
-{{ end }}
-{{- if site.Params.style.purge -}}
-    {{- $post_options := dict "config" "config" -}}
-    {{- $css = $css | resources.PostCSS $post_options -}}
-{{- end -}}
+    {{ if $core }}
+        {{- partial "head/icons.html" (dict "css" $css) -}}
+    {{ end }}
+    {{- if site.Params.style.purge -}}
+        {{- $post_options := dict "config" "config" -}}
+        {{- $css = $css | resources.PostCSS $post_options -}}
+    {{- end -}}

-{{- if not hugo.IsProduction -}}
-    <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}">
-{{- else -}}
-    {{- $css = $css | fingerprint | resources.PostProcess -}}
-    <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}" integrity="{{ $css.Data.Integrity }}" crossorigin="anonymous">
+    {{- if not hugo.IsProduction -}}
+        <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}">
+    {{- else -}}
+        {{- $css = $css | fingerprint | resources.PostProcess -}}
+        <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}" integrity="{{ $css.Data.Integrity }}" crossorigin="anonymous">
+    {{- end -}}
 {{- end -}}
--- a/layouts/partials/utilities/link.html
+++ b/layouts/partials/utilities/link.html
@@ -71,6 +71,6 @@
    {{- end -}}
 {{- end -}}

-{{ if not $error }}
+{{ if not $error -}}
    <a {{ with $class }}class="{{ . }}" {{ end }}href="{{ $destination | safeURL }}"{{ with $target }} target="{{ . }}"{{ end }}{{ with $rel }} rel="{{ . }}"{{ end }}>{{ $text }}</a>
-{{ end }}
+{{- end }}
--- a/netlify.toml
+++ b/netlify.toml
@@ -4,12 +4,12 @@
    command = "npm run build:example"

 [build.environment]
-    DART_SASS_VERSION = "1.66.1"
+    DART_SASS_VERSION = "1.68.0"
    HUGO_VERSION = "0.118.2"
    HUGO_ENV = "production"
    HUGO_ENABLEGITINFO = "true"
-    NODE_VERSION = "18.17.1"
-    NPM_VERSION = "9.6.7"
+    NODE_VERSION = "18.18.0"
+    NPM_VERSION = "9.8.1"
 # toml-docs-end netlify

 [[headers]]
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "@gethinode/hinode",
-  "version": "0.20.3",
+  "version": "0.20.5",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "@gethinode/hinode",
-      "version": "0.20.3",
+      "version": "0.20.5",
      "license": "MIT",
      "devDependencies": {
        "@fullhuman/postcss-purgecss": "^5.0.0",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@gethinode/hinode",
-  "version": "0.20.3",
+  "version": "0.20.5",
  "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
  "keywords": [
    "hugo",
Author	SHA1	Message	Date
Mark Dumay	529b0db71d	Merge pull request #532 from gethinode/develop Support custom icons	2023-09-25 08:12:58 +02:00
mark	bd142ac66d	Bump package version	2023-09-25 07:39:01 +02:00
mark	3749937799	Add custom icon example	2023-09-25 07:38:54 +02:00
mark	16d309cc34	Update build stats	2023-09-25 07:38:11 +02:00
Mark Dumay	5315bc950a	Merge pull request #531 from gethinode/main Sync with main	2023-09-25 07:34:08 +02:00
Mark Dumay	2dbf6a9faf	Merge pull request #530 from gethinode/hugo-mod-dependencies Update Hugo module dependencies	2023-09-25 07:22:20 +02:00
markdumay	a67e38bd1b	fix: update Hugo module dependencies	2023-09-25 05:14:37 +00:00
Mark Dumay	4688176216	Merge pull request #529 from gethinode/develop Add animation support	2023-09-24 06:31:05 +02:00
mark	dbee9aafd7	Prevent processing of empty scss bundles	2023-09-24 05:58:27 +02:00
mark	8c20617b1a	Bump dependencies	2023-09-23 17:27:24 +02:00
Mark Dumay	9e2ed6480d	Merge branch 'main' into develop	2023-09-23 17:08:35 +02:00
mark	7ef1b1aba9	Remove newlines	2023-09-23 17:07:51 +02:00
mark	b74071d4cf	Bump package release	2023-09-23 16:59:17 +02:00
mark	dc7578a5c3	Add animation support	2023-09-23 16:58:38 +02:00
Mark Dumay	2227cf5fe2	Standardize capitalization	2023-09-22 07:21:31 +02:00