Skip to content

📝 Document cookie notice configuration and example usage #2906

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

Open
aplgr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝 Document cookie notice configuration and example usage #2906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions exampleSite/config/_default/params.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,12 @@ fingerprintAlgorithm = "sha512" # Valid values are "sha512" (default), "sha384",

[advertisement]
# adsense = ""

[cookieNotice]
enabled = false
style = "simple" # valid options: simple
storage = "localStorage" # valid options: localStorage, sessionStorage
storageKey = "blowfish_cookie_notice_ack_v1"
# privacyPolicyPageRef = "/privacy-policy"
# image = "img/cookie-notice/cookie.svg"
# imageAlt = ""
27 changes: 27 additions & 0 deletions exampleSite/content/docs/configuration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,33 @@ Many of the article defaults here can be overridden on a per article basis by sp
| `footer.showAppearanceSwitcher` | `false` | Whether or not to show the appearance switcher in the site footer. The browser's local storage is used to persist the visitor's preference. |
| `footer.showScrollToTop` | `true` | When set to `true` the scroll to top arrow is displayed. |

### Cookie notice

Blowfish provides an optional minimal cookie notice banner.

This is an MVP-style notice banner, not a full consent manager. It is intended as a lightweight built-in option for sites that want to show a simple notice banner with a dismiss action. The dismissed state can be stored in browser storage and the privacy policy link can be resolved from an internal page reference, which works well for multilingual sites.

| Name | Default | Description |
| --- | --- | --- |
| `cookieNotice.enabled` | `false` | Whether to enable the built-in cookie notice banner. |
| `cookieNotice.style` | `"simple"` | Controls which cookie notice partial is rendered. Currently supported: `simple`. |
| `cookieNotice.storage` | `"localStorage"` | Controls where the dismissed state is stored. Valid values are `localStorage` and `sessionStorage`. |
| `cookieNotice.storageKey` | `"blowfish_cookie_notice_ack_v1"` | Storage key used to persist the dismissed state. Change this value to force the banner to reappear for returning visitors. |
| `cookieNotice.privacyPolicyPageRef` | _Not set_ | Internal page reference to the privacy policy page. This is resolved via Hugo page lookup and allows the correct language-specific URL to be generated automatically. |
| `cookieNotice.image` | _Not set_ | Optional image path for the cookie notice banner. |
| `cookieNotice.imageAlt` | _Not set_ | Optional alt text override for the cookie notice image. If omitted, the translated default alt text will be used. |

```toml
[cookieNotice]
enabled = true
style = "simple"
storage = "localStorage" # valid options: localStorage, sessionStorage
storageKey = "blowfish_cookie_notice_ack_v1"
privacyPolicyPageRef = "/privacy-policy"
image = "img/cookie-notice/cookie.svg"
imageAlt = ""
```

### Homepage

| Name | Default | Description |
Expand Down