jekyll-theme-console 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce79df1a37fb335f98b3c8bdd335e79d92ef57f46912da2b38fa582a3bd9829
-  data.tar.gz: ce234b9afbba1c227555777092bd70f527b4e4f24eed098dcb18234684f3ff71
+  metadata.gz: 76aace9cca1cba808b2ab9a9879320cf0485ac71fac5de9ccb5f0712a9cc8dd4
+  data.tar.gz: 389629ffe06d9651ed0ca4d80cb64dde233bd6ae6c6a6b9a750113a879b19860
 SHA512:
-  metadata.gz: 5e4108a94e6c68a654c8feef20787ea538bd7a3197ead66723ebd85efc6472e47b0dbdbf8fd4002c41ab97763762173b0c09dab8ae26acafd3c8908b7e792ff1
-  data.tar.gz: 9cbd86883fb80275e010148b363993629d15243b62c3bdf7c916d6a0bac8a4ab33727ac3fc5cabd5592bec3706e86a8194224b108ffb36112cb98a4060cfc9b5
+  metadata.gz: dd48dfdff02290eb74f67f554e07ea244f0b47ede559e217c507cd480429cb6fbd60650a36ae00967fe3920b9248bae402134b0eed5f39164c4318b86819b314
+  data.tar.gz: 47f2ccd5eaf425970f280c3f65dd31d1e7406aef6e9df7f6a67aa116561501839f7604665cb2e25e1de6ae2cb20a59a220fea496d6bab0cfa4511e85b3149eec

data/README.md

@@ -70,10 +70,10 @@ To update the theme run `bundle update`.
 In addition to jekyll's default configuration options, you can provide:
 - `header_pages`: list of pages displayed in the navbar
 - `footer`: HTML string inserted at the end of the page
-- `google_analytics`: tracking id (only loaded in production when set)
 - `listen_for_clients_preferred_style`: allow users to pick light/dark based on OS preference
 - `style`: predefined color style (`dark` default, or `light`, `hacker`)
 - `disable_google_fonts`: set `true` to avoid loading fonts from Google and use system fonts only
+- `tracking`: generic tracking config for any provider (Matomo, Plausible, etc.). See below.
 
 ```yaml
 header_pages:
@@ -84,9 +84,18 @@ style: dark # dark (default), light or hacker
 listen_for_clients_preferred_style: true # false (default) or true
 
 footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
-
-google_analytics: UA-NNNNNNNN-N
 disable_google_fonts: false
+
+# Generic tracking (optional; loads only in production)
+# tracking:
+#   script_src:
+#     - https://cdn.example.com/tracker.js
+#   async: true   # default true
+#   defer: false  # default false
+#   # Optional inline init snippet (requires CSP allowance if used)
+#   # init: |
+#   #   window.myTracker=window.myTracker||function(){(window.myTracker.q=window.myTracker.q||[]).push(arguments)};
+#   #   myTracker('init', { siteId: '12345' });
 ```
 
 ### front matter variables
@@ -122,14 +131,34 @@ If you want to customize this theme, follow this steps:
 This theme ships with a strict but practical CSP to improve security. By default it allows:
 - self-hosted content plus images from `https:` and `data:` URIs
 - Google Fonts (if not disabled)
-- Google Analytics (only when `google_analytics` is set, including inline init script)
 
-If you need additional sources (e.g., to embed iframes), extend the policy via `_config.yml`:
+If you need additional sources (e.g., analytics beacons, external scripts, iframes), extend the policy via `_config.yml`:
 
 ```yaml
 csp_extra: "frame-src https:;"
 ```
 
