termina-plex 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34b78c3a731e07f7c2a644747ad7f47e9e0640aa2007345fdc709b2eea9fd7c
-  data.tar.gz: ef2fc0c4927ff728e651a10b4408ea23fda488c2c3ba38e8b6acb94dc202c460
+  metadata.gz: f135e760039f4a54acb6c72d5134c34ab93e9a0042659ca5cdfa697df04361c1
+  data.tar.gz: 6c0044d62d44e1b54b17d5da0dc12fae6bd09ad72cf52e94ae38406b49c03a92
 SHA512:
-  metadata.gz: 36ece857dac42b6bcfdc927653ad6a6166c089252b9078890d2ba38a5f9613995f5a9c4f2359de1891dad429a0a2f32a132c9024cad6e9ee66d9b9390754396c
-  data.tar.gz: 6d2ce8f242da9043989e0612bfa0c1b0068745c7178212434ee47f08e75ad87f03d12dbcf51e42cc1b3ae4834d34d39019f0dfbf4182dafdbe10ee85b516557a
+  metadata.gz: ae3d03a1716dc9303a8b76606a120c729080646f3bcaf77d88993d1fbccb0a17a1cd2d18bb700598444890ca1c0e5ab51df02191ba64671948240cc158367d21
+  data.tar.gz: 80aa4efd0ad4a97ae03138457ebf41a156521c2e17ec0e2eea57279e0ab555f93f37a5271daaadd8da54695aa1d1c0dbf5ebcd66f327b71c8bd69074de9a2ba0

data/README.md

@@ -36,9 +36,43 @@ For pagination to work with the post listing page hosted under `/blog`, the `pag
 
 If you want to change the path for the post listing page, the `blog_path` setting can be set to the preferred path. The `paginate_path` setting should also be updated to reflect the correct path.
 
+## Google and Umami Analytics
+
+This theme provides support for Google and Umami Analytics by setting appropriate site configuration values.
+
+### Google Analytics
+
+To automatically add the necessary Google tag to the site, add the following line to the top level of `_config.yml`:
+
+```yaml
+google_analytics: G-XXXXX
+```
+
+Replace `G-XXXXX` with the appropriate measurement ID.
+
+### Umami Analytics
+
+To automatically add the necessary Umami analytics tag to the site, add the following lines to the top level of `_config.yml`:
+
+```yaml
+umami_analytics:
+  url: "https://example.org/umami.js"
+  data_website_id: "abc"
+```
+
+Replace the `url` and `data_website_id` with the appropriate values for your Umami Analytics instance.
+
+Additional parameters can be set in the tag by providing the appropriate values for the following keys under `umami_analytics`:
+
+| Umami Tag Parameter | Site Configuration |
+| --- | --- |
+| data-host-url | data_host_url |
+| data-auto-track | data_auto_track |
+| data-domains | data_domains |
+
 ## Theme Configuration
 
-Theme specific configuration is done within the `termina-plex` section of the `_config.yaml` file.
+Theme specific configuration is done within the `termina-plex` section of the `_config.yml` file.
 
 The date format used by the theme is defined by the `termina-plex.date_format` setting. The value needs to be in [valid `strftime` format](https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html). The theme defaults to `%d %b %Y`.
 
@@ -50,6 +84,8 @@ The social links displayed under the site title in the main section of the landi
 
 If centered tables are preferred, the `termina-plex.centered_tables` setting can be set to `true`. By default, it uses the user agent's default alignment.
 
+By default, the theme will transform post titles to be capitalized on pages that use the `home` layout. If you prefer to have post titles not be transformed, you can set `termina-plex.standard_titles` to `true`.
+
 ## Screenshots
 
 ![Screenshot of the Termina Plex theme for Jekyll showing the landing page in dark mode](/screenshots/termina-plex-01-landing-page-dark.png)

data/_includes/head.html

@@ -8,6 +8,9 @@
   {%- if jekyll.environment == 'production' and site.google_analytics -%}
     {%- include google-analytics.html -%}
   {%- endif -%}
+  {%- if site.umami_analytics.url and site.umami_analytics.data_website_id -%}
+    {%- include umami-analytics.html -%}
+  {%- endif -%}
 
-  {%- include custom-head.html -%}
+  {%- include custom-head.html %}
 </head>

data/_includes/umami-analytics.html

@@ -0,0 +1,16 @@
+{%- if site.umami_analytics.url and site.umami_analytics.data_website_id %}
+<script
+  defer
+  src="{{ site.umami_analytics.url }}"
+  data-website-id="{{ site.umami_analytics.data_website_id }}"
+  {%- if site.umami_analytics.data_host_url %}
+  data-host-url="{{ site.umami_analytics.data_host_url }}"
+  {%- endif -%}
+  {%- if site.umami_analytics.data_auto_track %}
+  data-auto-track="{{ site.umami_analytics.data_auto_track }}"
+  {%- endif -%}
+  {%- if site.umami_analytics.data_domains %}
+  data-domains="{{ site.umami_analytics.data_domains }}"
+  {%- endif -%}
+></script>
+{%- endif %}

data/_layouts/home.html

@@ -7,7 +7,8 @@ layout: base
     {%- assign posts = site.posts -%}
 {% endif %}
 {%- assign date_format = site.termina-plex.date_format | default: "%d %b %Y" -%}
-{%- assign blog_path = site.blog_path | default: "/blog" %}
+{%- assign blog_path = site.blog_path | default: "/blog" -%}
+{%- assign standard_titles = site.termina-plex.standard_titles -%}
 
 <article class="postWrapper">
   <header class="postHeader">
@@ -18,7 +19,11 @@ layout: base
   <div class="postsEntries">
     {%- for post in posts -%}
     <div class="postInfo">
+      {%- if standard_titles -%}
       <h2 class="postTitle">
+      {%- else -%}
+      <h2 class="postTitle capitalize-title">
+      {%- endif -%}
         <a class="postListLink" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
       </h2>
       {%- if post.date -%}

data/_sass/termina-plex/layout/posts.scss

@@ -18,12 +18,15 @@
   font-family: $header-font-family;
   font-size: 1.2em;
   font-weight: 400;
-  text-transform: capitalize;
   float: left;
   width: 75%;
   margin: 0 0 1rem 0;
 }
 
+.postTitle.capitalize-title {
+  text-transform: capitalize;
+}
+
 .postHeader {
   overflow: hidden;
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termina-plex
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Linh Pham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -111,6 +111,7 @@ files:
 - _includes/header.html
 - _includes/tag-archive.html
 - _includes/theme-toggle.html
+- _includes/umami-analytics.html
 - _layouts/base.html
 - _layouts/category.html
 - _layouts/home.html