termina-plex 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3191be0873ad818c702c14a73f27416b07493521b34d6d4bf38cbe5f1649ee7d
-  data.tar.gz: 2dea759a907ff919189b21123c6215cfc2ad9311ce48aef8dca9da5f3b3b30dd
+  metadata.gz: '0382d5026093da2e77fe845f6463e84e94ca74ce70745f1b97d4db13c88fa230'
+  data.tar.gz: 356f6d20115f8f4627885126d115418f4c2bf58075240ca957a40b8e52a5ed7e
 SHA512:
-  metadata.gz: ce516d997c7f4429acc38d33feb76ef45673879ef9bad0c1df614860a29874ac7e7b3d0be82f4489f9d5420e3fc3e87923385358093297a2cc97b35a221dfb13
-  data.tar.gz: 469abddfad9057fa6218e7b4cc007adaf1483a9940652d31c056202f7770a4093669d59f9694b7c94d892c7bff9bb06c4fcc040491dbf5cce2426b89e1cd7bf0
+  metadata.gz: 42cd7d44baa4e1075f60f2c1d7379ff130a84bcebfd8893bd7904d06f978a3fa27ee6dbeaff0a6aab8c7edd9c5a55d2d2ec77cd8bb384e69197590234658cfa2
+  data.tar.gz: 2092b698f05274193c1e1e170b87907da2dc7d159a5557e7504adb1350507a837a341eadefc975a5d673ec5fd70b017ae1854686293294497930ddd56a760ec5

data/README.md

@@ -36,9 +36,47 @@ 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.
 
+## Index Page Author Pronouns
+
+Author pronouns set using the `site.author.pronouns` configuration setting and will be displayed below the author name on pages that use the `index` layout.
+
+## 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`.
 

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/index.html

@@ -10,7 +10,10 @@
         <main class="main">
           <div class="indexWrapper">
             <div>
-              <h1 class="indexHeader">{{ site.author.name }}</h1>
+              <h1 class="indexHeader">
+                {{ site.author.name }}
+                {%- if site.author.pronouns -%}<div class="authorPronouns">{{ site.author.pronouns }}</div>{%- endif -%}
+              </h1>
             </div>
             {%- if site.termina-plex.social_links -%}
             <div class="socialNavbar">

data/_sass/termina-plex/pages/index.scss

@@ -10,3 +10,16 @@
 .indexHeader {
   font-size: 3em;
 }
+
+.indexHeader .authorPronouns {
+  font-style: italic;
+  font-size: 50%;
+}
+
+.authorPronouns::before {
+  content: "("
+}
+
+.authorPronouns::after {
+  content: ")"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termina-plex
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Linh Pham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-08-03 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