jekyll-theme-endless 0.2.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c19bee690c687736343b7d545f9c7b8e994b0c9907aa3273402b9d5c31654e3
-  data.tar.gz: 9425bec97a21c570d01d62ecdf3d6fb1eaffc8aaf0436cc1b7029e4690562f06
+  metadata.gz: 89c0139c45315d50216ab24a38a764af14992c71f47bd10e7aa886927d681471
+  data.tar.gz: c6e8250581b4e0347545af3096a350fa0efb7ca242bc69e81743084367ee5fe2
 SHA512:
-  metadata.gz: 52ee40cadee608ea61388beffe2268e8e434a595595685f449916bbea110880660e62a64b61765606e8f54d96bbdc23ece8eab91eddb1eb5975826b458a9adae
-  data.tar.gz: 78b2b5793063628a4c5e7510b39d649c0ae1aa0fa9fd2705b03d37c306acca73a16b3feb7256c75d7b4f467584bb99e9d4f9e97bd50f02cf695d7b26f27ff386
+  metadata.gz: 898b9fd609cbc6511a168d3936f903977448b1ec2a1268d8605ebc09f5ca096b6a5aef0a6bc3e871c62295f7e8ed68b516be2d17442a8e0543c6fc80796d8b89
+  data.tar.gz: 70568707691fd41f0d074d00a42e614c41c26bd822c9bf6deb413bd2bbc48ff131a9614cad43695346877deece0c0d4df6e251d65a0bb89cc0cf4fa689b22651

data/README.adoc

@@ -3,6 +3,11 @@
 :page-menu_position: 300
 
 
+== Quicktstart for testing
+
+* Clone the repository
+* Run `bundle exec jekyll serve --config _config.yml,_data.yml`
+* Open http://127.0.0.1:4000/ to view a page using this theme
 
 == Installation
 
@@ -122,6 +127,10 @@ Content
 `_layouts/page-postlist.html`::
 Layout of page-content with a list of blog posts at the end.
 
+`_layouts/page-tag.html`::
+Layout of pages containing a list of those posts being tagged with a given tag.
+This file is required by the `generate-tagpages`-plugin.
+
 `_layouts/post.html`::
 Layout of blog-posts.
 
@@ -173,6 +182,9 @@ This can be useful for your 404 page, which should be generated by Jekyll, but n
 Generates the code containing links to each blog-post.
 The text of the link is the title of the post.
 
+`_includes/function_tag-cloud.html`::
+Generates a tag cloud.
+
 `_includes/content_footer-usernames.html`::
 Creates a list of contact options based on provided usernames and addresses.
 The entries are preceded with the icons of (e.g.) the social network and are linked to the corresponding profile.
@@ -190,6 +202,29 @@ username_linkedin: XXXX
 
 
 
+=== Plugins
+
+`_plugins/generate-tagpages.rb`
+
+Generates a page for each tag listed in `site.tags`.
+The files created are by default named `tags/<tagname>/index.html`.
+The content is generated using the layout file `_layouts/page-tag.html`
+
+The following values can be set in `_config.yml`:
+
+[source, YAML]
+----
+# Settings for tag cloud:
+# The name of the directory in which the files for each tag are created
+# default: `tags`
+tag_dir: post-for-tag
+# Prefix to be used for the title of the tag-page
+# default: `Tag: `
+tag_title_prefix: "Posts tagged with: "
+----
+
+
+
 === Styles
 
 In order to contribute SCSS-code, simply add a file `_sass/user.scss`, containing your SCCS-code.

data/_includes/function_list-posts.html

@@ -5,7 +5,7 @@ List of blog-posts.
 <ul>
 {% for current_post in site.posts %}
 	<li>
-		<a href="{{ current_post.url }}">{{ current_post.title }}</a>
+		{{ current_post.date | date: "%Y-%m-%d" }}: <a href="{{ current_post.url }}">{{ current_post.title }}</a>
 	</li>
 {% endfor %}
 </ul>

data/_includes/function_tag-cloud.html

