https://github.com/gethinode/mod-google-analytics
A Hugo module to add Google Analytics to your Hinode site
https://github.com/gethinode/mod-google-analytics
Last synced: 11 days ago
JSON representation
A Hugo module to add Google Analytics to your Hinode site
- Host: GitHub
- URL: https://github.com/gethinode/mod-google-analytics
- Owner: gethinode
- License: mit
- Created: 2024-09-15T09:00:45.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-21T06:50:54.000Z (13 days ago)
- Last Synced: 2025-04-21T07:44:46.196Z (13 days ago)
- Language: JavaScript
- Homepage:
- Size: 352 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hinode Module - Google Analytics
A Hugo module to add Google Analytics to your Hinode site
## About
Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Hinode is available as a [template][repository_template], and a [main theme][repository]. This repository maintains a Hugo module to enable [Google Analytics][google-analytics], part of the Google Marketing Platform, for a Hinode site. Visit the Hinode documentation site for [installation instructions][hinode_docs].
## Contributing
This module uses [semantic-release][semantic-release] to automate the release of new versions. The package uses `husky` and `commitlint` to ensure commit messages adhere to the [Conventional Commits][conventionalcommits] specification. You can run `npx git-cz` from the terminal to help prepare the commit message.
## Configuration
> [!NOTE]
> By convention, Hinode uses kebab case as naming convention for module names. However, the module name in the site parameters is renamed to `GoogleAnalytics` to align with Hugo's privacy settings.
Set you `G-tag` in your site configuration (usually `hugo.toml`) in the following section:
```toml
[services]
[services.googleAnalytics]
ID = "G-xxxxxxxxxx"
```
You can modify the privacy configuration in the following section:
```toml
[privacy]
[privacy.googleAnalytics]
disable = false
respectDoNotTrack = false
```
This module supports the following parameters (see the section `params.modules` in `config.toml`):
| Setting | Default | Description |
|---------------------------|---------|-------------|
| GoogleAnalytics.force | false | Trigger to force include the analytics scripts, bypassing other settings. Use this setting for debugging and testing only. |
| GoogleAnalytics.gcm | false | Trigger to enable Google Consent Mode v2 (advanced mode). |
| GoogleAnalytics.nonce | false | Trigger to pass nonces to tag manager, only applicable when GCM is enabled. See [Google documentation][google-csp] for more details. |
## Google Consent Mode v2
This module supports Google Consent Mode v2. Use the following parameters in your site configuration to enable this.
> [!WARNING]
> Make sure you have properly configured Cookie Consent before enabling GCMv2.
```toml
[params.modules.GoogleAnalytics]
integration = "critical"
state = "immediate"
category = "necessary"
gcm = true
nonce = false
```
## Content Security Policy
The module includes the policies required for Google Tag Manager's Preview Mode and Google Analytics 4. Review [Google's Content Security Policy][google-csp] to review the settings required for Google Ads, Google Ads User Data Beacon, Floodlight, and Service Worker.
[hugo]: https://gohugo.io
[hinode_docs]: https://gethinode.com
[google-analytics]: https://marketingplatform.google.com
[google-csp]: https://developers.google.com/tag-platform/security/guides/csp
[repository]: https://github.com/gethinode/hinode.git
[repository_template]: https://github.com/gethinode/template.git
[conventionalcommits]: https://www.conventionalcommits.org
[husky]: https://typicode.github.io/husky/
[semantic-release]: https://semantic-release.gitbook.io/