jekyll-theme-endless 0.0.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 895ee6675bf014e980f0cedef57fdc044087039a7448798aa74734539b99421d
-  data.tar.gz: c448fa60ced14cd1cc70b30d8152abc05aa3c970e9d38901bb6b86b1b8034549
+  metadata.gz: '048954cb6b01292c57d7aeddb592a94e02e71ca49ea3ff6bc17cc128e0a5dac5'
+  data.tar.gz: cc6597fcda7de04fd940b0904d0d542b18e9119201ccb0ddc1140080486ab456
 SHA512:
-  metadata.gz: 73eb66c8bf2493deff4f3003ec9c6b336e98431d141d28300ad7fce87d41607e6fa090cd43e553147d4cf5266ed2320b55927f4e1424d0026004938841794e0a
-  data.tar.gz: cc5f8ebc667554dde143e957c3d294700ca7655ddb2203ed1e9bd7402e5913ffcb7f3aa11706ca4724d0d3af060bb267275a3beae8eec1f844e206e09e5f2fdf
+  metadata.gz: 03d0427df894a7fa5d29e4d7a2021db478c702befa0ef8e43a0786cf3f7985a522310ff518df391282b8101e57cce2d993fbdfe4b7d82d4f961746adf3aa4e68
+  data.tar.gz: 77afae077fa3b9d8eaee554e650c5333a682ea6aba3ee003a28992d94dfb70dcc50631f1dd7425db003b04f67d41cd34948ca2ae56c83fec92df5632b34e3c7c

data/README.adoc

@@ -1,4 +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
 
@@ -24,6 +33,20 @@ Or install it yourself as:
 
     $ gem install jekyll-theme-endless
 
