Skip to content

Include Clarity module #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markdumay merged 3 commits into from
Jan 5, 2025
Merged

Include Clarity module #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33ad042
Include Clarity module
markdumay Jan 5, 2025
2aad062
Merge branch 'main' into develop
markdumay Jan 5, 2025
780233d
Include Clarity module
markdumay Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/_default/params.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
caniuse_container = "https://caniuse.com/?search=%40container"
caniuse_webshare = "https://caniuse.com/?search=navigator.share"
cc_by_nc_4_0 = "https://creativecommons.org/licenses/by-nc/4.0/"
clarity_code = "https://learn.microsoft.com/en-us/clarity/setup-and-installation/clarity-setup#install-manually"
cloudflare = "https://cloudflare.com"
cloudinary = "https://cloudinary.com"
commit_message = "https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"
Expand Down
16 changes: 14 additions & 2 deletions content/en/docs/latest/configuration/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Modules
description: Customize and extend Hinode with Hugo modules.
date: 2024-10-21
date: 2025-01-05
layout: docs
---

Expand Down Expand Up @@ -67,6 +67,18 @@ For example, Bootstrap uses the following configuration in its module configurat

Several modules support additional, module-specific configurations. Review them in the next paragraphs.

### Clarity

> [!WARNING]
> This module assumes you have properly configured a Cookie Consent Manager. The Clarity script is assigned to the category `analytics`. Cookie consent is automatically given when this script is loaded. Do not load this script without explicit consent from the user. See the [Hinode docs](docs/configuration/cookie-consent/) for more details.

This module supports the following parameters (see the section `params.modules` in `config.toml`):

| Setting | Default | Description |
|---------------------------|---------|-------------|
| clarity.id | | Tracking code of Microsoft Clarity (see {{< link clarity_code >}}installation instructions{{< /link >}})
| clarity.force | false | Trigger to force include the analytics scripts, bypassing other settings. Use this setting for debugging and testing only. |

### CookieYes

{{< release version="v0.27.0" >}}
Expand Down Expand Up @@ -121,7 +133,7 @@ The `google-analytics` module supports the following additional settings:

| Setting | Default | Description |
|---------------------------|---------|-------------|
| GoogleAnalytics.local | false | Trigger to force include the analytics scripts, bypassing other settings. Use this setting for debugging and testing only. |
| GoogleAnalytics.force | false | Trigger to force include the analytics scripts, bypassing other settings. Use this setting for debugging and testing only. |

### Utils

Expand Down
40 changes: 19 additions & 21 deletions hugo_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,24 +524,23 @@
"multi-docs-collapse-16",
"multi-docs-collapse-18",
"multi-docs-collapse-2",
"multi-docs-collapse-23",
"multi-docs-collapse-24",
"multi-docs-collapse-25",
"multi-docs-collapse-26",
"multi-docs-collapse-27",
"multi-docs-collapse-28",
"multi-docs-collapse-3",
"multi-docs-collapse-30",
"multi-docs-collapse-33",
"multi-docs-collapse-35",
"multi-docs-collapse-4",
"multi-docs-collapse-43",
"multi-docs-collapse-45",
"multi-docs-collapse-5",
"multi-docs-collapse-53",
"multi-docs-collapse-55",
"multi-docs-collapse-6",
"multi-docs-collapse-7",
"multi-docs-collapse-77",
"multi-docs-collapse-79",
"multi-docs-collapse-8",
"multi-docs-collapse-9",
"multi-docs-collapse-92",
"multi-docs-collapse-94",
"multi-file-collapse-1",
"multi-file-collapse-10",
"multi-file-collapse-11",
Expand Down Expand Up @@ -980,24 +979,23 @@
"body-docs-collapse-16",
"body-docs-collapse-18",
"body-docs-collapse-2",
"body-docs-collapse-23",
"body-docs-collapse-24",
"body-docs-collapse-25",
"body-docs-collapse-26",
"body-docs-collapse-27",
"body-docs-collapse-28",
"body-docs-collapse-3",
"body-docs-collapse-30",
"body-docs-collapse-33",
"body-docs-collapse-35",
"body-docs-collapse-4",
"body-docs-collapse-43",
"body-docs-collapse-45",
"body-docs-collapse-5",
"body-docs-collapse-53",
"body-docs-collapse-55",
"body-docs-collapse-6",
"body-docs-collapse-7",
"body-docs-collapse-77",
"body-docs-collapse-79",
"body-docs-collapse-8",
"body-docs-collapse-9",
"body-docs-collapse-92",
"body-docs-collapse-94",
"body-file-collapse-1",
"body-file-collapse-10",
"body-file-collapse-11",
Expand Down Expand Up @@ -1053,6 +1051,7 @@
"categorizing-scripts",
"center-coordinates",
"check-our-guides-to-get-you-started",
"clarity",
"cloudinary",
"code-blocks",
"code-snipppet-with-filename-only",
Expand Down Expand Up @@ -1273,24 +1272,23 @@
"footer-docs-collapse-16",
"footer-docs-collapse-18",
"footer-docs-collapse-2",
"footer-docs-collapse-23",
"footer-docs-collapse-24",
"footer-docs-collapse-25",
"footer-docs-collapse-26",
"footer-docs-collapse-27",
"footer-docs-collapse-28",
"footer-docs-collapse-3",
"footer-docs-collapse-30",
"footer-docs-collapse-33",
"footer-docs-collapse-35",
"footer-docs-collapse-4",
"footer-docs-collapse-43",
"footer-docs-collapse-45",
"footer-docs-collapse-5",
"footer-docs-collapse-53",
"footer-docs-collapse-55",
"footer-docs-collapse-6",
"footer-docs-collapse-7",
"footer-docs-collapse-77",
"footer-docs-collapse-79",
"footer-docs-collapse-8",
"footer-docs-collapse-9",
"footer-docs-collapse-92",
"footer-docs-collapse-94",
"footer-file-collapse-1",
"footer-file-collapse-10",
"footer-file-collapse-11",
Expand Down
Loading