jekyll-theme-nix 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f40c9abf12b9b0a2682935d71d972d20638ef679ff90d79deedd9720f8e57957
-  data.tar.gz: 9e2af799fe0563994ead0d004abf5b17dedda878450812594c1c764a862d2826
+  metadata.gz: d93def0d664f81c9cd3d6b933e4fabeb1c6058aab2ad32eaa785cc355bc9323d
+  data.tar.gz: 85fc670b4d1e8bc75aba456d8d4ab4bbceb933ae0d53c4000605bd91228c96bc
 SHA512:
-  metadata.gz: 6ab96342307ed9e93dfd9257e89f6d25d481ece5693c6d79124fa838c7a624d00c6521105762b406cdfc3f0543179461e0f3b22d6a0d7026e440cad13dc4badb
-  data.tar.gz: 2853cabd28e2d02b483507d9ec7df9344ca2b564374ef13baea02ddd6129261b03d5e9801db851b413bc620c226857f456c72eb456ac9c618b4e1d4c615f008d
+  metadata.gz: 34432d06a237257c66a9359303da2654aff873390f645e5d9e3ca0590d300d2dd901f64f274eba826c480829eea397bceaf5db6be6ca7b09695a2900cc402db2
+  data.tar.gz: 577cbff69a5b09d1efc48d120397a47cba64f4c4f6ad71031d2f01613a94153db0d60d2e3c4805d6cddf7768e4e5e4ebbb3ba31d2ee983549104eafaf5e92756

data/README.md

