jekyll-theme-endless 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957d3391d580b9bd3160aecdae5ef1d1fc753a89f064d041e63daba2a56187dd
-  data.tar.gz: 905d9b727e40b1854c91b5f271eb1a04931ece3a48feae7c1c29a4125ae7733c
+  metadata.gz: 9383008f153eb0b678be801500b2a806d5d384a77e643a8af2bb131944b62a3f
+  data.tar.gz: 5364902b367bb5752fa6e751a9e82a544e6b83516573ae6ee5d4594b437527b8
 SHA512:
-  metadata.gz: 505742088ffb87869f12dd0390021ae8dec70baf8627037717eeb2246d43cfa98f30e2ad1a1cbd58db6a4e8a6daaa02e9406914bc66a3b5f95b41368f55dcadd
-  data.tar.gz: 1fb13f4ffead3fc1a25ebe7cb98614c17c43f729397b634b746be19adab1cb114034a1dd21fd454523c5710e9a81881dc35beb1962704b957542495f4899e4d5
+  metadata.gz: e4970875e16f5f5257fcc4defe679de7ce4452b7e4e5eac1f0d115926d32738edd95613f8af50e51cb1c063faf2dfe5ef34ac8abcdc65b4493e825da2a29291e
+  data.tar.gz: 926e1e3779d2799122fddc966d0110a42fd4d6d873a89749f32420e0e73ebc565a27510250d0ce5eb64aa235cf7eb8402df07ad37402361c9f5f8c1011154c1a

data/README.adoc

@@ -1,6 +1,13 @@
 = jekyll-theme-endless
+:page-menu_label: Documentation
+: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
 
@@ -120,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.
 
@@ -171,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.
@@ -188,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.
@@ -223,9 +260,14 @@ To set up your environment to develop this theme:
 . clone this repository
 . run `bundle install`
 
-Your theme is setup just like a normal Jekyll site!
-To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+The theme is setup just like a normal Jekyll site!
+To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
 This starts a Jekyll server using your theme.
+To test the theme *with example-data*, run `bundle exec jekyll serve --config _config.yml,_data.yml`.
+Values for theme specific configurations are stored in `_data.yml` and not in the themes `_config.yml`.
+Since the `_config.yml` is shipped with the gem,
+the users of your theme would otherwise have to unset the values in their own `config.yml`.
+
 Add pages, documents, data, etc. like normal to test your theme's contents.
 As you make modifications to your theme and to your content, your site will regenerate and
 you should see the changes in the browser after a refresh, just like normal.

data/_config.yml

@@ -22,37 +22,10 @@ baseurl: "" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
 
 
-# Theme specific settings
-# Language. Is overriden by value of page.lang.
-lang: en
-# Brand is not escaped in the layout.
-# Thus, HTML-commands can be used.
-brand: '"<i>endless</i>"-Theme'
-
-# Title and subtile of the page
-title: jekyll-theme-endless
-subtitle: A Jekyll theme ready for AsciiDoc
-
-author: Sven Boekhoff
-copydate: 2020
-disclaimer: >- # this means to ignore newlines until the next entry
-  I'm creating this Jekyll theme because I want to use it myself.
-  Therefore, many things (e.g. the support of AsciiDoc) are based on personal requirements.
-  You are welcome to use the theme (at your own risk) and contribute to the development.
-
-# eMail address
-email: your-email@example.com
-# Username on https://gitlab.com/
-username_gitlab: XXXX
-# Username on https://github.com/
-username_github: XXXX
-# Username on https://www.xing.com/
-username_xing: XXXX
-# Username on https://linkedin.com/
-username_linkedin: XXXX
-
-
 
+# Theme specific settings
+# Find example data in _data.yml of the theme repository.
+# Run `bundle exec jekyll serve --config _config.yml,_data.yml`
 
 
 # Build settings
@@ -71,7 +44,6 @@ username_linkedin: XXXX
 exclude:
   - '*.gemspec'
   - LICENSE.txt
-  - README.adoc
 #   - .sass-cache/
 #   - .jekyll-cache/
 #   - gemfiles/

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

@@ -8,7 +8,9 @@ layout: html
 	<div class="container">
 
 		<!-- Brand Icon -->
+		{% if site.brand %}
 		<a class="navbar-brand" href="{{ "/" | relative_url}}">{{ site.brand }}</a>
+		{% endif %}
 
 		<!-- Burger menu -->
 		<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
@@ -51,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>
 
@@ -79,9 +97,11 @@ layout: html
 
 			<div class="col-md-3 text-left py-3">
 				<h4>Note:</h4>
+				{% if site.copydate and site.author %}
 				<p>
 					&copy; {{ site.copydate }} by <em>{{ site.author }}</em>
 				</p>
+				{% endif %}
 				<p>
 					Powered by <a href="https://jekyll-theme-endless.gitlab.io/">jekyll-theme-endless</a>.
 				</p>

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.3'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 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;
-}
-