From 1bc54d5d14cd67cfdec4b97ab53d76b920be3704 Mon Sep 17 00:00:00 2001 From: George Cushen Date: Fri, 29 Dec 2023 22:59:47 +0000 Subject: [PATCH] feat: port analytics to blox-analytics --- modules/blox-analytics/README.md | 27 +++++++++++++++++++ modules/blox-analytics/go.mod | 3 +++ modules/blox-analytics/hugo.yaml | 4 +++ .../partials/blox-analytics/index.html | 9 +++++++ .../services}/baidu_tongji.html | 0 .../blox-analytics/services}/fathom.html | 0 .../services}/google_analytics.html | 0 .../services}/google_tag_manager.html | 0 .../blox-analytics/services/index.html | 7 +++++ .../services}/microsoft_clarity.html | 0 .../blox-analytics/services}/pirsch.html | 0 .../blox-analytics/services}/plausible.html | 0 .../partials/blox-analytics/verification.html | 21 +++++++++++++++ 13 files changed, 71 insertions(+) create mode 100644 modules/blox-analytics/README.md create mode 100644 modules/blox-analytics/go.mod create mode 100644 modules/blox-analytics/hugo.yaml create mode 100644 modules/blox-analytics/layouts/partials/blox-analytics/index.html rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/baidu_tongji.html (100%) rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/fathom.html (100%) rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/google_analytics.html (100%) rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/google_tag_manager.html (100%) create mode 100644 modules/blox-analytics/layouts/partials/blox-analytics/services/index.html rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/microsoft_clarity.html (100%) rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/pirsch.html (100%) rename modules/{blox-tailwind/layouts/partials/marketing => blox-analytics/layouts/partials/blox-analytics/services}/plausible.html (100%) create mode 100644 modules/blox-analytics/layouts/partials/blox-analytics/verification.html diff --git a/modules/blox-analytics/README.md b/modules/blox-analytics/README.md new file mode 100644 index 00000000..e6e6513c --- /dev/null +++ b/modules/blox-analytics/README.md @@ -0,0 +1,27 @@ +# blox-analytics + +**A Hugo module (plugin) for website analytics and search engine verification.** + +Are you using the `blox-tailwind` module? The analytics module is already included, so you do not need to install it. For all other sites, refer to the installation guide below. + +## Install + +Get analytics and verification for your Hugo site by following the guide below: + +1. Add the module to your `config/_default/hugo.yaml`: + + ```yaml + module: + imports: + - path: github.com/HugoBlox/hugo-blox-builder/modules/blox-analytics + ``` + +2. Load the module in your site's `` with: + + ```go + {{ partial "blox_analytics/index" . }} + ``` + +## Usage + +[View the documentation](https://docs.hugoblox.com/reference/analytics/) diff --git a/modules/blox-analytics/go.mod b/modules/blox-analytics/go.mod new file mode 100644 index 00000000..818a4051 --- /dev/null +++ b/modules/blox-analytics/go.mod @@ -0,0 +1,3 @@ +module github.com/HugoBlox/hugo-blox-builder/modules/blox-analytics + +go 1.15 diff --git a/modules/blox-analytics/hugo.yaml b/modules/blox-analytics/hugo.yaml new file mode 100644 index 00000000..7d9ee8af --- /dev/null +++ b/modules/blox-analytics/hugo.yaml @@ -0,0 +1,4 @@ +module: + mounts: + - source: layouts + target: layouts diff --git a/modules/blox-analytics/layouts/partials/blox-analytics/index.html b/modules/blox-analytics/layouts/partials/blox-analytics/index.html new file mode 100644 index 00000000..bb87f9ce --- /dev/null +++ b/modules/blox-analytics/layouts/partials/blox-analytics/index.html @@ -0,0 +1,9 @@ +{{/* HUGO BLOX: MARKETING MODULE */}} + +{{/* VERIFICATIONS */}} + +{{ partial "blox-analytics/verification" . }} + +{{/* ANALYTICS */}} + +{{ partial "blox-analytics/services/index" . }} diff --git a/modules/blox-tailwind/layouts/partials/marketing/baidu_tongji.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/baidu_tongji.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/baidu_tongji.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/baidu_tongji.html diff --git a/modules/blox-tailwind/layouts/partials/marketing/fathom.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/fathom.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/fathom.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/fathom.html diff --git a/modules/blox-tailwind/layouts/partials/marketing/google_analytics.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/google_analytics.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/google_analytics.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/google_analytics.html diff --git a/modules/blox-tailwind/layouts/partials/marketing/google_tag_manager.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/google_tag_manager.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/google_tag_manager.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/google_tag_manager.html diff --git a/modules/blox-analytics/layouts/partials/blox-analytics/services/index.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/index.html new file mode 100644 index 00000000..3e0e8aff --- /dev/null +++ b/modules/blox-analytics/layouts/partials/blox-analytics/services/index.html @@ -0,0 +1,7 @@ +{{ partial "blox-analytics/services/google_analytics" . }} +{{ partial "blox-analytics/services/google_tag_manager" . }} +{{ partial "blox-analytics/services/microsoft_clarity" . }} +{{ partial "blox-analytics/services/baidu_tongji" . }} +{{ partial "blox-analytics/services/plausible" . }} +{{ partial "blox-analytics/services/fathom" . }} +{{ partial "blox-analytics/services/pirsch" . }} diff --git a/modules/blox-tailwind/layouts/partials/marketing/microsoft_clarity.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/microsoft_clarity.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/microsoft_clarity.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/microsoft_clarity.html diff --git a/modules/blox-tailwind/layouts/partials/marketing/pirsch.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/pirsch.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/pirsch.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/pirsch.html diff --git a/modules/blox-tailwind/layouts/partials/marketing/plausible.html b/modules/blox-analytics/layouts/partials/blox-analytics/services/plausible.html similarity index 100% rename from modules/blox-tailwind/layouts/partials/marketing/plausible.html rename to modules/blox-analytics/layouts/partials/blox-analytics/services/plausible.html diff --git a/modules/blox-analytics/layouts/partials/blox-analytics/verification.html b/modules/blox-analytics/layouts/partials/blox-analytics/verification.html new file mode 100644 index 00000000..e0fbca77 --- /dev/null +++ b/modules/blox-analytics/layouts/partials/blox-analytics/verification.html @@ -0,0 +1,21 @@ +{{/* Site Verification with Third Party Services */}} + +{{- with site.Params.marketing.verification.google -}} + +{{- end -}} + +{{- with site.Params.marketing.verification.bing -}} + +{{- end -}} + +{{- with site.Params.marketing.verification.yandex -}} + +{{- end -}} + +{{- with site.Params.marketing.verification.pinterest -}} + +{{- end -}} + +{{- with site.Params.marketing.verification.baidu -}} + +{{- end -}}