jekyll-theme-endless 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb31bb43fb78dd91b274a5f84a57176b0aea3699eab6b1d3c8a2b992f1e3b79f
-  data.tar.gz: 9f53070ae8f360023afa52c96a1d7207fffd392afc84b96a835ff329f5c2b809
+  metadata.gz: c44a8b0b77f57bf3ef8c3107d45d5993590b951bafe7123b7a3d43aff1755e0f
+  data.tar.gz: ec822eb3c232ed9e4bceae9459c9ec6d0dc93c366269bf88ce046a61bc17d49e
 SHA512:
-  metadata.gz: a5b90be2a585639374d61333397b4deeacb34d243a75406de135882d8ec174bf43eefb8d9c1f67be8d5118d56dfe7cba863ba962863ae43052f52e48904a8a4b
-  data.tar.gz: 8ed8555b0301d77081320c5571d3a29aabe41de5127cfa209bf651b667a208c59687d9e233b4fb130c6ac3e062d07ca2f3b9b172888b5dfe8550191ae1f4c435
+  metadata.gz: 2eb544cacc56b869f3d57935b580d824b11116649541ae2c4b508bd30f245a8e4a933719946f8c46fdcde7cc782e61a4fbaa6ab52f59b016202696d41a484e7e
+  data.tar.gz: 3a4fd8c1fa675898414c9618d0f4f91dded12bde8bb51e91525a96291b34452fe84f09573dc9c216fd29b1341c54661f3e4ad27916e7693797e0644905b5a938

data/README.adoc

@@ -31,20 +31,31 @@ Add this line to your Jekyll site's `Gemfile`:
 gem "jekyll-theme-endless"
 ----
 
-And add this line to your Jekyll site's `_config.yml`:
+In your Jekyll site's `_config.yml`:
+
+. activate the theme
+. activate the plugin to generate pages for each tag linked in the tag-cloud
 
 [source,yaml]
 ----
 theme: jekyll-theme-endless
+plugins:
+  - jekyll-theme-endless
 ----
 
 And then execute:
 
-    $ bundle
+[source,shell]
+----
+bundle
+----
 
 Or install it yourself as:
 
-    $ gem install jekyll-theme-endless
+[source,shell]
+----
+gem install jekyll-theme-endless
+----
 
 
 
@@ -56,7 +67,7 @@ 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 `<`).
+If you want to use Markdown AND have HTML-commands in the title, simply escape them (e.g. use `\&lt;` instead of `<`).
 
 
 
@@ -67,9 +78,13 @@ Here I describe available layouts, includes, sass and/or assets here.
 === Layouts
 
 `_layouts/html.html`::
+
 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.
@@ -106,16 +121,20 @@ disclaimer: >- # this means to ignore newlines until the next entry
   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]
+
+[source, asciidoc]
 ----
 = Page title
 :page-layout: page
@@ -125,7 +144,7 @@ Content.
 
 Start a new page in *Markdown* by adding a file ending with `.md`.
 
-[source, Markdown]
+[source, markdown]
 ----
 ---
 layout: page
@@ -136,22 +155,40 @@ layout: page
 
 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.
 
+It seems that plugins cannot read the files provided by themes.
+Thus, the file has to be created in the `_layouts` folder in every Jekyll project.
+The content can be for example the following:
+
+[source, liquid]
+----
+include::_layouts/page-tag.html[]
+----
+--
+
+
 `_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]
+
+[source, asciidoc]
 ----
 = Page title
 :page-layout: post
@@ -161,7 +198,7 @@ Content.
 
 Start a new post in *Markdown* by adding a file ending with `.md`.
 
-[source, Markdown]
+[source, markdown]
 ----
 ---
 layout: post
@@ -173,12 +210,23 @@ title: Page title
 
 Content
 ----
+--
 
 
 
 === Includes
 
+`_includes/container_end-of-document.html`::
+
+An empty file that can be overwritten by the user of the theme.
+The file is included directly before the `</body>`.
+It can be used to e.g. append JavaScript commands to the end of the file
+without having to rewrite a complete layout file.
+
+
 `_includes/function_list-pages.html`::
++
+--
 Generates the code containing links to each page.
 The text of the link is the title of the page.
 
@@ -190,21 +238,32 @@ The order of the links can be determined with the help of the page variable `men
 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.