+
+
+== General information
+
+The theme is styled using https://getbootstrap.com/[Bootstrap] that is added
+via a content delivery network (CDN; here: https://www.jsdelivr.com/).
+
+The output of page variables (e.g. `page.title` or `page.menu_label`) is *not escaped* by the theme-layout.
+The reason is, that Jekyll-AsciiDoc (in contrast to Markdown) escapes HTML by default.
+Thus, using (unescaped) HTML-commands e.g. in titles of Markdown posts/pages might break the layout.
+If you want to use Markdown AND have HTML-commands in the title, simply escape them (e.g. use `&lt;` instead of `<`).
+
+
+
 == Usage
 
 Here I describe available layouts, includes, sass and/or assets here.
@@ -36,15 +59,109 @@ HTML boilerplate code used for all layouts.
 `_layouts/default.html`::
 Default website structure (menue, tag cloud, ...) used for pages and posts.
 
+Contains a *navigation bar* with a configurable brand-label.
+Set `brand` in your `_config.yml`, to determine what is shown on the left side of the navigation.
+Example:
+
+[source, yaml]
+----
+brand: '"<i>endless</i>"-Theme'
+----
+
+Contains a configurable *title bar*.
+Set `title` and `subtitle` in your `_config.yml`, to determine what is shown below the navigation bar.
+If none of the two values is set, the title bar is omitted.
+Example:
+
+[source, yaml]
+----
+title: 'Brandname'
+subtitle: 'Vision statement'
+----
+
+Contains a configurable *footer*.
+Includes `content_footer-usernames.html` to generate a list of contact options.
+Configure values in `_config.yml`.
+Example:
+
+[source, yaml]
+----
+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.
+----
+
+
 `_layouts/page.html`::
 Layout of page-content.
 
+Start a new page in *AsciiDoc* by adding a file ending with `.adoc`.
+Do not forget the `page-`-prefix when setting page variables.
+Jekyll-AsciiDoc has an https://github.com/asciidoctor/jekyll-asciidoc#specifying-a-layout[auto-detection mechanism for the layout].
+Thus, you typically do not have to set the layout to `page` or `post`.
+[source, AsciiDoc]
+----
+= Page title
+:page-layout: page
+
+Content.
+----
+
+Start a new page in *Markdown* by adding a file ending with `.md`.
+
+[source, Markdown]
+----
+---
+layout: page
+# Use either a `# Heading` OR set the title in the frontmatter.
+# Using both will result in two headings.
+---
+# Page title
+
+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.
 
+Start a new post in *AsciiDoc* by adding a file ending with `.adoc` to the `_posts/`-folder.
+Do not forget the `page-`-prefix when setting page variables.
+Jekyll-AsciiDoc has an https://github.com/asciidoctor/jekyll-asciidoc#specifying-a-layout[auto-detection mechanism for the layout].
+Thus, you typically do not have to set the layout to `page` or `post`.
+[source, AsciiDoc]
+----
+= Page title
+:page-layout: post
+
+Content.
+----
+
+Start a new post in *Markdown* by adding a file ending with `.md`.
+
+[source, Markdown]
+----
+---
+layout: post
+# If the title of the post should be different from parts of the filename,
+# change it using the title variable.
+# Using a `# Heading` will result in two headings in the post.
+title: Page title
+---
+
+Content
+----
+
+
 
 === Includes
 
@@ -52,10 +169,61 @@ Layout of blog-posts.
 Generates the code containing links to each page.
 The text of the link is the title of the page.
 
+If the text should be different from the page-title, set the page variable `menu_label`.
+In AsciiDoc files this could be e.g.: `:page-menu_label: 'AnotherText'`.
+
+The order of the links can be determined with the help of the page variable `menu_label`
+(in AsciiDoc e.g. `:page-menu_position: 100`; in frontmatter e.g. `menu_position: 50`).
+Pages with higher numbers appear on the left side of the menu.
+Pages with a negative value for `menu_label` will be hidden from the menu.
+This can be useful for your 404 page, which should be generated by Jekyll, but not visible in the menu.
+
 `_includes/function_list-posts.html`::
 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.
+
+In your `_config.yml` use for example:
+
+[source, YAML]
+----
+email: your-email@example.com
+username_gitlab: XXXX
+username_github: XXXX
+username_xing: XXXX
+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
 
@@ -64,12 +232,27 @@ This file is included by `assets/css/main.scss`.
 
 
 
+== Settings
+
+=== Language
+
+The language of the content can be set using `page.lang` which overrides `site.lang`.
+The default is `en`.
+
+* use e.g. `:page-lang: en` in AsciiDoc
+* use e.g. `lang: en` in frontmatter
+* use e.g. `lang: en` in `_config.yml`
+
+
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://gitlab.com/jekyll-theme-endless/jekyll-theme-endless.gitlab.io.
 This project is intended to be a safe, welcoming space for collaboration,
 and contributors are expected to adhere to the http://contributor-covenant.org[Contributor Covenant] code of conduct.
 
+
+
 == Development
 
 To set up your environment to develop this theme:
@@ -77,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.
@@ -87,6 +275,8 @@ you should see the changes in the browser after a refresh, just like normal.
 When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
 To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-endless.gemspec` accordingly.
 
+
+
 == License
 
 The theme is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].

data/_config.yml

@@ -18,16 +18,15 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: Your awesome title
-email: your-email@example.com
-description: >- # this means to ignore newlines until "baseurl:"
-  Write an awesome description for your new site here. You can edit this
-  line in _config.yml. It will appear in your document head meta (for
-  Google search results) and in your feed.xml site description.
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
-#twitter_username: jekyllrb
-#github_username:  jekyll
+
+
+
+# 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
 #theme: minima
@@ -45,7 +44,6 @@ url: "" # the base hostname & protocol for your site, e.g. http://example.com
 exclude:
   - '*.gemspec'
   - LICENSE.txt
-  - README.adoc
 #   - .sass-cache/
 #   - .jekyll-cache/
 #   - gemfiles/
@@ -57,3 +55,4 @@ exclude:
 #   - vendor/gems/
 #   - vendor/ruby/
 
+

data/_includes/content_footer-usernames.html

@@ -0,0 +1,36 @@
+{% comment %}
+List of contacts in adress-bar.
+{% endcomment %}
+
+<ul class="list-unstyled">
+	{% if site.username_gitlab %}
+		<li>
+			<i class="fa fa-gitlab"></i>
+			<a href="https://gitlab.com/{{ site.username_gitlab }}">{{ site.username_gitlab }}</a>
+		</li>
+	{% endif %}
+	{% if site.username_github %}
+		<li>
+			<i class="fa fa-github"></i>
+			<a href="https://github.com/{{ site.username_github }}">{{ site.username_github }}</a>
+		</li>
+	{% endif %}
+	{% if site.username_xing %}
+		<li>
+			<i class="fa fa-xing"></i>
+			<a href="https://www.xing.com/profile/{{ site.username_xing }}">{{ site.username_xing }}</a>
+		</li>
+	{% endif %}
+	{% if site.username_linkedin %}
+		<li>
+			<i class="fa fa-linkedin"></i>
+			<a href="https://de.linkedin.com/in/{{ site.username_linkedin }}">{{ site.username_linkedin }}</a>
+		</li>
+	{% endif %}
+	{% if site.email %}
+		<li>
+			<i class="fa fa-at"></i>
+			<a href="mailto:{{ site.email }}">{{ site.email }}</a>
+		</li>
+	{% endif %}
+</ul>

data/_includes/function_list-pages.html

@@ -2,12 +2,31 @@
 List of pages that were processed to HTML.
 Used for the pages menu.
 {% endcomment %}
-<ul>
-{% for current_page in site.html_pages %}
-	<li>
-		<a href="{{ current_page.url }}">{{ current_page.title }}</a>
-	</li>
-{% endfor %}
-</ul>
 
+{% comment %}
+Descending order according to their position value.
+(Pages with higher number are on top of the list)
+{% endcomment %}
+{% assign reverse_list = site.html_pages | sort: 'menu_position' | reverse %}
+
+{% for current_page in reverse_list %}
+
+	{% comment %}
+		In order for a menu entry to be visible,
+		1) either a name for the menu entry or a page title must be available
+		2) the position parameter must be larger or equal to 0
+		   (to hide entries, use a negative value)
+		Pages that have not set the position parameter, will be placed to the end.
+	{% endcomment %}
+
+	{% assign label    = current_page.menu_label    | default: current_page.title %}
+	{% assign position = current_page.menu_position | default: 0 %}
+
+	{% if label and position >= 0 %}
+		<li class="nav-item">
+			<a class="nav-link" href="{{ current_page.url }}">{{ label }}</a>
+		</li>
+	{% endif %}
+
+{% endfor %}
 

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,60 @@
+{% comment %}
+
+{% endcomment %}
+{% assign tags = site.tags | sort %}
+
+{% 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 %}
+	{% assign postsWithThisTag = tag | last | 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 %}
+	<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  = tag | last | size %}
+		{% assign percent = number | times: 1.0 | minus: min | times: sizeDifference | divided_by: steps | plus: 100 %}
+		{% assign tagname = tag | first | replace:'-', ' ' %}
+
+		<a
+			href  = "/{{ site.tag_dir | default: 'tags' }}/{{ tag | first }}"
+			style = "font-size: {{ percent }}%"
+			title = "Number of posts with the tag '{{ tagname }}': {{ number }}"
+			>{{ tagname }}</a>
+	</li>
+	{% endfor %}
+</ul>

data/_layouts/default.html

@@ -3,6 +3,113 @@
 layout: html
 ---
 
-{% include function_list-pages.html %}
+<!-- Navigation -->
+<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+	<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">
+			<span class="navbar-toggler-icon"></span>
+		</button>
+
+		<!-- Page links -->
+		<div class="collapse navbar-collapse" id="navbarSupportedContent">
+			<ul class="navbar-nav mr-auto">
+
+				{% include function_list-pages.html %}
+
+			</ul>
+		</div>
+
+	</div>
+</nav>
+
+
+
+<!-- Page title -->
+{% if site.title or site.subtitle %}
+<div class="jumbotron border-bottom bg-light py-4">
+	<div class="container">
+
+		{% if site.title %}
+		<div class="h1">{{ site.title }}</div>
+		{% endif %}
+
+		{% if site.subtitle %}
+		<div class="h2">{{ site.subtitle }}</div>
+		{% endif %}
+
+	</div>
+</div>
+{% endif %}
+
+
+
+<!-- Page content -->
+<main class="container pt-4 pb-5" style="flex-grow: 1;" aria-label="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>
+
+
+
+<!-- Footer -->
+<footer class="footer border-top bg-light">
+	<div class="container">
+
+		<div class="row">
+
+			<div class="col-lg-3 col-md-4 text-left py-3">
+				<address>
+					<div class="h4">Contact me:</div>
+					{% include content_footer-usernames.html %}
+				</address>
+			</div>
+
+			<div class="col-lg-6 col-md-5 text-left py-3">
+				{% if site.disclaimer %}
+				<h4>Disclaimer:</h4>
+				{{ site.disclaimer }}
+				{% endif %}
+			</div>
+
+			<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>
+			</div>
+
+		</div>
+
+	</div>
+</footer>
+
 
-{{ content }}

data/_layouts/html.html

@@ -3,17 +3,31 @@
 # Used for the default website layout (with menu, etc.), as well as the 404-Page.
 ---
 <!DOCTYPE html>
-<html lang="en" dir="ltr">
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}" dir="ltr">
 	<head>
 		<meta charset="utf-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 		<title>
 			{{ page.title }}
 		</title>
+
+		<!-- Font-awesome CSS: https://www.bootstrapcdn.com/fontawesome/ -->
+		<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
+		<!-- Bootstrap CSS -->
+		<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha256-93wNFzm2GO3EoByj9rKZCwGjAJAwr0nujPaOgwUt8ZQ=" crossorigin="anonymous">
+
+		<!-- Theme CSS -->
 		<link rel="stylesheet" href="/assets/css/main.css">
+
 	</head>
 	<body>
 
 		{{ content }}
 
+		<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
+		<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/js/bootstrap.bundle.min.js" integrity="sha256-jXCJJT3KKcnNjZ3rfsabCj1EX4j2omR4xxm+H5CtywE=" crossorigin="anonymous"></script>
+
 	</body>
 </html>
+
+

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/_layouts/page.html

@@ -1,6 +1,12 @@
 ---
 layout: default
 ---
+{% comment %}
+In Markdown pages, page.title is not filled.
+Either set `title` in the frontmater, or use a `# Heading` on the page.
+{% endcomment %}
+{% if page.title %}
 <h1>{{ page.title }}</h1>
+{% endif %}
 
 {{ content }}

data/_layouts/post.html

@@ -1,6 +1,12 @@
 ---
 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 }}

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/background.scss

@@ -1,5 +1,9 @@
 /*
- * Replaced by SCSS-file from the user.
+Simple SCSS-file.
  */
+$bg: #fff;
 
+body {
+	background-color: $bg;
+}
 

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/_sass/user.scss

@@ -1,10 +1,4 @@
 /*
-Simple SCSS-file.
+ * Replaced by SCSS-file from the user.
  */
-$bg: #fff;
-
-body {
-	background-color: $bg;
-}
-
 

data/assets/css/main.scss

@@ -5,8 +5,11 @@
 
 /*
  * imports _scss/background.scss
+ * imports _scss/icons.scss
  */
 @import "background";
+@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.1'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -34,17 +34,25 @@ files:
 - LICENSE.txt
 - README.adoc
 - _config.yml
+- _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/tag-cloud.scss
 - _sass/user.scss
 - assets/css/main.scss
-homepage: https://jekyll-theme-endless.gitlab.io
+- 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
 metadata: {}
@@ -66,5 +74,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A Jekyll theme that was started from scratch.
+summary: A Jekyll theme that was started from scratch. View it on https://jekyll-theme-endless.gitlab.io/.
 test_files: []