@@ -0,0 +1,77 @@
+{% comment %}
+Creates a tag cloud with tags beeing sized according to the number of occurences in blog posts.
+{% endcomment %}
+
+{% comment %}
+Create an empty array.
+{% endcomment %}
+{% assign tags = "" | split:"" %}
+
+{% comment %}
+Fill the tags-array with tag-names.
+The push-filter is a Jekyll specific filter.
+{% endcomment %}
+{% for tag in site.tags %}
+  {% assign tags = tags | push: tag.first %}
+{% endfor %}
+
+{% comment %}
+Sort the tag-array case-insensitive.
+{% endcomment %}
+{% assign tags_sorted = tags | sort_natural %}
+
+{% comment %}
+Requirements:
+- The tag with the most posts should always be displayed at 250%
+- The tag with the fewest posts (this can also be more than 1!) always with 100%.
+- All gradations in between should be distributed linearly.
+
+Determine minimum an maximum value.
+Assumption: Non of the tags occurs more than one million times.
+
+{% endcomment %}
+{% assign min = 1000000 %}
+{% assign max = 0 %}
+
+{% for tag in tags_sorted %}
+	{% assign postsWithThisTag = site.tags[tag] | size %}
+	{% if postsWithThisTag > max %}
+		{% assign max = postsWithThisTag %}
+	{% endif %}
+	{% if postsWithThisTag < min %}
+		{% assign min = postsWithThisTag %}
+	{% endif %}
+{% endfor %}
+
+{% assign sizeDifference = 150 %}
+{% assign steps = max | minus: min %}
+
+<ul class="tag-cloud list-unstyled">
+
+	{% for tag in tags_sorted %}
+	<li>
+		{% comment %}
+		The size difference should be 150%.
+		The rarest tag should be displayed in 100%, the most frequent should be 250%.
+		100 + (aktZahl - min) * (250 / (max -min))
+
+		100:                Minimum size
+		(aktZahl - min):    Distance from the current value to the smallest value
+		(150 / (max -min)): Size difference in measures of the number of steps between the largest and the smallest value.
+
+		https://shopify.github.io/liquid/filters/divided_by/
+		To be on the safe side, create a float (times: 1.0)
+		{% endcomment %}
+
+		{% assign number  = site.tags[tag] | size %}
+		{% assign percent = number | times: 1.0 | minus: min | times: sizeDifference | divided_by: steps | plus: 100 %}
+		{% assign tagname = tag | replace:'-', ' ' %}
+
+		<a
+			href  = "/{{ site.tag_dir | default: 'tags' }}/{{ tag }}"
+			style = "font-size: {{ percent }}%"
+			title = "Number of posts with the tag '{{ tagname }}': {{ number }}"
+			>{{ tagname }}</a>
+	</li>
+	{% endfor %}
+</ul>

data/_layouts/default.html

@@ -53,7 +53,23 @@ layout: html
 <!-- Page content -->
 <main class="container pt-4 pb-5" style="flex-grow: 1;" aria-label="Content">
 
-	{{ content }}
+	<div class="row">
+
+		<div class="col-lg-8">
+			{{ content }}
+		</div>
+
+		<div class="col-lg-4">
+			<aside>
+				<h3>Blog Navigation</h3>
+
+				<!-- Tag-cloud -->
+				{% include function_tag-cloud.html %}
+
+			</aside>
+		</div>
+
+	</div>
 
 </main>
 

data/_layouts/html.html

@@ -8,7 +8,7 @@
 		<meta charset="utf-8">
 		<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 		<title>
-			{{ page.title }}
+			{{ page.title | default: page.menu_label | strip_html }}
 		</title>
 
 		<!-- Font-awesome CSS: https://www.bootstrapcdn.com/fontawesome/ -->

data/_layouts/page-postlist.html

@@ -1,5 +1,5 @@
 ---
-# Regular page with list of blog posts attached to the end of the content.
+# Regular page with a list of blog posts attached to the end of the content.
 layout: page
 ---
 {{ content }}

data/_layouts/page-tag.html

@@ -0,0 +1,22 @@
+---
+layout: default
+menu_position: -10
+---
+{% comment %}
+page.tag and page.title are set by the plugin `generate-taglist`.
+{% endcomment %}
+{% if page.title %}
+<h1>{{ page.title }}</h1>
+{% endif %}
+
+<ul>
+	{% for post in site.tags[ page.tag ] %}
+
+	<li>
+		{{ post.date | date: "%Y-%m-%d" }}: <a href="{{ post.url }}">{{ post.title }}</a>
+	</li>
+
+	{% endfor %}
+</ul>
+
+

data/_sass/address.scss

@@ -0,0 +1,15 @@
+/**
+ * Address bar in the footer.
+ */
+address {
+	li {
+		i {
+			display: inline-block;
+			padding: 2px 0;
+			margin: 2px 0;
+			vertical-align: top;
+			// Icons should take the same space;
+			min-width: 20px;
+		}
+	}
+}

data/_sass/tag-cloud.scss

@@ -0,0 +1,18 @@
+/**
+ * Tag cloud.
+ */
+.tag-cloud {
+	text-align: center;
+
+	li {
+		display: inline;
+	}
+	/* Every tag in the tag cloud should have a point as a separator. */
+	li::after {
+		content: "·";
+	}
+	/* The last entry in the tag cloud should not have a point. */
+	li:last-child::after {
+		content: "";
+	}
+}

