jekyll-theme-endless 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f75db2a0eaa28c18488f7bfddead9281c786ed050769c4a9f1593e344ff7be7
-  data.tar.gz: e854ce0f88a84f58a9076835ecf89bbdfd59b071993c0e02e11c43ca71baf202
+  metadata.gz: a42aa548152db990d7bac3ebff1b3f4dc93e9d370b0463ebb4161171cb860725
+  data.tar.gz: 9a094c358ff5c9bf680e507d995a8cd50bfa3f1397b37119aa3a13d2db0ae0b7
 SHA512:
-  metadata.gz: 9acdb37b0ec27f4da113e109259b576dc8f5bb014544c275890237d300db51e202d2579b325cd9dfe0cdc3a60f7bf2247f1dab2baadde193d630d18faa78d3a0
-  data.tar.gz: f4a0d1445f90e848b0e7cb9e3cb21c18491bd0eb357d447b1e1ccfcca80c05fe7ba795a54db9525ad3b9d70dc47f97cea1273170354b54a4506d2a10babdf4db
+  metadata.gz: c8fa43b769dab8d11603e54078ea7d297ae48bf3a362120f29e31cab44f0d6a81c273876251ad30dce6cd568f665be3b94a3146dc8939087ba758d19e0726491
+  data.tar.gz: f562c0c1e7890b32f3f7f2a88ff414b6a2fa28363da60ae21273355e5fd833c858d05159606f1d150869ac48af234b952245bdc84e7049d634be0998b05a0b9e

data/README.adoc

@@ -226,7 +226,63 @@ Content
 
 
 `_layouts/page-postlist.html`::
-Layout of page-content with a list of blog posts at the end.
++
+--
+The page-postlist layout is designed to add a list of blog posts at the end of any page that uses this layout.
+The post list can currently be *configured* using two values via Jekyll frontmatter or page variables:
+
+`page-postlist-css-class`:
+This specifies the CSS class for the <ul> element where the posts will be listed, allowing for different list styles.
+
+`page-postlist-format-function`:
+This specifies the code to be included for generating the HTML structure of each post in the list.
+Currently, two designs are available
+(`_includes/function_post-in-list-short.html` [view link:/postlist-short/[postlist using the 'short design']]
+and `_includes/function_post-in-list-long.html` [view link:/postlist-long/[postlist using the 'long design']]), but you can create your own custom formats.
+
+To set the values, simply add them as front matter or page variables.
+For front matter (e.g., in Markdown pages, layouts, or even AsciiDoc pages), it might look like this:
+
+[source, markdown]
+----
+---
+# Layout that attaches blog posts to the end of the page-content.
+layout: page-postlist
+menu_position: 500
+page-menu_label: Blog
+summary: "150 character description of the page."
+## Configuration of the postlist layout (page-postlist.html):
+postlist-css-class: "post-list-long"
+postlist-format-function: "function_post-in-list-long.html"
+---
+# Page title
+
+Content
+----
+
+For AsciiDoc pages, you can also set it as a page variable:
+
+[source, asciidoc]
+----
+= Page title
+// Layout that attaches blog posts to the end of the page-content.
+:page-layout: page-postlist
+:page-menu_position: 500
+:page-menu_label: Blog
+:page-summary: "150 character description of the page."
+// Configuration of the postlist layout (page-postlist.html):
+:page-postlist-css-class: "post-list-short"
+:page-postlist-format-function: "function_post-in-list-short.html"
+
+Content
+----
+
+IMPORTANT: If you want to set the values for `page-tag.html`
+(the layout used by the plugin to create the tag pages),
+then the configuration must be done directly in that file,
+even if the layout `page-postlist` is defined in a downstream layout like `page-tag-template`.
+
+--
 
 
 
@@ -343,6 +399,14 @@ without having to rewrite a complete layout file.
 
 
 
+`_includes/container_head-of-document.html`::
+
+An empty file that can be overwritten by the theme user to _add content to the header of the HTML document_.
+It is included directly after the `<link>` commands for libraries and before the `<link>` command for `main.css`.
+This allows you to add libraries and modify settings in `main.css` as needed.
+
+
+
 `_includes/container_start-of-main.html`::
 
 The content of this file is inserted *above* the main content area (the section containing the page content and blog navigation). The content should be wrapped in a `<div>` element.
