jekyll-theme-endless 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a765efd0983e1ceede6edf8cb5e9585d1a7443ab9caa5bf1ed9d21d8a83d991
-  data.tar.gz: 7a0845b138a722faca39492e729990081a622cb694b7434ce6bb15ff1cbe2d98
+  metadata.gz: 69ca0a202fdb3f05970cb2e99a6718220173c3383ab3649c3d4733d8d647ad8b
+  data.tar.gz: aa05cd183d0ae7ef3767b3ada0e101b48b515ccad38b50502ac5af04215c5275
 SHA512:
-  metadata.gz: 218292073372247f62a3a5233e7833a4f1c01daef7ae856547d1b3b163b3104288e851d636e8170eeedd7c1c0bb68fa7b7cca1ea4c0646efe324fe43e1fa574b
-  data.tar.gz: 4547082a60f0a47c89539ddad558b303efda39350942f2e604b428a54a39cdc455daa1780cd34709607444c57ab8ab8d40f55e32e0408d6926b78c0b2078d832
+  metadata.gz: e4a4dc344fcfe38993cc1ba0f88bc9c4eac5883bbeadfeafa5c5fea182c426ce059f24a774b6ac5b8fc9e90eed7bb0dbc71a37d74a1f5a68f93bf750b0be457a
+  data.tar.gz: 7137b1499ecf59cb76ad21ef4956838dbfa10ca45c2d64d278ee1976a92a62e982753fafb895f3a2905d7c3f12df34817f68f0813c661dfad48446af16df8d1d

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
 
@@ -195,6 +200,24 @@ username_xing: XXXX
 username_linkedin: XXXX
 ----
 
+`_includes/function_tag-list.html`::
+Generates a formatted list of tags.
+This is e.g. used to display the tags of a blog post.
+
+`_includes/function_show-dates.html`::
+Show the creation date and (if present) the date a blog post was last edited.
+The date of the last edit can be configured by setting a value for the page-variable `lastedit`.
+
+In AsciiDoc this would be e.g.:
+
+[source, AsciiDoc]
+----
+:page-lastedit: 2020-10-29
+----
+
+`_includes/function_show-prev-next-navigation.html`::
+Displays links to the previous and the next post of your blog.
+
 
 
 === Plugins

data/_includes/function_show-dates.html

@@ -0,0 +1,16 @@
+<div class="text-right">
+
+	<time class="created" datetime="{{ include.created | date_to_xmlschema }}">
+		<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 }}">
+		<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>

data/_includes/function_show-prev-next-navigation.html

@@ -0,0 +1,13 @@
+<div class="row text-left">
+	<div class="col">
+		{% if page.next %}
+		<a href="{{ page.next.url }}">&laquo; {{page.next.title}}</a>
+		{% endif %}
+	</div>
+	<div class="col text-right">
+		{% if page.previous %}
+		<a href="{{ page.previous.url }}">{{page.previous.title}} &raquo;</a>
+		{% endif %}
+	</div>
+</div>
+

data/_includes/function_tag-cloud.html

@@ -1,7 +1,24 @@
 {% 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 = site.tags | sort %}
+{% assign tags_sorted = tags | sort_natural %}
 
 {% comment %}
 Requirements:
@@ -16,8 +33,8 @@ Assumption: Non of the tags occurs more than one million times.
 {% assign min = 1000000 %}
 {% assign max = 0 %}
 
-{% for tag in tags %}
-	{% assign postsWithThisTag = tag | last | size %}
+{% for tag in tags_sorted %}
+	{% assign postsWithThisTag = site.tags[tag] | size %}
 	{% if postsWithThisTag > max %}
 		{% assign max = postsWithThisTag %}
 	{% endif %}
@@ -31,7 +48,7 @@ Assumption: Non of the tags occurs more than one million times.
 
 <ul class="tag-cloud list-unstyled">
 
-	{% for tag in tags %}
+	{% for tag in tags_sorted %}
 	<li>
 		{% comment %}
 		The size difference should be 150%.
@@ -46,12 +63,12 @@ Assumption: Non of the tags occurs more than one million times.
 		To be on the safe side, create a float (times: 1.0)
 		{% endcomment %}
 
-		{% assign number  = tag | last | size %}
+		{% assign number  = site.tags[tag] | size %}
 		{% assign percent = number | times: 1.0 | minus: min | times: sizeDifference | divided_by: steps | plus: 100 %}
