Add Umami Analytics info to the documentation (in the english version) 📝

jpanther · Mar 17, 2024 · 7856046 · 7856046
1 parent c816c5f
commit 7856046
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md
@@ -175,6 +175,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.|

diff --git a/exampleSite/content/docs/partials/index.md b/exampleSite/content/docs/partials/index.md
@@ -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.