@@ -403,6 +467,13 @@ Generates a list containing blog posts.
 
 
 
+`_includes/function_post-in-list-long.html`::
+Generates the code to display a single post in the list of blog posts.
+An entry consists of the title of the blog post )linked to the article),
+a summary, the creation date and a list of tags associates with the post.
+
+
+
 `_includes/function_post-in-list-short.html`::
 Generates the code to display a single post in the list of blog posts.
 An entry consists of the title of the blog post linked to the article.

data/_config.yml

@@ -96,6 +96,17 @@ exclude:
 
 
 
+# compressed: Produces minified CSS in a single line, with no spaces or comments, for the smallest file size.
+# expanded: Outputs fully expanded CSS with indentation, making it easy to read but larger in size.
+# nested: Generates CSS with nested indentation, resembling the structure of the Sass code, for improved readability.
+# compact: Outputs CSS in a compact format, placing each selector on a new line, reducing file size while maintaining some readability.
+sass:
+  style: compressed
+
+
+
+
+
 # Settings for: jekyll-theme-endless
 ###############################################################################
 # These settings have been outsourced into the file `_data.yml` in this project.

data/_includes/container_head-of-document.html

@@ -0,0 +1,12 @@
+{% comment %}
+This file is intended to be replaced with user content.
+
+It can be overwritten by the theme user to add content to the header of the HTML document
+(such as adding CSS libraries within the <head>) without having to rewrite an entire layout file.
+
+The file is included directly after the <link> commands for libraries and
+before the <link> command for the main.css.
+This allows you to add libraries and adjust settings in the main.css file.
+
+{% endcomment %}
+

data/_includes/function_list-posts.html

@@ -5,15 +5,23 @@ Expects an array of post objects in the parameter `postlist`.
 Call via:
 ----
 {% include function_list-posts.html
-	postlist=POSTLIST
+	postlist = POSTLIST
+	postlist-css-class = page.postlist-css-class
+	postlist-format-function = page.postlist-format-function
 %}
 ----
 {% endcomment %}
 
-<ul>
+{% comment %}
+Set the default values for the format function an the CSS-class.
+{% endcomment %}
+{% assign design_post  = include.postlist-format-function | default: "function_post-in-list-short.html" %}
+{% assign design_class = include.postlist-css-class       | default: "post-list-short" %}
+
+<ul class="{{ design_class }}" itemscope itemtype="https://schema.org/Blog">
 {% for current_post in include.postlist %}