+Examples:
+
+- Allow a Matomo/PIWIK setup hosted at `https://analytics.example.com`:
+
+  ```yaml
+  tracking:
+    script_src:
+      - https://analytics.example.com/matomo.js
+  # If you add an inline init snippet via `tracking.init`, also include 'unsafe-inline' in script-src.
+  csp_extra: "script-src 'self' https://analytics.example.com 'unsafe-inline'; connect-src 'self' https://analytics.example.com; img-src 'self' https://analytics.example.com;"
+  ```
+
+- Allow Plausible (self-hosted at `https://plausible.example.com`):
+
+  ```yaml
+  tracking:
+    script_src:
+      - https://plausible.example.com/js/plausible.js
+  csp_extra: "script-src 'self' https://plausible.example.com; connect-src 'self' https://plausible.example.com;"
+  ```
+
 Tip: To remove the top border line in the menu, override CSS in your site (e.g., add a small stylesheet) with:
 
 ```css

data/_includes/head.html

@@ -30,7 +30,7 @@
   {%- endif -%}
   {%- endif -%}
 
-  {%- if jekyll.environment == 'production' and site.google_analytics -%}
-  {%- include google-analytics.html -%}
+  {%- if jekyll.environment == 'production' and site.tracking -%}
+  {%- include tracker.html -%}
   {%- endif -%}
 </head>

data/_includes/tracker.html

@@ -0,0 +1,32 @@
+{%- comment -%}
+  Generic tracker include.
+  Configure in _config.yml under `tracking`:
+    tracking:
+      script_src: "https://example.com/tracker.js" # or an array of URLs
+      async: true   # optional, default: true
+      defer: false  # optional
+      init: |
+        // Optional inline init snippet for your tracker
+        // e.g., window.myTracker('init', { siteId: '123' });
+
+  Notes:
+  - This file renders only in production (see head.html).
+  - If you use external scripts or inline init, you likely need to extend
+    the CSP via `csp_extra` in _config.yml (script-src/connect-src, etc.).
+{%- endcomment -%}
+
+{%- assign async_attr = site.tracking.async | default: true -%}
+{%- assign defer_attr = site.tracking.defer | default: false -%}
+
+{%- if site.tracking.script_src -%}
+  {%- assign _srcs = site.tracking.script_src -%}
+  {%- for s in _srcs -%}
+<script{% if async_attr %} async{% endif %}{% if defer_attr %} defer{% endif %} src="{{ s }}"></script>
+  {%- endfor -%}
+{%- endif -%}
+
+{%- if site.tracking.init -%}
+<script>
+{{ site.tracking.init }}
+</script>
+{%- endif -%}

data/_layouts/default.html

@@ -2,8 +2,9 @@
 <html lang="{{ page.lang | default: site.lang | default: 'en' }}">
 {%- comment -%}
   Build a practical CSP. It remains strict by default while allowing
-  common use cases: external images and Google Fonts. If Google Analytics
-  is enabled, allow its domains and inline init script.
+  common use cases like external images and Google Fonts.
+  If you need to permit additional script/connect sources (e.g., analytics),
+  extend via `csp_extra` in your _config.yml.
 {%- endcomment -%}
 {%- capture csp -%}
 default-src 'none';
@@ -16,11 +17,7 @@ font-src 'self' https://fonts.gstatic.com data:;
 media-src 'self';
 object-src 'none';
 child-src 'self';
-{%- if jekyll.environment == 'production' and site.google_analytics -%}
-script-src 'self' https://www.googletagmanager.com 'unsafe-inline';
-{%- else -%}
 script-src 'self';
-{%- endif -%}
 {%- endcapture -%}
 {%- capture csp_final -%}{{ csp | strip | replace: '\n', ' ' }} {%- if site.csp_extra %} {{ site.csp_extra }}{%- endif -%}{%- endcapture -%}
 <meta http-equiv="Content-Security-Policy" content="{{ csp_final | strip }}" />

data/assets/main-dark.scss

@@ -2,7 +2,8 @@
 # Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@use "dark";
-@use "base";
+// Use @import for compatibility with GitHub Pages (libsass)
+@import "dark";
+@import "base";
 
-@include dark.theme();
+@include theme();

data/assets/main-hacker.scss

@@ -2,7 +2,8 @@
 # Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@use "hacker";
-@use "base";
+// Use @import for compatibility with GitHub Pages (libsass)
+@import "hacker";
+@import "base";
 
-@include hacker.theme();
+@include theme();

data/assets/main-light.scss

@@ -2,7 +2,8 @@
 # Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@use "light";
-@use "base";
+// Use @import for compatibility with GitHub Pages (libsass)
+@import "light";
+@import "base";
 
-@include light.theme();
+@include theme();

data/assets/main-nord.scss

@@ -2,7 +2,8 @@
 # Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@use "nord";
-@use "base";
+// Use @import for compatibility with GitHub Pages (libsass)
+@import "nord";
+@import "base";
 
-@include nord.theme();
+@include theme();

data/assets/main.scss

@@ -2,12 +2,15 @@
 # Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@use "light";
-@use "dark";
-@use "base";
+// Use @import for compatibility with GitHub Pages (libsass)
+@import "base";
 
-@include light.theme();
+// Import light theme and include its variables first
+@import "light";
+@include theme();
 
+// Then import dark theme and include inside media query
+@import "dark";
 @media (prefers-color-scheme: dark) {
-  @include dark.theme();
+  @include theme();
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-console
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - b2a3e8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-31 00:00:00.000000000 Z
+date: 2025-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -76,9 +76,9 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/footer.html
-- _includes/google-analytics.html
 - _includes/head.html
 - _includes/header.html
+- _includes/tracker.html
 - _layouts/default.html
 - _layouts/home.html
 - _layouts/page.html

data/_includes/google-analytics.html

@@ -1,8 +0,0 @@
-<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
-<script>
-  window['ga-disable-{{ site.google_analytics }}'] = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
-  window.dataLayer = window.dataLayer || [];
-  function gtag(){dataLayer.push(arguments);}
-  gtag('js', new Date());
-  gtag('config', '{{ site.google_analytics }}');
-</script>