✨ Added Cloudflare WebAnalytics module

2020-12-25 20:02:58 +05:00 · 2020-12-25 20:02:58 +05:00 · e1af133748
parent d497ca7d70
commit e1af133748
4 changed files with 54 additions and 0 deletions
--- a/cloudflare/README.md
+++ b/cloudflare/README.md
@ -0,0 +1,38 @@
+# Cloudflare
+[Cloudflare](https://cloudflare.com/) tools for compiled Hugo-website.
+
+## Install
+### Config
+[Import module](https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme) in your site
+configuration:
+
+```yaml
+imports:
+- path: gitlab.com/toby3d/hugo/cloudflare
+```
+
+Then, connect and configure the necessary/all modules.
+
+## Web Analytics
+[See the official Cloudflare documentation](https://blog.cloudflare.com/privacy-first-web-analytics/)
+about how it works and how to get the token.
+
+### Install
+#### Config
+```yaml
+baseUrl: https://example.com/
+params:
+  cloudflare:
+    webAnalytics: 1d59a54b73a94728a4a9ed1b09767b1f
+```
+
+#### Template
+Inject `cloudflare/web-analytics` partial in your `<body>` (preferably as close as possible to the closing tag):
+
+```html
+...
+<body>
+  ...
+  {{ partial "cloudflare/web-analytics" . }}
+</body>
+```
--- a/cloudflare/config.yaml
+++ b/cloudflare/config.yaml
@ -0,0 +1,8 @@
+---
+module:
+  hugoVersion:
+    extended: false
+    min: "0.79.0"
+  mounts:
+  - source: layouts/partials
+    target: layouts/partials/cloudflare
--- a/cloudflare/go.mod
+++ b/cloudflare/go.mod
@ -0,0 +1,3 @@
+module gitlab.com/toby3d/hugo/cloudflare
+
+go 1.15
--- a/cloudflare/layouts/partials/web-analytics.html
+++ b/cloudflare/layouts/partials/web-analytics.html
@ -0,0 +1,5 @@
+{{ with $.Site.Params.cloudflare.webAnalytics }}
+  <!-- Cloudflare Web Analytics -->
+  <script defer src="https://static.cloudflareinsights.com/beacon.min.js" data-cf-beacon="{'token':'{{ . | safeJS }}'}"></script>
+  <!-- End Cloudflare Web Analytics -->
+{{ end }}