-	<li>
-		{% include function_post-in-list-short.html
+	<li itemscope itemtype="https://schema.org/BlogPosting">
+		{% include {{ design_post }}
 			post = current_post
 		%}
 	</li>

data/_includes/function_post-in-list-long.html

@@ -0,0 +1,49 @@
+{% comment %}
+Processes a single post for display in the list of articles.
+Expects a post object as a parameter.
+
+Call via:
+----
+<li>
+	{% include function_post-in-list-short.html
+		post=current_post
+	%}
+</li>
+----
+{% endcomment %}
+
+
+{% assign post = include.post %}
+
+<h2 itemprop="headline">
+	<a href="{{ post.url }}" itemprop="url">{{ post.title }}</a>
+</h2>
+<div>
+	{% comment %}
+		post.summary is checked first.
+		If summary is available, it is used directly without any modifications.
+
+		If summary is not available, excerpt is used as a fallback.
+		The strip_html filter removes any HTML tags from excerpt,
+		ensuring that only plain text is displayed.
+	{% endcomment %}
+	<p class="summary" itemprop="description">{{ post.summary | default: post.excerpt | strip_html }}</p>
+	<p>
+		{% include function_show-dates.html
+			created = post.date
+			edited  = post.last_modified_at
+		%}
+	</p>
+	<p>
+		{% comment %}Show tags of the post.{% endcomment %}
+		{% include function_tag-list.html
+			tags=post.tags
+		%}
+	</p>
+
+	{% comment %}
+	<meta itemprop="author" content="Author(s)" />
+	<meta itemprop="publisher" content="Brandname of Blogname" />
+	{% endcomment %}
+
+</div>

data/_includes/function_post-in-list-short.html

@@ -14,15 +14,20 @@ Call via:
 
 
 {% assign post = include.post %}
+<time itemprop="datePublished" datetime="{{ post.date | date: '%Y-%m-%d' }}">
+	{{ post.date | date: '%Y-%m-%d' }}
+</time>:
 
-{{ post.date | date: "%Y-%m-%d" }}:
 {% if post.permalink %}
 	{% comment %}
 	I use permalinks to indicate that an article was at some point considered beeing finished.
 	{% endcomment %}
 	 <i class="fa fa-link text-success" title="This article has a permalink."></i>
 {% endif %}
+
 {% comment %}
 'title' is not escaped, as the value should already be escaped by AsciiDoc through asciidocify.
 {% endcomment %}
-<a href="{{ post.url | relative_url }}">{{ post.title }}</a>
+<a href="{{ post.url | relative_url }}" itemprop="url">
+	<span itemprop="headline">{{ post.title }}</span>
+</a>

data/_includes/function_show-dates.html

@@ -1,16 +1,12 @@
-<div class="text-right">
+<time class="created" datetime="{{ include.created | date_to_xmlschema }}" itemprop="datePublished">
+	<span class="sr-only sr-only-focusable">created:</span>
+	<strong title="date of creation">{{ include.created | date: "%b %-d, %Y" }}</strong>
+</time>
 
-	<time class="created" datetime="{{ include.created | date_to_xmlschema }}" itemprop="datePublished">
-		<span class="sr-only sr-only-focusable">created:</span>
-		<strong title="date of creation">{{ include.created | date: "%b %-d, %Y" }}</strong>
-	</time>
-
-	{% if include.edited != "" and include.edited %}
-	/
-	<time class="edited" datetime="{{ include.edited | date_to_xmlschema }}" itemprop="dateModified">
-		<span class="sr-only sr-only-focusable">edited:</span>
-		<strong title="date of last edit">{{ include.edited  | date: "%b %-d, %Y" }}</strong>
-	</time>
-	{% endif %}
-
-</div>
+{% if include.edited != "" and include.edited %}
+/
+<time class="edited" datetime="{{ include.edited | date_to_xmlschema }}" itemprop="dateModified">
+	<span class="sr-only sr-only-focusable">edited:</span>
+	<strong title="date of last edit">{{ include.edited  | date: "%b %-d, %Y" }}</strong>
+</time>
+{% endif %}

data/_layouts/default-minimal.html

@@ -0,0 +1,15 @@
+---
+# Page without navigation, footer, etc.
+# Can be used for simple confirmation pages or similar, which should have a layout consistent with the main site.
+layout: html
+---
+<main class="container" aria-label="Content">
+	<div class="row">
+
+		<div class="col-lg-12">
+			{{ content }}
+		</div>
+
+	</div>
+
+</main>

data/_layouts/html.html

@@ -37,6 +37,8 @@
 			<!-- Load local versions -->
 		{% endif %}
 
+		{% include container_head-of-document.html %}
+
 		<!-- Theme CSS -->
 		<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
 

data/_layouts/page-minimal.html

@@ -0,0 +1,17 @@
+---
+# Page without navigation, footer, etc., with a "close window" link
+# Can be used for simple confirmation pages or similar, which should maintain a layout consistent with the main site.
+layout: default-minimal
+---
+<section class="detached">
+
+	{% comment %}
+	'title' is not escaped, as the value should already be escaped by AsciiDoc through asciidocify.
+	{% endcomment %}
+	<h1 class="post-title">{{ page.title }}</h1>
+
+	{{ content }}
+
+	<p class="text-center"><a href="#" onClick="window.close()">Close window.</a></p>
+
+</section>

data/_layouts/page-postlist.html

@@ -4,8 +4,53 @@ layout: page
 ---
 {{ content }}
 
+{% comment %}
+The page-postlist layout is designed to add a list of blog posts at the end of any page that uses this layout.
+The post list can currently be configured using two values via Jekyll frontmatter or page variables:
+
+page-postlist-css-class:
+This specifies the CSS class for the <ul> element where the posts will be listed, allowing for different list styles.
+
+page-postlist-format-function:
+This specifies the code to be included for generating the HTML structure of each post in the list.
+Currently, two designs are available, but you can create your own custom formats.
+
+Planned features:
+
+page-postlist-sort-by:
+Determines the sorting method for the post list, e.g., by title (natural title), creation date, or last edit date.
+The page-postlist layout will handle the sorting.
+
+page-postlist-sort-order:
+Specifies the sorting direction, either ascending or descending.
+
+Processed data:
+
+page-postlist
+This variable holds the post list itself (default is all posts—i.e., site.posts).
+You can also pass a subset, such as only posts with a specific tag or posts created in a particular year.
+page-postlist can, for example, be set by the tag page plugin.
+Setting the variable within layouts does not seem possible because:
+* Page variables cannot be created or modified through Liquid.
+* Only static values can be assigned to a variable in front matter.
+
+{% endcomment %}
+
+{% comment %}
+The default value for the postlist is the list of all posts (i.e., site.posts),
+or otherwise, the value provided for page.postlist (e.g., only posts tagged with a specific tag).
+{% endcomment %}
+{% assign postlist = page.postlist | default: site.posts %}
+
+{% comment %}
+Perform the sorting.
+This part is not yet implemented.
+{% endcomment %}
+
 {% include function_list-posts.html
-	postlist=site.posts
+	postlist = postlist
+	postlist-css-class = page.postlist-css-class
+	postlist-format-function = page.postlist-format-function
 %}
 
 

data/_layouts/page-tag-template.html

@@ -1,5 +1,5 @@
 ---
-layout: page
+layout: page-postlist
 menu_position: -10
 ---
 {% comment %}
@@ -25,10 +25,6 @@ page.tag and page.title are set by the plugin `generate-taglist`.
 	that were already escaped by AsciiDocify, or, if special characters are present,
 	the tags were set unescaped through the Jekyll front matter.
 	{% endcomment %}
-Number of posts tagged with "<em>{{ page.tag | escape }}</em>": <strong>{{ site.tags[ page.tag ] | size }}</strong>
+	Number of posts tagged with "<em>{{ page.tag | escape }}</em>": <strong>{{ site.tags[ page.tag ] | size }}</strong>
 </p>
 
-{% assign tag_posts = site.tags[page.tag] %}
-{% include function_list-posts.html
-	postlist=tag_posts
-%}

data/_layouts/page-tag.html

@@ -1,5 +1,10 @@
 ---
 layout: page-tag-template
 menu_position: -10
+## Configuration of the postlist layout (page-postlist.html):
+postlist-css-class: "post-list-long"
+postlist-format-function: "function_post-in-list-long.html"
+#postlist-sort-by:
+#postlist-sort-order:
 ---
 

data/_layouts/post.html

@@ -17,10 +17,12 @@ layout: default
 		{% comment %}
 			Show dates of the post.
 		{% endcomment %}
-		{% include function_show-dates.html
-			created = page.date
-			edited  = edited_date
-		%}
+		<div class="text-right">
+			{% include function_show-dates.html
+				created = page.date
+				edited  = edited_date
+			%}
+		</div>
 
 		{% comment %}
 			In Markdown posts, page.title defaults to parts of the filename.

data/_sass/adoc-admonition.scss

@@ -3,6 +3,7 @@ div.admonitionblock {
 	box-shadow: 0 1px 4px #aaa;
 	background: #fff;
 	color: #111;
+	margin: 2em 0;
 }
 .admonitionblock table {
 	background-color: transparent;
@@ -21,10 +22,10 @@ span.icon>.fa {
 .admonitionblock td.icon {
 	text-align: center;
 	vertical-align: top;
-	width: 66px;
+	width: 3.7em;
 
 	[class^="fa icon-"] {
-		font-size: 1.5em;
+		font-size: 2.3em;
 		text-shadow: 1px 1px 2px rgba(0,0,0,.5);
 		cursor: default;
 	}

data/_sass/adoc-code.scss

@@ -1,28 +1,34 @@
 /**
  * Show name of the language highlighted in a code block in the upper right corner.
  */
-.listingblock .content code {
-  position: relative;
-  display: block;
-}
-
-.listingblock .content code::before {
-  content: attr(data-lang);
-  position: absolute;
-  top: 0;
-  right: 0;
-  background-color: #f0f0f0;
-  padding: 2px 5px;
-  font-size: 12px;
-  color: #333;
-  border-radius: 3px;
-  border: 1px solid #ccc;
-}
-
-/* If data-lang is empty or not set, ::before will be hidden. */
-.listingblock .content code[data-lang=""]::before,
-.listingblock .content code:not([data-lang])::before {
-  display: none;
+.listingblock {
+
+	.content {
+
+		code {
+			position: relative;
+			display: block;
+		}
+
+		code::before {
+			content: attr(data-lang);
+			position: absolute;
+			top: 0;
+			right: 0;
+			background-color: #f0f0f0;
+			padding: 2px 5px;
+			font-size: 12px;
+			color: #333;
+			border-radius: 3px;
+			border: 1px solid #ccc;
+		}
+
+		/* If data-lang is empty or not set, ::before will be hidden. */
+		code[data-lang=""]::before,
+		code:not([data-lang])::before {
+			display: none;
+		}
+	}
 }
 
 /*

data/_sass/postlists.scss

@@ -0,0 +1,46 @@
+/**
+ * Designs for the post-lists.
+ */
+
+ul.post-list-short {
+  margin-left: 0;
+}
+
+ul.post-list-long {
+
+  list-style: none;
+  padding: 0;
+  margin: 0;
+
+  li {
+    margin-bottom: 20px;
+
+    h2 {
+      margin-left: .25em;
+			font-size: 1.7em;
+    }
+
+		p.summary {
+			margin-bottom: 1.5em;
+		}
+
+    div {
+      position: relative;
+      margin-left: 3em;
+			padding: .5em 0;
+
+      // Blurred bar on the left side of the div
+      &::before {
+        content: '';
+        position: absolute;
+        left: -2em;
+        top: 0;
+        bottom: 0;
+        width: 1em;
+        background-color: rgba(0, 0, 111, 0.1);
+        filter: blur(3px);
+        border-radius: 5px;
+      }
+    }
+  }
+}

data/_sass/structure.scss

@@ -7,6 +7,13 @@ article, section {
 	}
 }
 
+/**
+ * Design settings for page-minimal.
+ */
+section.detached {
+	margin-top: 1em;
+}
+
 /*
  * Main elements (boxes for content):
  *  * <section> for pages

data/assets/css/main.scss

@@ -12,6 +12,7 @@
 @use "address";
 @use "tag-cloud";
 @use "posts";
+@use "postlists";
 @use "structure";
 
 /*

data/lib/jekyll-theme-endless/generate-tagpages.rb

@@ -84,6 +84,10 @@ module Jekyll
 				# Makes `page.tag` available in the layout file
 				self.data['tag'] = tag
 
+				# Make `site.tags[tag]` available as `page.postlist` in the layout
+				self.data['postlist'] = site.tags[tag] || []
+
+				#puts "[DEBUG] Loaded self.data: #{self.data.inspect}"
 			end
 		end
 

data/lib/jekyll-theme-endless/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
 	module Endless
-		VERSION = '0.12.4'
+		VERSION = '0.13.0'
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.13.0
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-asciidoc
@@ -84,6 +84,7 @@ files:
 - _includes/container_end-of-main.html
 - _includes/container_end-of-page.html
 - _includes/container_end-of-post.html
+- _includes/container_head-of-document.html
 - _includes/container_start-of-main.html
 - _includes/container_start-of-page.html
 - _includes/container_start-of-post.html
@@ -91,13 +92,16 @@ files:
 - _includes/content_footer-usernames.html
 - _includes/function_list-pages.html
 - _includes/function_list-posts.html
+- _includes/function_post-in-list-long.html
 - _includes/function_post-in-list-short.html
 - _includes/function_show-dates.html
 - _includes/function_show-prev-next-navigation.html
 - _includes/function_tag-cloud.html
 - _includes/function_tag-list.html
+- _layouts/default-minimal.html
 - _layouts/default.html
 - _layouts/html.html
+- _layouts/page-minimal.html
 - _layouts/page-postlist.html
 - _layouts/page-tag-template.html
 - _layouts/page-tag.html
@@ -118,6 +122,7 @@ files:
 - _sass/md-lists.scss
 - _sass/md-quote.scss
 - _sass/md-tables.scss
+- _sass/postlists.scss
 - _sass/posts.scss
 - _sass/rouge-highlight.scss
 - _sass/structure.scss