From d52f721c419cca50ef841d693cdd3a69d170cafb Mon Sep 17 00:00:00 2001 From: Weaxs <459312872@qq.com> Date: Fri, 26 Jul 2024 17:04:18 +0800 Subject: [PATCH] enableTrackEvent default true && documents --- config/_default/params.toml | 4 ++-- .../content/docs/configuration/index.it.md | 8 +++++++ .../content/docs/configuration/index.ja.md | 8 +++++++ .../content/docs/configuration/index.md | 15 +++++++++---- .../content/docs/configuration/index.zh-cn.md | 18 ++++++++++----- exampleSite/content/docs/partials/index.it.md | 20 +++++++++++++++++ exampleSite/content/docs/partials/index.ja.md | 20 +++++++++++++++++ exampleSite/content/docs/partials/index.md | 22 +++++++++++++++++++ .../content/docs/partials/index.zh-cn.md | 22 +++++++++++++++++++ layouts/partials/analytics/seline.html | 2 +- layouts/partials/analytics/umami.html | 2 +- 11 files changed, 128 insertions(+), 13 deletions(-) diff --git a/config/_default/params.toml b/config/_default/params.toml index 25ba3941..b75b946d 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -135,11 +135,11 @@ disableTextInHeader = false # websiteid = "ABC12345" # domain = "llama.yoursite.com" # dataDomains = "yoursite.com,yoursite2.com" - # enableTrackEvent = false + # enableTrackEvent = true [selineAnalytics] # token = "XXXXXX" - # enableTrackEvent = false + # enableTrackEvent = true [buymeacoffee] # identifier = "" diff --git a/exampleSite/content/docs/configuration/index.it.md b/exampleSite/content/docs/configuration/index.it.md index 7ff3a897..bdbeb0fb 100644 --- a/exampleSite/content/docs/configuration/index.it.md +++ b/exampleSite/content/docs/configuration/index.it.md @@ -323,6 +323,14 @@ Many of the article defaults here can be overridden on a per article basis by sp | `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | | `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. | | `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". | +| `umamiAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | + +### Seline Analytics + +| Name | Default | Description | +|-----------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------| +| `selineAnalytics.token` | _Not set_ | The token generated by Seline Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | +| `selineAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | ### BuyMeACoffee diff --git a/exampleSite/content/docs/configuration/index.ja.md b/exampleSite/content/docs/configuration/index.ja.md index a9483139..893e58ff 100644 --- a/exampleSite/content/docs/configuration/index.ja.md +++ b/exampleSite/content/docs/configuration/index.ja.md @@ -322,6 +322,14 @@ Many of the article defaults here can be overridden on a per article basis by sp | `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | | `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. | | `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". | +| `umamiAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | + +### Seline Analytics + +| Name | Default | Description | +|-----------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------| +| `selineAnalytics.token` | _Not set_ | The token generated by Seline Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | +| `selineAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | ### BuyMeACoffee diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md index 7b3ce190..5f508b41 100644 --- a/exampleSite/content/docs/configuration/index.md +++ b/exampleSite/content/docs/configuration/index.md @@ -318,12 +318,19 @@ Many of the article defaults here can be overridden on a per article basis by sp ### Umami Analytics -| Name | Default | Description | -| -------------------------- | --------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | -| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. | +| Name | Default | Description | +| -------------------------- |-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | +| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. | | `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". | +| `umamiAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | +### Seline Analytics + +| Name | Default | Description | +|-----------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------| +| `selineAnalytics.token` | _Not set_ | The token generated by Seline Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. | +| `selineAnalytics.enableTrackEvent` | true | When set to `true` track event will add automatically. If you do not want to add track event, set it to `false`. | ### BuyMeACoffee diff --git a/exampleSite/content/docs/configuration/index.zh-cn.md b/exampleSite/content/docs/configuration/index.zh-cn.md index aa8ef1f9..f85ef087 100644 --- a/exampleSite/content/docs/configuration/index.zh-cn.md +++ b/exampleSite/content/docs/configuration/index.zh-cn.md @@ -321,11 +321,19 @@ Blowfish 提供了大量控制主题功能的配置参数，下面的表格中 ### Umami Analytics -| Name | Default | Description | -| -------------------------- | --------- |-------------------------------------------------------------------------------------| -| `umamiAnalytics.websiteid` | _Not set_ | 支持 Umami 站点分析平台。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 | -| `umamiAnalytics.domain` | _Not set_ | 如果使用自定义域名的 Umami Analytics，请在此提供，以便从自定义域名获取 `script.js`。 | -| `umamiAnalytics.dataDomains` | _Not set_ | 如果你只想在特别的数个域名中使用 tracker 功能，那么你需要设置它。这个参数的值是逗号分隔的域名列表，如：yoursite.com,yoursite2.com。 | +| Name | Default | Description | +|------------------------------|-----------|-------------------------------------------------------------------------------------| +| `umamiAnalytics.websiteid` | 无 | 支持 Umami 站点分析平台。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 | +| `umamiAnalytics.domain` | 无 | 如果使用自定义域名的 Umami Analytics，请在此提供，以便从自定义域名获取 `script.js`。 | +| `umamiAnalytics.dataDomains` | 无 | 如果你只想在特别的数个域名中使用 tracker 功能，那么你需要设置它。这个参数的值是逗号分隔的域名列表，如：yoursite.com,yoursite2.com。 | +| `umamiAnalytics.enableTrackEvent` | true | 默认会自动添加 Umami Track Event。如果你不想添加 Event，那学需要设置为 `false`。 | + +### Seline Analytics + +| Name | Default | Description | +|-----------------------------------|---------|--------------------------------------------------------------------------| +| `selineAnalytics.token` | 无 | Seline 站点分析平台的 token。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 | +| `selineAnalytics.enableTrackEvent` | true | 默认会自动添加 Umami Track Event。如果你不想添加 Event，那学需要设置为 `false`。 | ### BuyMeACoffee diff --git a/exampleSite/content/docs/partials/index.it.md b/exampleSite/content/docs/partials/index.it.md index 11911ae9..35da150d 100644 --- a/exampleSite/content/docs/partials/index.it.md +++ b/exampleSite/content/docs/partials/index.it.md @@ -46,6 +46,10 @@ To enable Umami Analytics support, simply provide your [Umami tracking code](htt If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is). If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match. +{{< alert >}} +**Note:** If you enable Umami Analytics, Blowfish will support [Umami Track Event](https://umami.is/docs/track-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + ```toml # config/_default/params.toml @@ -53,8 +57,24 @@ If you want the tracker to only run on specific domains, you can provide the `da websiteid = "ABC12345" domain = "llama.yoursite.com" dataDomains = "yoursite.com,yoursite2.com" + enableTrackEvent = true ``` +### Seline Analytics + +To enable Seline Analytics support, simply provide your [Seline token](https://seline.so/docs/install-seline) in the `config/_default/params.toml` file. + +{{< alert >}} +**Note:** If you enable Seline Analytics, Blowfish will support [Seline Track Event](https://seline.so/docs/custom-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + +```toml +# config/_default/params.toml + +[selineAnalytics] + token = "XXXXXX" + enableTrackEvent = true +``` ### Custom analytics providers If you wish to use a different analytics provider on your website you can also override the analytics partial and provide your own script. Simply create the file `layouts/partials/extend-head.html` in your project and it will automatically include it in the `` of the website. diff --git a/exampleSite/content/docs/partials/index.ja.md b/exampleSite/content/docs/partials/index.ja.md index 11911ae9..63e82666 100644 --- a/exampleSite/content/docs/partials/index.ja.md +++ b/exampleSite/content/docs/partials/index.ja.md @@ -46,6 +46,10 @@ To enable Umami Analytics support, simply provide your [Umami tracking code](htt If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is). If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match. +{{< alert >}} +**Note:** If you enable Umami Analytics, Blowfish will support [Umami Track Event](https://umami.is/docs/track-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + ```toml # config/_default/params.toml @@ -53,6 +57,22 @@ If you want the tracker to only run on specific domains, you can provide the `da websiteid = "ABC12345" domain = "llama.yoursite.com" dataDomains = "yoursite.com,yoursite2.com" + enableTrackEvent = true +``` + +### Seline Analytics + +To enable Seline Analytics support, simply provide your [Seline token](https://seline.so/docs/install-seline) in the `config/_default/params.toml` file. +{{< alert >}} +**Note:** If you enable Seline Analytics, Blowfish will support [Seline Track Event](https://seline.so/docs/custom-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + +```toml +# config/_default/params.toml + +[selineAnalytics] + token = "XXXXXX" + enableTrackEvent = true ``` ### Custom analytics providers diff --git a/exampleSite/content/docs/partials/index.md b/exampleSite/content/docs/partials/index.md index 3fc0b3b5..0366655a 100644 --- a/exampleSite/content/docs/partials/index.md +++ b/exampleSite/content/docs/partials/index.md @@ -45,6 +45,11 @@ googleAnalytics = "G-MEASUREMENT_ID" To enable Umami Analytics support, simply provide your [Umami tracking code](https://umami.is/docs/collect-data) in the `config/_default/params.toml` file. If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is). If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match. + +{{< alert >}} +**Note:** If you enable Umami Analytics, Blowfish will support [Umami Track Event](https://umami.is/docs/track-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + ```toml # config/_default/params.toml @@ -52,6 +57,23 @@ If you want the tracker to only run on specific domains, you can provide the `da websiteid = "ABC12345" domain = "llama.yoursite.com" dataDomains = "yoursite.com,yoursite2.com" + enableTrackEvent = true +``` + +### Seline Analytics + +To enable Seline Analytics support, simply provide your [Seline token](https://seline.so/docs/install-seline) in the `config/_default/params.toml` file. + +{{< alert >}} +**Note:** If you enable Seline Analytics, Blowfish will support [Seline Track Event](https://seline.so/docs/custom-events) automatically. If you do not want to support Track Event, the param `enableTrackEvent` must set to `false`. +{{< /alert >}} + +```toml +# config/_default/params.toml + +[selineAnalytics] + token = "XXXXXX" + enableTrackEvent = true ``` ### Custom analytics providers diff --git a/exampleSite/content/docs/partials/index.zh-cn.md b/exampleSite/content/docs/partials/index.zh-cn.md index 48295861..c376b10c 100644 --- a/exampleSite/content/docs/partials/index.zh-cn.md +++ b/exampleSite/content/docs/partials/index.zh-cn.md @@ -50,6 +50,11 @@ googleAnalytics = "G-MEASUREMENT_ID" 如果你想使用自定义域名来获取跟踪脚本， 那么需要提供 `domain` 参数，否则会从 Umami 云服务版的地址 (analytics.umami.is) 获取脚本。 如果你只想在特别的数个域名中使用 tracker 功能，那么需要提供 `dataDomains` 参数。否则任何一个匹配了 `websiteid` 和 `domain` 参数值的网站，Umami 脚本都会执行。 +{{< alert >}} +**Note:** 开启 Umami 网站分析后, Blowfish 会自动支持 [Umami 事件追踪](https://umami.is/docs/track-events)。如果你不想支持此功能，需要把参数 `enableTrackEvent` 设置为 `false`。 + +{{< /alert >}} + ```toml # config/_default/params.toml @@ -59,6 +64,23 @@ googleAnalytics = "G-MEASUREMENT_ID" dataDomains = "yoursite.com,yoursite2.com" ``` +### Seline + +只需要在 `config/_default/params.toml` 文件提供你的 [Seline token](https://seline.so/docs/install-seline)，就可以快速支持 Seline 站点分析。 + +{{< alert >}} +**Note:** 开启 Seline 网站分析后, Blowfish 会自动支持 [Seline 事件追踪](https://seline.so/docs/custom-events)。如果你不想支持此功能，需要把参数 `enableTrackEvent` 设置为 `false`。 +{{< /alert >}} + +```toml +# config/_default/params.toml + +[selineAnalytics] + token = "XXXXXX" + enableTrackEvent = true +``` + + ### 提供自定义站点分析 如果你想在你的网站提供其他站点分析，你可以自己提供脚本，并覆盖 Blowfish 主题中内置的 partial。 diff --git a/layouts/partials/analytics/seline.html b/layouts/partials/analytics/seline.html index adb2f64d..955d40a1 100644 --- a/layouts/partials/analytics/seline.html +++ b/layouts/partials/analytics/seline.html @@ -1,6 +1,6 @@ -{{ if .Site.Params.selineAnalytics.enableTrackEvent | default false }} +{{ if .Site.Params.selineAnalytics.enableTrackEvent | default true }} {{ end }} -{{ if .Site.Params.umamiAnalytics.enableTrackEvent | default false }} +{{ if .Site.Params.umamiAnalytics.enableTrackEvent | default true }}