Compare commits

...

5 Commits

Author SHA1 Message Date
Francesco Maida a4b02ddce7
Merge 78560462ca into 50b77b2836 2024-03-20 14:11:22 +01:00
James Panther 50b77b2836
📝 Update configuration docs 2024-03-20 08:40:17 +11:00
Francesco Maida 78560462ca Add Umami Analytics info to the documentation (in the english version) 📝 2024-03-17 21:00:55 +01:00
Francesco Maida c816c5fc3d Added support for Umami Analytics See #829 for further references. 2024-03-16 17:28:00 +01:00
Francesco Maida 4d5643f861 Added support for Umami Analytics. See #829 for further references. 2024-03-16 17:13:29 +01:00
7 changed files with 37 additions and 2 deletions

View File

@ -28,7 +28,7 @@ Congo is designed to be a powerful, lightweight theme for [Hugo](https://gohugo.
- Heading anchors, Tables of Contents, Code copy, Buttons, Badges and more
- HTML and Emoji support in articles 🎉
- SEO friendly with links for sharing to social media
- Fathom Analytics and Google Analytics support
- Fathom Analytics, Plausible Analytics, Umami Analytics and Google Analytics support
- RSS feeds, Favicons and comments support
- Advanced customisation using simple Tailwind colour definitions and styles
- Optimised for performance and accessibility with perfect Lighthouse scores

View File

@ -75,6 +75,10 @@ fingerprintAlgorithm = "sha256"
# event = ""
# script = ""
#[umamiAnalytics]
# site = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# region = "eu" # can be either "eu" or "us"
[verification]
# google = ""
# bing = ""

View File

@ -71,6 +71,10 @@ fingerprintAlgorithm = "sha256"
[fathomAnalytics]
# site = "ABC12345"
#[umamiAnalytics]
# site = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# region = "eu" # Can be either "eu" or "us"
[verification]
# google = ""
# bing = ""

View File

@ -66,6 +66,7 @@ Congoは現在、以下の言語に対応しています:
| :indonesia: Indonesian | `id` |
| :it: Italian | `it` |
| :jp: Japanese | `ja` |
| :kr: Korean | `ko` |
| :poland: Polish | `pl` |
| :brazil: Portuguese (Brazil) | `pt-br` |
| :portugal: Portuguese (Portugal) | `pt-pt` |
@ -73,6 +74,7 @@ Congoは現在、以下の言語に対応しています:
| :ru: Russian | `ru` |
| :slovakia: Slovak | `sk` |
| :es: Spanish (Spain) | `es` |
| :flag-lk: Tamil | `ta` |
| :tr: Turkish | `tr` |
| :ukraine: Ukrainian | `uk` |

View File

@ -74,6 +74,7 @@ The theme currently supports the following languages out of the box:
| :ru: Russian | `ru` |
| :slovakia: Slovak | `sk` |
| :es: Spanish (Spain) | `es` |
| :flag-lk: Tamil | `ta` |
| :tr: Turkish | `tr` |
| :ukraine: Ukrainian | `uk` |
@ -175,6 +176,8 @@ Many of the article defaults here can be overridden on a per article basis by sp
|`plausibleAnalytics.domain`|_Not set_|Enter the domain of the website you want to track. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`plausibleAnalytics.event`|_Not set_|Plausible api event proxied URL. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`plausibleAnalytics.script`|_Not set_|Plausible analysis script proxied URL. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`umamiAnalytics.site`|_Not set_|The tracking code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`umamiAnalytics.region`|`eu`|Select the Umami Analytics server region to connect to. The value is a string that can be either `eu` or `us`.|
|`verification.google`|_Not set_|The site verification string provided by Google to be included in the site metadata.|
|`verification.bing`|_Not set_|The site verification string provided by Bing to be included in the site metadata.|
|`verification.pinterest`|_Not set_|The site verification string provided by Pinterest to be included in the site metadata.|

View File

@ -40,6 +40,18 @@ To enable Plausible analytics support, simply provide the domain of the website
script = "https://plausible.yoursite.com/js/script.js"
```
### Umami Analytics
To enable support for Umami Analytics, insert the *tracking code token* provided by Umami into the `site` parameter to monitor the site. You can also insert a `region` parameter to indicate the region of Umami Analytics servers that you want to connect to. The values can be `eu` or `us`. Refer to [getting started section at umami.is](https://umami.is/docs/getting-started) for more details.
```toml
# config/_default/params.toml
[umamiAnalytics]
site = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
region = "eu" # can be either "eu" or "us"
```
### Google Analytics
Google Analytics support is provided through the internal Hugo partial. Simply provide the `googleAnalytics` key in the `config/_default/config.toml` file and the script will be added automatically.

View File

@ -10,5 +10,15 @@
src="{{ default "https://plausible.io/js/script.js" site.Params.plausibleAnalytics.script }}"
></script>
{{ end }}
{{ with site.Params.umamiAnalytics }}
{{- $region := "eu" }}
{{- if isset . "region" }}
{{- $region = .region }}
{{- end }}
<script defer
src="https://{{ $region }}.umami.is/script.js"
data-website-id="{{ .site }}">
</script>
{{ end }}
{{ template "_internal/google_analytics.html" . }}
{{ end }}