@@ -15,11 +15,11 @@ If this theme feels to bloated to you, you can try [“Nixer”](https://github.
 - Dark mode, because we want to be respectful
 - Posts
 - Pages, including custom error pages
-- No visible authors, categories, or tags
+- No visible authors, categories, or tags on posts and pages
 - No header or footer
 - No pagination for the home page
 - A feed.xml containing an Atom feed, but no JSON or outdated RSS feeds
-- A sitemap.xml, because search engines should index us
+- A sitemap.xml, because search engines should index us properly
 - No semantic info like Open Graph, Twitter cards, or JSON-LD, but inline Microdata
 
 ## Minutiae
@@ -48,7 +48,9 @@ Or, if you will, it could be UNIX without the “U”, because of the theme's so
 
 ## Installation
 
-Installation from Gem is recommended, but using a remote theme is also possible, even though it will increase build time a little, depending on your internet connection.
+Installation from Gem is recommended, but using a remote theme is also possible, even though it will increase build time a little, depending on your internet connection, because the theme will be downloaded during each build. Gems are installed locally.
+
+GitHub pages gem users need to use the remote theme method.
 
 ### Installation from Gem
 
@@ -64,7 +66,7 @@ And add this line to your Jekyll site's `_config.yml`:
 theme: jekyll-theme-nix
 ```
 
-Make sure that this is the only `theme:` in `_config.yml`. Afterwards run `bundle install`.
+Make sure that this is the only `theme:` in `_config.yml`, and that there are no other `remote-theme:`. Afterwards run `bundle install`, and `bundle update` to update it, if there's a new version.
 
 ### Installation as Remote Theme
 
@@ -86,6 +88,8 @@ Finally, add `jekyll-remote-theme` to your plugin section in `_config.yml` as we
 
 ## Feed.xml and Sitemap.xml
 
-Both are included in the theme and don't need dependencies to `jekyll-feed` or `jekyll-sitemap`. For a standard Jekyll installation, they work out-of-the-box.
+Both are included in the theme and don't need dependencies to `jekyll-feed` and `jekyll-sitemap` plugins. For a standard Jekyll installation, they work out-of-the-box if both files are copied to the Jekyll directory.
 
 If hosted with the Github pages plugin, those plugins are already included and will automatically be used instead. To overwrite this, both files have to be copied manually from the theme's repository root to the site's repository root.
+
+Because feeds are generated once, they can only support one icon, which why the light variant was chosen.

data/_config.yml

@@ -1,23 +1,42 @@
 ## Remove URL for Github Pages
 url: https://jekyll-theme-nix.michaelnordmeyer.com
-icon: /icon.webp
-icon_dark: /icon-dark.webp
-icon_type: image/webp
 title: Jekyll Theme Nix
 author:
   name: Michael Nordmeyer
   uri: https://jekyll-theme-nix.michaelnordmeyer.com
 description: "A barebones theme for Jekyll"
 
-timezone: Europe/Berlin
-ignore_theme_config: true
-exclude: [jekyll-theme-nix*, LICENSE, README.md]
-date_format: "%Y-%m-%d"
-
 plugins:
   - jekyll-include-cache
   # - jekyll-redirect-from
 
 ## Jekyll build settings
+exclude: [jekyll-theme-nix*, LICENSE, Rakefile.rb, README.md]
+ignore_theme_config: true # Since Jekyll 4.0, see: https://jekyllrb.com/docs/themes/#pre-configuring-theme-gems40, https://jekyllrb.com/docs/configuration/options/
 kramdown:
   show_warnings: true
+  syntax_highlighter_opts:
+    disable: true
+liquid:
+  # Configure Liquid’s parser
+  error_mode: strict # default: warn
+  # Configure Liquid’s renderer
+  strict_filters: true # default: false
+  # strict_variables: true # default: false
+sass:
+  style: compressed
+strict_front_matter: true # default: false
+timezone: Europe/Berlin # default: local timezone
+# remote_theme: michaelnordmeyer/jekyll-theme-nix
+# theme: jekyll-theme-nix
+
+## Custom theme settings to not overwrite anything from Jekyll or plugins
+lang: en-US # default: en (is not by Jekyll, but used by many other plugins)
+theme_settings:
+  # date_format: "%b %-d, %Y" # default: "%Y-%m-%d"
+  favicon: /icon.webp # optional, needs to be 180x180
+  favicon_dark: /icon-dark.webp # optional, needs to be 180x180
+  favicon_media_type: image/webp # mandatory, if favicon is set
+  feed:
+    posts_limit: 999
+  # title_separator: "|" # default: "•"

data/_layouts/default.html

@@ -3,8 +3,8 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <link rel="icon" type="{{ site.icon_type }}" media="(prefers-color-scheme: light)" href="{{ site.icon | relative_url }}">
-  <link rel="icon" type="{{ site.icon_type }}" media="(prefers-color-scheme: dark)" href="{{ site.icon_dark | relative_url }}">
+  <link rel="icon" type="{{ site.theme_settings.favicon_media_type }}" media="(prefers-color-scheme: light)" href="{{ site.theme_settings.favicon | relative_url }}">
+  <link rel="icon" type="{{ site.theme_settings.favicon_media_type }}" media="(prefers-color-scheme: dark)" href="{{ site.theme_settings.favicon_dark | relative_url }}">
   <style>
     :root { color-scheme: light dark; }
     html {
@@ -49,6 +49,6 @@
   <link type="application/atom+xml" rel="alternate" href="{{ '/feed.xml' | relative_url }}" title="{{ site.title | smartify }}">
 </head>
 <body>
-  {{ content }}
+{{ content }}
 </body>
 </html>

data/_layouts/error.html

@@ -3,8 +3,8 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <link rel="icon" type="{{ site.icon_type }}" media="(prefers-color-scheme: light)" href="{{ site.icon | relative_url }}">
-  <link rel="icon" type="{{ site.icon_type }}" media="(prefers-color-scheme: dark)" href="{{ site.icon_dark | relative_url }}">
+  <link rel="icon" type="{{ site.theme_settings.favicon_media_type }}" media="(prefers-color-scheme: light)" href="{{ site.theme_settings.favicon | relative_url }}">
+  <link rel="icon" type="{{ site.theme_settings.favicon_media_type }}" media="(prefers-color-scheme: dark)" href="{{ site.theme_settings.favicon_dark | relative_url }}">
   <style>
     :root { color-scheme: light dark; }
     html {
@@ -39,7 +39,7 @@
         <h1 itemprop="headline">{{ page.title | smartify }}</h1>
       </header>
       <div itemprop="mainContentOfPage" itemscope itemtype="https://schema.org/WebPageElement">
-        {{ content }}
+{{ content }}
       </div>
     </article>
   </main>

data/_layouts/home.html

@@ -5,13 +5,13 @@ layout: default
     <h1><a rel="author" href="{{ '/' | relative_url }}">{{ site.title }}</a></h1>
   </header>
   <main aria-label="Content" itemscope itemtype="https://schema.org/Blog">
-    {{ content }}
+{{ content }}
 
     {%- if site.posts.size > 0 -%}
       {%- if page.list_title %}
     <h2>{{ page.list_title | smartify }}</h2>
       {%- endif -%}
-      {%- assign date_format = site.date_format | default: "%b %-d, %Y" %}
+      {%- assign date_format = site.theme_settings.date_format | default: "%Y-%m-%d" %}
     <ul>
       {%- for post in site.posts %}
       <li itemscope itemtype="https://schema.org/BlogPosting">

data/_layouts/page.html

@@ -10,7 +10,7 @@ layout: default
         <h1 itemprop="headline">{{ page.title | smartify }}</h1>
       </header>
       <div itemprop="mainContentOfPage" itemscope itemtype="https://schema.org/WebPageElement">
-        {{ content }}
+{{ content }}
       </div>
     </article>
   </main>

data/_layouts/post.html

@@ -8,11 +8,11 @@ layout: default
     <article itemscope itemtype="https://schema.org/BlogPosting">
       <header>
         <h1 itemprop="headline">{{ page.title | smartify }}</h1>
-        {%- assign date_format = site.date_format | default: "%b %-d, %Y" %}
+        {%- assign date_format = site.theme_settings.date_format | default: "%Y-%m-%d" %}
         <time itemprop="datePublished" datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: date_format }}</time>
       </header>
       <div itemprop="articleBody">
-        {{ content }}
+{{ content }}
       </div>
     </article>
   </main>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-nix
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Nordmeyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-include-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description:
 email:
 - michaelnordmeyer@users.noreply.github.com
@@ -45,8 +59,6 @@ files:
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
-- feed.xml
-- sitemap.xml
 homepage: https://github.com/michaelnordmeyer/jekyll-theme-nix
 licenses:
 - MIT
@@ -66,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A very minimalistic, single-author Jekyll theme with almost default browser

data/feed.xml

@@ -1,116 +0,0 @@
----
-permalink: /feed.xml
-sitemap: false
-layout: none
----
-<?xml version="1.0" encoding="utf-8"?>
-{% if page.xsl %}
-<?xml-stylesheet type="text/xml" href="{{ '/feed.xslt' | absolute_url }}"?>
-{% endif %}
-<feed xmlns="http://www.w3.org/2005/Atom" {% if site.lang %}xml:lang="{{ site.lang }}"{% endif %}>
-  <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
-  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang }}" {% endif %}/>
-  <updated>{{ site.time | date_to_xmlschema }}</updated>
-  <id>{{ page.url | absolute_url | xml_escape }}</id>
-  {%- if site.icon %}
-  <icon>{{ site.icon | absolute_url | xml_escape }}</icon>
-  {%- endif -%}
-  {%- assign title = site.title | default: site.name -%}
-  {%- if page.collection and page.collection != "posts" -%}
-    {%- assign collection = page.collection | capitalize -%}
-    {%- assign title = title | append: site.title_separator | append: collection -%}
-  {%- endif -%}
-  {%- if page.category -%}
-     {%- assign category = page.category | capitalize -%}
-    {%- assign title = title | append: site.title_separator | append: category -%}
-  {%- endif -%}
-  {%- if title %}
-  <title>{{ title | strip_html | normalize_whitespace | smartify }}</title>
-  {%- endif -%}
-  {%- if site.description %}
-  <subtitle>{{ site.description | strip_html | normalize_whitespace | smartify }}</subtitle>
-  {%- endif -%}
-  {%- if site.author %}
-  <author>
-    <name>{{ site.author.name | default: site.author | xml_escape }}</name>
-    {%- if site.author.email %}
-    <email>{{ site.author.email | xml_escape }}</email>
-    {%- endif -%}
-    {%- if site.author.uri %}
-    <uri>{{ site.author.uri | xml_escape }}</uri>
-    {%- endif %}
-  </author>
-  {%- endif -%}
-{%- comment -%}
-  {%- if page.tags -%}
-    {%- assign posts = site.tags[page.tags] -%}
-  {%- else -%}
-    {%- assign posts = site[page.collection] -%}
-  {%- endif -%}
-  {%- if page.category -%}
-    {%- assign posts = posts | where: "categories", page.category -%}
-  {%- endif -%}
-{%- endcomment -%}
-  {%- unless posts -%}
-    {%- assign posts = site.posts -%}
-  {%- endunless -%}
-  {%- unless site.show_drafts -%}
-    {%- assign posts = posts | where_exp: "post", "post.draft != true" -%}
-  {%- endunless -%}
-  {%- assign posts = posts | sort: "date" | reverse -%}
-  {%- assign posts_limit = site.feed.posts_limit | default: 10 -%}
-  {%- for post in posts limit: posts_limit %}
-  <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
-    {%- assign post_title = post.title | strip_html | normalize_whitespace | smartify %}
-    <title>{{ post_title }}</title>
-    <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post_title }}" />
-    <published>{{ post.date | date_to_xmlschema }}</published>
-    <updated>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</updated>
-    <id>{{ post.id | absolute_url | xml_escape }}</id>
-
-    {%- assign post_author = post.author | default: post.authors[0] | default: site.author -%}
-    {%- assign post_author = site.data.authors[post_author] | default: post_author -%}
-    {%- assign post_author_email = post_author.email | default: nil -%}
-    {%- assign post_author_uri = post_author.uri | default: nil -%}
-    {%- assign post_author_name = post_author.name | default: post_author %}
-    <author>
-      <name>{{ post_author_name | default: "" | xml_escape }}</name>
-      {%- if post_author_email %}
-      <email>{{ post_author_email | xml_escape }}</email>
-      {%- endif -%}
-      {%- if post_author_uri %}
-      <uri>{{ post_author_uri | xml_escape }}</uri>
-      {%- endif %}
-    </author>
-    {%- if post.category %}
-    <category term="{{ post.category | xml_escape }}" />
-    {%- elsif post.categories -%}
-      {%- for category in post.categories %}
-    <category term="{{ category | xml_escape }}" />
-      {%- endfor -%}
-    {%- endif %}
-    {%- for tag in post.tags -%}
-      {%- unless post.categories contains tag %}
-    <category term="{{ tag | xml_escape }}" />
-      {%- endunless -%}
-    {%- endfor -%}
-    {%- assign post_summary = post.description | default: post.excerpt -%}
-    {%- if post_summary and post_summary != empty %}
-    <summary>{{ post_summary | strip_html | normalize_whitespace | smartify }}</summary>
-    {%- endif -%}
-
-    {%- assign post_image = post.image.path | default: post.image -%}
-    {%- if post_image -%}
-      {%- unless post_image contains "://" -%}
-        {%- assign post_image = post_image | absolute_url | xml_escape -%}
-      {%- endunless %}
-    <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" />
-    <media:content xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" medium="image" />
-    {%- endif -%}
-    {%- assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only -%}
-    {%- unless excerpt_only %}
-    <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ post.content | smartify }}]]></content>
-    {%- endunless %}
-  </entry>
-  {%- endfor %}
-</feed>

data/sitemap.xml

@@ -1,44 +0,0 @@
----
-permalink: /sitemap.xml
-sitemap: false
-layout: none
----
-<?xml version="1.0" encoding="UTF-8"?>
-{%- if page.xsl %}
-  <?xml-stylesheet type="text/xsl" href="{{ "/sitemap.xsl" | absolute_url }}"?>
-{%- endif %}
-<urlset
-  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="https://www.sitemaps.org/schemas/sitemap/0.9 https://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"
-  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">
-  {%- assign collections = site.collections | where_exp:'collection','collection.output != false' -%}
-  {%- for collection in collections -%}
-    {%- assign docs = collection.docs | where_exp:'doc','doc.sitemap != false' -%}
-    {%- for doc in docs %}
-  <url>
-    <loc>{{ doc.url | replace:'/index.html','/' | absolute_url | xml_escape }}</loc>
-    {%- if doc.last_modified_at or doc.date %}
-    <lastmod>{{ doc.last_modified_at | default: doc.date | date_to_xmlschema }}</lastmod>
-    {%- endif %}
-  </url>
-    {%- endfor -%}
-  {%- endfor -%}
-
-  {%- assign pages = site.html_pages | where_exp:'doc','doc.sitemap != false' | where_exp:'doc','doc.url != "/404.html"' -%}
-  {%- for page in pages %}
-  <url>
-    <loc>{{ page.url | replace:'/index.html','/' | absolute_url | xml_escape }}</loc>
-    {%- if page.last_modified_at %}
-    <lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
-    {%- endif %}
-  </url>
-  {%- endfor -%}
-
-  {%- assign static_files = page.static_files | where_exp:'page','page.sitemap != false' | where_exp:'page','page.name != "404.html"' -%}
-  {%- for file in static_files %}
-  <url>
-    <loc>{{ file.path | absolute_url | xml_escape }}</loc>
-    <lastmod>{{ file.modified_time | date_to_xmlschema }}</lastmod>
-  </url>
-  {%- endfor %}
-</urlset>