data/assets/css/main.scss

@@ -8,7 +8,8 @@
  * imports _scss/icons.scss
  */
 @import "background";
-@import "icons";
+@import "address";
+@import "tag-cloud";
 
 /*
  * import SCSS-Code contributed by the user of the theme.

data/lib/jekyll-theme-endless.rb

@@ -0,0 +1,8 @@
+module Jekyll
+  module Endless
+
+  end
+end
+
+require_relative 'jekyll-theme-endless/generate-tagpages'
+

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

@@ -0,0 +1,80 @@
+# Generator
+
+# Generates a page for each tag listed in `site.tags`.
+# The files created are by default named `tags/<tagname>/index.html`.
+# The content is generated using the layout file `_layouts/page-tag.html`
+
+# The following values can be set in `_config.yml`
+# `tag_dir`
+#   * the name of the directory in which the files for each tag are created;
+#   * default: `tags`
+# `tag_title_prefix`
+#   * Prefix to be used for the title of the page
+#   * default: `Tag: `
+
+# Necessary files:
+# `_layouts/page-tag.html` - used to generate content of tag files.
+
+# The following values are made available in the layout:
+#   * `page.tag`   - contains the tag
+#   * `page.title` - contains the generated title, e.g. "Tag: <tagname>"
+
+# NOTE: after changes to the plugin, `jekyll serve` must be started again.
+
+# See also: https://jekyllrb.com/docs/plugins/
+# See also: https://jekyllrb.com/docs/plugins/generators/
+
+module Jekyll
+
+	module Endless
+
+		# TagPageGenerator is a subclass of Generator
+		class TagPageGenerator < Generator
+			safe true
+			# A Generator needs to implement the generate method
+			def generate(site)
+				# If a layout with the name `page-tag` exists
+				if site.layouts.key? 'page-tag'
+					# The directory in which the files are to be created is configured in `site.tag_dir`.
+					# If not, the directory `tags/` is used.
+					dir = site.config['tag_dir'] || 'tags'
+
+					# For each tag in the tag-list:
+					site.tags.each_key do |tag|
+						# Create a page-object using TagPage and add it to the `site.pages` array
+						site.pages << TagPage.new(site, site.source, File.join(dir, tag), tag)
+					end
+
+				end
+			end
+		end
+
+		# TagPage is a subclass of Page
+		# It is used in the `TagPageGenerator`
+		class TagPage < Page
+			def initialize(site, base, dir, tag)
+				# Define instance variables ('@') to make values available in the super-class `Page`.
+				# The variables are available in the layout as e.g. `page.name`.
+				@site = site
+				@base = base
+				@dir	= dir
+				@name = 'index.html'
+
+				self.process(@name)
+				self.read_yaml(File.join(base, '_layouts'), 'page-tag.html')
+
+				# The prefix for the generated title is set via `tag_title_prefix` in `_config.yml` and defaults to `Tag: `
+				tag_title_prefix = site.config['tag_title_prefix'] || 'Tag: '
+				# Generates the title for the tag page and makes it available in the layout file as `page.title`
+				self.data['title'] = "#{tag_title_prefix}#{tag}"
+				# Makes `page.tag` available in the layout file
+				self.data['tag'] = tag
+
+			end
+		end
+
+	end
+
+end
+
+

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

@@ -0,0 +1,5 @@
+module Jekyll
+  module Endless
+    VERSION = '0.3.4'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -37,15 +37,21 @@ files:
 - _includes/content_footer-usernames.html
 - _includes/function_list-pages.html
 - _includes/function_list-posts.html
+- _includes/function_tag-cloud.html
 - _layouts/default.html
 - _layouts/html.html
 - _layouts/page-postlist.html
+- _layouts/page-tag.html
 - _layouts/page.html
 - _layouts/post.html
+- _sass/address.scss
 - _sass/background.scss
-- _sass/icons.scss
+- _sass/tag-cloud.scss
 - _sass/user.scss
 - assets/css/main.scss
+- lib/jekyll-theme-endless.rb
+- lib/jekyll-theme-endless/generate-tagpages.rb
+- lib/jekyll-theme-endless/version.rb
 homepage: https://gitlab.com/jekyll-theme-endless/jekyll-theme-endless.gitlab.io
 licenses:
 - MIT

data/_sass/icons.scss

@@ -1,12 +0,0 @@
-
-/**
- * Icons in the adress bar should take the same space;
- */
-address li i {
-    display: inline-block;
-    padding: 2px 0;
-    margin: 2px 0;
-    vertical-align: top;
-    min-width: 15px;
-}
-