+Generates a list containing blog posts.
+
+
+`_includes/function_post-in-list-short.html`::
+Generates the code to display a single post in the list of blog posts.
+An entry consists of the title of the blog post linked to the article.
+If a permalink is configured for the article, this is indicated by an icon.
+
 
 `_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]
+[source, yaml]
 ----
 email: your-email@example.com
 username_gitlab: XXXX
@@ -212,21 +271,27 @@ username_github: XXXX
 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]
+[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.
@@ -235,15 +300,16 @@ Displays links to the previous and the next post of your blog.
 
 === Plugins
 
-`_plugins/generate-tagpages.rb`
-
+`_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]
+[source, yaml]
 ----
 # Settings for tag cloud:
 # The name of the directory in which the files for each tag are created
@@ -253,7 +319,7 @@ tag_dir: post-for-tag
 # default: `Tag: `
 tag_title_prefix: "Posts tagged with: "
 ----
-
+--
 
 
 === Styles

data/_config.yml

@@ -30,6 +30,9 @@ asciidoctor:
     # https://github.com/asciidoctor/jekyll-asciidoc#stylesheet-for-code-highlighting
     # https://github.com/asciidoctor/jekyll-asciidoc/issues/221#issuecomment-526857488
     source-highlighter: rouge
+    # Activate font-based admonition icons
+    # https://github.com/asciidoctor/jekyll-asciidoc#font-based-admonition-and-inline-icons
+    icons: font
 
 
 

data/_includes/container_end-of-document.html

@@ -0,0 +1,9 @@
+{% comment %}
+This document is planned to be empty.
+
+It can be overwritten by the user of the theme in order to
+e.g. append JavaScript commands to the end of the file
+without having to rewrite a complete layout file.
+
+The file is included directly before the </body>.
+{% endcomment %}

data/_includes/function_list-posts.html

@@ -1,13 +1,22 @@
 {% comment %}
 List of blog-posts.
+Expects an array of post objects in the parameter `postlist`.
+
+Call via:
+----
+{% include function_list-posts.html
+	postlist=POSTLIST
+%}
+----
 {% endcomment %}
 
 <ul>
-{% for current_post in site.posts %}
+{% for current_post in include.postlist %}
 	<li>
-		{{ current_post.date | date: "%Y-%m-%d" }}: <a href="{{ current_post.url }}">{{ current_post.title }}</a>
+		{% include function_post-in-list-short.html
+			post = current_post
+		%}
 	</li>
 {% endfor %}
 </ul>
 
-

data/_includes/function_post-in-list-short.html

@@ -0,0 +1,25 @@
+{% comment %}
+Processes a single post for display in the list of articles.
+Expects a post object as a parameter.
+
+Call via:
+----
+<li>
+	{% include function_post-in-list-short.html
+		post=current_post
+	%}
+</li>
+----
+{% endcomment %}
+
+
+{% assign post = include.post %}
+
+{{ post.date | date: "%Y-%m-%d" }}:
+{% if post.permalink %}
+	{% comment %}
+	I use permalinks to indicate that an article was at some point considered beeing finished.
+	{% endcomment %}
+	 <i class="fa fa-link text-success" title="This article has a permalink."></i>
+{% endif %}
+<a href="{{ post.url }}">{{ post.title }}</a>

data/_includes/function_tag-cloud.html

@@ -64,8 +64,16 @@ Assumption: Non of the tags occurs more than one million times.
 		{% 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:'-', ' ' %}
+		{% comment %}
+			Tags that only occur once, should be displayed smaller than 100% in the tag cloud.
+		{% endcomment %}
+		{% if number == 1 %}
+			{% assign percent = 65 %}
+		{% else %}
+			{% assign percent = number | times: 1.0 | minus: min | times: sizeDifference | divided_by: steps | plus: 100 %}
+		{% endif %}
+
+		{% assign tagname = tag %}
 
 		<a
 			href  = "/{{ site.tag_dir | default: 'tags' }}/{{ tag }}"

data/_layouts/html.html

@@ -27,6 +27,8 @@
 		<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>
 
+		{% include container_end-of-document.html %}
+
 	</body>
 </html>
 

