jekyll-theme-endless 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a765efd0983e1ceede6edf8cb5e9585d1a7443ab9caa5bf1ed9d21d8a83d991
-  data.tar.gz: 7a0845b138a722faca39492e729990081a622cb694b7434ce6bb15ff1cbe2d98
+  metadata.gz: '048954cb6b01292c57d7aeddb592a94e02e71ca49ea3ff6bc17cc128e0a5dac5'
+  data.tar.gz: cc6597fcda7de04fd940b0904d0d542b18e9119201ccb0ddc1140080486ab456
 SHA512:
-  metadata.gz: 218292073372247f62a3a5233e7833a4f1c01daef7ae856547d1b3b163b3104288e851d636e8170eeedd7c1c0bb68fa7b7cca1ea4c0646efe324fe43e1fa574b
-  data.tar.gz: 4547082a60f0a47c89539ddad558b303efda39350942f2e604b428a54a39cdc455daa1780cd34709607444c57ab8ab8d40f55e32e0408d6926b78c0b2078d832
+  metadata.gz: 03d0427df894a7fa5d29e4d7a2021db478c702befa0ef8e43a0786cf3f7985a522310ff518df391282b8101e57cce2d993fbdfe4b7d82d4f961746adf3aa4e68
+  data.tar.gz: 77afae077fa3b9d8eaee554e650c5333a682ea6aba3ee003a28992d94dfb70dcc50631f1dd7425db003b04f67d41cd34948ca2ae56c83fec92df5632b34e3c7c

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
 

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.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,12 +44,14 @@ files:
 - _layouts/page-tag.html
 - _layouts/page.html
 - _layouts/post.html
-- _plugins/generate-tagpages.rb
 - _sass/address.scss
 - _sass/background.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
-
-