-		{% assign tagname = tag | first | replace:'-', ' ' %}
+		{% assign tagname = tag | replace:'-', ' ' %}
 
 		<a
-			href  = "/{{ site.tag_dir | default: 'tags' }}/{{ tag | first }}"
+			href  = "/{{ site.tag_dir | default: 'tags' }}/{{ tag }}"
 			style = "font-size: {{ percent }}%"
 			title = "Number of posts with the tag '{{ tagname }}': {{ number }}"
 			>{{ tagname }}</a>

data/_includes/function_tag-list.html

@@ -0,0 +1,15 @@
+{% comment %}
+Generates an unsorted list of tags.
+Requires an array of tags beeing provided via the parameter `tags`.
+{% endcomment %}
+{% assign asize = include.tags | size %}
+{% if asize > 0 %}
+	<ul class="list-inline">
+		{% for current_tag in include.tags %}
+			<li class="list-inline-item"><a
+				class="badge badge-pill badge-secondary"
+				href="/{{ site.tag_dir | default: 'tags' }}/{{ current_tag }}"
+				>{{ current_tag }}</a></li>
+		{% endfor %}
+	</ul>
+{% endif %}

data/_layouts/default.html

@@ -51,15 +51,15 @@ layout: html
 
 
 <!-- Page content -->
-<main class="container pt-4 pb-5" style="flex-grow: 1;" aria-label="Content">
+<main class="container pt-4" style="flex-grow: 1;" aria-label="Content">
 
 	<div class="row">
 
-		<div class="col-lg-8">
+		<div class="col-lg-8 pb-5">
 			{{ content }}
 		</div>
 
-		<div class="col-lg-4">
+		<div class="col-lg-4 pb-5">
 			<aside>
 				<h3>Blog Navigation</h3>
 

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

@@ -1,12 +1,42 @@
 ---
 layout: default
 ---
-{% comment %}
-In Markdown posts, page.title defaults to parts of the filename.
-Thus, do not use `# Heading` in Blog posts, otherwise two H1-heading will appear.
-{% endcomment %}
-{% if page.title %}
-<h1>{{ page.title }}</h1>
-{% endif %}
-
-{{ content }}
+<article>
+	<header>
+
+		{% comment %}Show link to previous/next post.{% endcomment %}
+		{% include function_show-prev-next-navigation.html %}
+
+		{% comment %}Show dates of the post.{% endcomment %}
+		{% include function_show-dates.html
+			created = page.date
+			edited  = page.lastedit
+		%}
+
+		{% comment %}
+		In Markdown posts, page.title defaults to parts of the filename.
+		Thus, do not use `# Heading` in Blog posts, otherwise two H1-heading will appear.
+		{% endcomment %}
+		{% if page.title %}
+		<h1>{{ page.title }}</h1>
+		{% endif %}
+
+		{% comment %}Show tags of the post.{% endcomment %}
+		{% include function_tag-list.html
+			tags=page.tags
+		%}
+
+	</header>
+
+	<div>
+		{{ content }}
+	</div>
+
+	{% comment %}Show link to previous/next post.{% endcomment %}
+	{% include function_show-prev-next-navigation.html %}
+
+</article>
+
+
+
+

data/_sass/posts.scss

@@ -0,0 +1,16 @@
+time {
+	color: #999;
+
+	&:before {
+		font-family: FontAwesome;
+		top:0;
+		padding-right:-1px;
+
+		&.created {
+			content: "\f017";
+		}
+		&.edited {
+			content: "\f044";
+		}
+	}
+}

data/assets/css/main.scss

@@ -10,6 +10,7 @@
 @import "background";
 @import "address";
 @import "tag-cloud";
+@import "posts";
 
 /*
  * 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.4.0'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -37,19 +37,25 @@ files:
 - _includes/content_footer-usernames.html
 - _includes/function_list-pages.html
 - _includes/function_list-posts.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.html
 - _layouts/html.html
 - _layouts/page-postlist.html
 - _layouts/page-tag.html
 - _layouts/page.html
 - _layouts/post.html
-- _plugins/generate-tagpages.rb
 - _sass/address.scss
 - _sass/background.scss
+- _sass/posts.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/_plugins/generate-tagpages.rb

@@ -1,76 +0,0 @@
-# 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
-
-	# 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
-
-