data/_layouts/page-postlist.html

@@ -4,6 +4,8 @@ layout: page
 ---
 {{ content }}
 
-{% include function_list-posts.html %}
+{% include function_list-posts.html
+	postlist=site.posts
+%}
 
 

data/_layouts/page-tag.html

@@ -13,14 +13,7 @@ page.tag and page.title are set by the plugin `generate-taglist`.
 	Number of posts tagged with "<em>{{ page.tag }}</em>": <strong>{{ site.tags[ page.tag ] | size }}</strong>
 </p>
 
-<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>
-
-
+{% assign tag_posts = site.tags[page.tag] %}
+{% include function_list-posts.html
+	postlist=tag_posts
+%}

data/_sass/adoc-admonition.scss

@@ -0,0 +1,51 @@
+div.admonitionblock {
+	border-radius: 5px;
+	box-shadow: 0 1px 4px #aaa;
+	background: #fff;
+	color: #111;
+}
+.admonitionblock table {
+	background-color: transparent;
+	width: 100%;
+	td {
+		padding: .75em .25em;
+	}
+}
+/* See:
+ * https://github.com/asciidoctor/jekyll-asciidoc#font-based-admonition-and-inline-icons
+ */
+span.icon>.fa {
+	cursor: default;
+}
+.admonitionblock td.icon {
+	text-align: center;
+	width: 66px;
+
+	[class^="fa icon-"] {
+		font-size: 1.5em;
+		text-shadow: 1px 1px 2px rgba(0,0,0,.5);
+		cursor: default;
+	}
+	.icon-note:before {
+		content: "\f05a";
+		color: #19407c;
+	}
+	.icon-tip:before {
+		content: "\f0eb";
+		text-shadow: 1px 1px 2px rgba(155,155,0,.8);
+		color: #111;
+	}
+	.icon-warning:before {
+		content: "\f071";
+		color: #bf6900;
+	}
+	.icon-caution:before {
+		content: "\f06d";
+		color: #bf3400;
+	}
+	.icon-important:before {
+		content: "\f06a";
+		color: #bf0000;
+	}
+
+}

data/_sass/adoc-images.scss

@@ -0,0 +1,23 @@
+/**
+ * Images.
+ */
+div.imageblock {
+	text-align: center;
+
+	img {
+		/* See also `img-fluid` class from Bootstrap. */
+		max-width: 100%;
+		height: auto;
+		background: #fff;
+		border: 1px solid #aaa;
+		padding: 10px 10px;
+		border-radius: 5px;
+	}
+	.title {
+		padding-top: .75rem;
+		padding-bottom: .75rem;
+		color: #6c757d;
+	}
+
+}
+

data/_sass/adoc-lists.scss

@@ -0,0 +1,20 @@
+dl{
+	dt {
+		margin-bottom: .3125em;
+		font-weight: bold;
+	}
+	dd {
+		margin-left: .5em;
+		padding-left: .5em;
+		margin-bottom: 1.25em;
+		border-left: 5px solid #dee2e6;
+	}
+}
+
+li {
+	p {
+		/* Reduce distance between list entries. */
+		margin-bottom: .25rem;
+	}
+}
+

data/_sass/adoc-quote.scss

@@ -0,0 +1,48 @@
+.quoteblock {
+	margin: 1em 1.5em;
+	font-style: italic;
+	color: rgba(0,0,0,.6);
+
+	& > .title {
+		margin-left: -1.5em;
+		margin-bottom: .75em;
+		font-weight: bold;
+	}
+
+	blockquote {
+		text-align: center;
+		background-color: #f8f8f8;
+
+		&::before, &::after {
+			font-size: 3em;
+			font-weight: bold;
+			line-height: .6em;
+			color: #721;
+			text-shadow: 0 1px 2px rgba(0,0,0,.1);
+		}
+		&::before {
+			content: "\201c";
+			float: left;
+			margin-left: -.6em;
+		}
+		&::after {
+			content: "\201d";
+			float: right;
+			margin-right: -.6em;
+			margin-top: -.6em;
+		}
+	}
+
+	.attribution {
+		margin-top: .5em;
+		margin-right: .5ex;
+		text-align: right;
+
+		cite {
+			display: block;
+			letter-spacing: -.025em;
+			font-size: .75em;
+		}
+	}
+
+}

data/_sass/adoc-tables.scss

@@ -0,0 +1,35 @@
+/**
+ * Table blocks.
+ */
+table.tableblock {
+
+	thead,
+	tfoot {
+		background: #e7e8e7;
+		font-weight: bold;
+	}
+
+	th.tableblock,
+	td.tableblock {
+		border: 0 solid #f00;
+		border: 0 solid #dedede;
+		padding: .5em .625em;
+	}
+
+	caption {
+		caption-side: top;
+	}
+
+}
+
+p.tableblock {
+	margin-bottom: 0;
+}
+
+table.grid-all {
+	th.tableblock,
+	td.tableblock {
+		border-width: 1px;
+	}
+}
+

data/_sass/adoc.scss

@@ -0,0 +1,14 @@
+/*
+ * Applies to adminition blocks and table blocks
+ */
+table {
+	background: #fff;
+	margin: .5em auto;
+}
+
+table tr.even,
+table tr.alt,
+table tr:nth-of-type(even) {
+	background: #f8f8f7;
+}
+

data/_sass/rouge-highlight.scss

@@ -3,7 +3,12 @@
  */
 
 .highlight {
-	@at-root pre#{&} { background-color: #f8f8f8; padding: .5em 1em;}
+	@at-root pre#{&} {
+		-moz-tab-size: 2;
+		tab-size: 2;
+		background-color: #f8f8f8;
+		padding: .5em 1em;
+	}
 	.hll { background-color: #ffffcc }
 	.c { color: #080; font-style: italic } /* Comment */
 	.err { color: #AA0000; background-color: #FFAAAA } /* Error */

data/_sass/structure.scss

@@ -0,0 +1,8 @@
+/*
+ * Styles of structuring elements.
+ */
+h2 {
+	padding-top: 1em;
+}
+
+

data/_sass/tag-cloud.scss

@@ -6,6 +6,7 @@
 
 	li {
 		display: inline;
+		line-height: 1;
 	}
 	/* Every tag in the tag cloud should have a point as a separator. */
 	li::after {

data/assets/css/main.scss

@@ -11,12 +11,23 @@
 @import "address";
 @import "tag-cloud";
 @import "posts";
+@import "structure";
 
 /*
  * import styles for highlighting source code that was annotated using rouge.
  */
 @import "rouge-highlight";
 
+/*
+ * import styles for AsciiDoc.
+ */
+@import "adoc";
+@import "adoc-admonition";
+@import "adoc-tables";
+@import "adoc-lists";
+@import "adoc-quote";
+@import "adoc-images";
+
 /*
  * import SCSS-Code contributed by the user of the theme.
  * imports from _scss/background.scss

data/lib/jekyll-theme-endless.rb

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

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

@@ -1,5 +1,5 @@
 module Jekyll
-  module Endless
-    VERSION = '0.5.0'
-  end
+	module Endless
+		VERSION = '0.9.0'
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -34,9 +34,11 @@ files:
 - LICENSE.txt
 - README.adoc
 - _config.yml
+- _includes/container_end-of-document.html
 - _includes/content_footer-usernames.html
 - _includes/function_list-pages.html
 - _includes/function_list-posts.html
+- _includes/function_post-in-list-short.html
 - _includes/function_show-dates.html
 - _includes/function_show-prev-next-navigation.html
 - _includes/function_tag-cloud.html
@@ -48,12 +50,20 @@ files:
 - _layouts/page.html
 - _layouts/post.html
 - _sass/address.scss
+- _sass/adoc-admonition.scss
+- _sass/adoc-images.scss
+- _sass/adoc-lists.scss
+- _sass/adoc-quote.scss
+- _sass/adoc-tables.scss
+- _sass/adoc.scss
 - _sass/background.scss
 - _sass/posts.scss
 - _sass/rouge-highlight.scss
+- _sass/structure.scss
 - _sass/tag-cloud.scss
 - _sass/user.scss
 - assets/css/main.scss
+- assets/images/tree-3822149_640.jpg
 - lib/jekyll-theme-endless.rb
 - lib/jekyll-theme-endless/generate-tagpages.rb
 - lib/jekyll-theme-endless/version.rb