jekyll-theme-endless 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1c7a839fe610b31bb919935df249af3e751d9156df0ff9f1a30da1cd4d0a15
-  data.tar.gz: 1f46a59790e4a4dede8c24de6cc71c473b9bf401afc73f9009625e4374900c16
+  metadata.gz: 9750ed9f60becdda6ce0bd03dc188976b12b42a6b78ae796624a9f28ea2392c5
+  data.tar.gz: 22dca4d273ef0c8f13022b67ef0c4c4903a7ae45bdce70e4088cae6b3d66640a
 SHA512:
-  metadata.gz: d239cb6327f68f9c3c069bbd272c1b61ed9b7a5afca9b3f8d3e89cecb7d45fc70ead4c4a3467f9d00d1ea12597e4788a27ad51336a30eee4ba8de453593a5669
-  data.tar.gz: f3bf8b99218570321c9da9bbc6f4c90b87b61034f9610c5786233378f437f1712118602c881d207ab322a3b13ab0a8ff03ced4859038a7267696a75465a1cb87
+  metadata.gz: a9297aeb85d719f9207ccc6358ab415f965e21e7295f0e29667bd476730afbb93456cc8e98e4e2c349d9d9a5d3e47f7ecc380a4fbe3faf3d3444b8d1c02be104
+  data.tar.gz: e2d30bc5a9f1fe829801f3e8aacaa3fbb5a3de0ddef098caabc60b0da010da1cc7208bc61cff442ccd0ee74cc2118b80da1e83418668b816e6004760c5af34fb

data/README.adoc

@@ -99,6 +99,135 @@ The reason is, that Jekyll-AsciiDoc (in contrast to Markdown) escapes HTML by de
 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 `<`).
 
+This repository consists out of 4 different kinds of files producing 3 different artifacts:
+
+1. A *Ruby gem* (the Jekyll theme, you can use in your Jekyll project; besides the (1) layout files, it also includes the (2) plugin for the tag cloud, and the (3) filter for regex-matching in Liquid)
+2. A *Docker image* (that contains all tools needed to build a Jekyll site using this theme)
+3. The *website* you are currently viewing (https://jekyll-theme-endless.gitlab.io/)
+
+The website, the Docker image, and the content of the Ruby gem could all be split into different repositories - and even the the filter, the plugin and the theme files could be in separate repositories. However, I decided to keep everything in one repository to make it easier to manage and develop footnote:[Nevertheless, this has the disadvantage that with every commit, both the website and a new Docker image are rebuilt. I might adjust the setup in the future to improve this.]. This might be a bit confusing at first, but I hope the following deployment diagram helps to understand the structure of this repository and how the different files are related to each other and to the different artifacts.
+
+[[deploymentdiagram]]
+.https://plantuml.com/deployment-diagram[Deployment Diagram] of this repository. The files in this repository are grouped into four categories: (*1*) files that contribute to the Ruby gem artifact, (*2*) files that contribute to the Docker image artifact, (*3*) files that contribute to the website for this theme, and (*4*) helper and configuration files (supporting development, dependency management, deployment, etc.). Files marked in *Green* should be included in your project as dependencies. Files marked in *Blue* are specific to your website (i.e., your blog content). The https://quickstart-blog.gitlab.io/[Quickstart Blog] is an example of these blue files, which you can fork to https://quickstart-blog.gitlab.io/create-jekyll-blog-in-5-minutes/[start your own blog easily]. (*++*++*) The file `_data/tag-description.yml` is not included in the gem package. (*++**++*) The `README` file and the `pages_examples` folder are both packaged in the Ruby gem and used as website content. (*++***++*) You typically want to override default values from the theme's `_config.yml`. (*++****++*) The gem is deployed manually, while the Docker image and GitLab Pages are deployed automatically during each CI pipeline run.
+[plantuml, format="svg"]
+....
+@startuml
+title Deployment diagram of this repository
+top to bottom direction
+
+'package "Repository" {
+
+	' Objects: files
+	' ##########################################################
+	frame "Files and folders of the repository" {
+		' It appears that the file cards need to be added in reverse order
+		' compared to how they should later appear in the diagram.
+		card helper_files #PowderBlue [
+			<b>(4) helper/config-files:</b>
+			----
+			' Files supporting the development
+			* .editorconfig
+			* .gitignore
+			....
+			' Files supporting the deployment
+			* .gitlab-ci.yml
+			* getversion.sh
+			* deploy.sh
+			....
+			' Files used for configuration and dependecy-management
+			* Gemfile
+			* Gemfile.lock
+			* (package.json)
+			....
+			' Screenshot for theme documentation
+			' https://jekyllrb.com/docs/themes/#adding-a-screenshot
+			* screenshot.png
+			* screenshot2.png
+		]
+		card content_files #PowderBlue [
+			<b>(3) content-files:</b>
+			----
+			* index.adoc
+			* README.adoc (**)
+			....
+			* _posts
+			* content
+			* pages
+			* pages_examples (**)
+			* theme-specific
+			....
+			* _config.yml (***)
+			* _configData.yml
+			* _configDocker.yml
+			* _data/tag-description.yml
+		]
+		card docker_files #palegreen [
+			<b>(2) Docker image:</b>
+			----
+			* Dockerfile
+		]
+		card theme_files #palegreen [
+			<b>(1) theme-files:</b>
+			----
+			* _config.yml
+			* jekyll-theme-endless.gemspec
+			* _data (*)
+			* _includes
+			* _layouts
+			* _sass
+			* assets
+			* lib
+			....
+			* README.adoc (**)
+			* pages_examples (**)
+			* LICENSE.txt
+		]
+	}
+
+	' Objects: deployment steps
+	' ##########################################################
+	frame "Build and deployment steps" as B_D {
+		process "deploy.sh (****)"         as deploy_theme
+'		note left of deploy_theme: This process\nis started\nmanually.
+
+		frame ".gitlab-ci.yml"             as CI_file {
+			process "build-docker-image"     as deploy_docker
+			process "deploy-to-gitlab-pages" as deploy_pages
+'			note right of CI_file:  This runs on\neach run of the\nCI pipeline.
+		}
+	}
+
+'}
+
+' Objects: deployment targets
+' ##########################################################
+cloud rubygems.org {
+	artifact "jekyll-theme-endless" as ruby_gem #palegreen
+}
+cloud "registry.gitlab.com" {
+	artifact "jekyll-theme-endless" as docker_image #palegreen
+}
+cloud "GitLab Pages" {
+	artifact "jekyll-theme-endless.gitlab.io" as website
+}
+
+
+
+' Arrows from files to deployment steps
+' ##########################################################
+theme_files   --> deploy_theme
+docker_files  --> deploy_docker
+content_files --> deploy_pages
+
+' Arrows from deployment steps to deployment targets
+' ##########################################################
+deploy_theme  --> ruby_gem
+deploy_docker --> docker_image
+deploy_pages  --> website
+
+@enduml
+....
+
 
 
 

data/_sass/adoc-code.scss

@@ -5,6 +5,16 @@
 
 	.content {
 
+		/** Styles for the <pre> used for code- and listing blocks */
+		pre {
+			-moz-tab-size: 2;
+			tab-size: 2;
+			background-color: white;
+			padding: .5em 1em;
+			border: 1px solid #ccc;
+			border-radius: 4px;
+		}
+
 		code {
 			position: relative;
 			display: block;
@@ -12,6 +22,7 @@
 			z-index: 0;
 		}
 
+		/* Displays the language label */
 		code::before {
 			content: attr(data-lang);
 			position: absolute;

data/_sass/rouge-highlight.scss

@@ -3,14 +3,6 @@
  */
 
 .highlight {
-	@at-root pre#{&} {
-		-moz-tab-size: 2;
-		tab-size: 2;
-		background-color: white;
-		padding: .5em 1em;
-		border: 1px solid #ccc;
-		border-radius: 4px;
-	}
 	.hll { background-color: #ffffcc }
 	.c { color: #080; font-style: italic } /* Comment */
 	.err { color: #AA0000; background-color: #FFAAAA } /* Error */

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

@@ -1,5 +1,5 @@
 module Jekyll
 	module Endless
-		VERSION = '0.21.1'
+		VERSION = '0.22.0'
 	end
 end

data/pages_examples/showroom-asciidoc.adoc

@@ -70,7 +70,7 @@ This way, you can display the same code in multiple places but only need to upda
 You can even embed production code directly.
 
 // Includes the code of the file "showroom-asciidoc-code.html" starting from line 4.
-.Source code of the AsciiDoc Showroom:
+.HTML code block included from an external file. The first three lines of the file are skipped.
 [source, html]
 ----
 include::showroom-asciidoc-code.html[lines=4..]
@@ -80,6 +80,52 @@ include::showroom-asciidoc-code.html[lines=4..]
 
 
 
+[[listing]]
+== Listings without syntax highlighting
+
+The `[source]` block used for source code listings is a special type of listing block that applies syntax highlighting. For simple text listings (e.g. console output, folder structures, etc.) you can instead use the `[listing]` block.
+
+.Example of a folder structure listing. It is enriched with icons for files and folders taken from the Unicode standard. You can look up the Unicode of the icons on https://emojipedia.org/ and copy them from there. footnote:[The icons may not be displayed correctly in all fonts and browsers. https://emojipedia.org/unicode-6.0[Unicode 6.0] was the first version of the Unicode Standard to support emoji.]
+[listing#folderstructure]
+----
+📄 config.yml
+📂 data
+	📂 images
+		🖼️ photo1.jpg
+		🖼️ photo2.jpg
+		🖼️ photo3.jpg
+📂 pages
+	📄 index.adoc
+	📄 ranges.adoc
+📂 _posts
+	📄 2025-10-08-title-of-the-article.adoc
+----
+
+
+.Folder structure listing from the previous example, but with a tree-like structure directly taken from the output of the `tree` command footnote:[The tree command is a standard Unix command used to display the directory structure of a path in a tree-like format. If not istalled, use `sudo apt install tree` on Debian-based systems to install it.]. Additionally, annotations with automatic numbering are added.
+----
+📂 ./
+├── 📄 config.yml <.>
+├── 📂 data
+│   └── 📂 images <.>
+│       ├── 🖼️ photo1.jpg
+│       ├── 🖼️ photo2.jpg
+│       └── 🖼️ photo3.jpg
+├── 📂 pages <.>
+│   ├── 📄 index.adoc
+│   └── 📄 ranges.adoc
+└──📂 _posts <.>
+    └── 📄 2025-10-08-title-of-the-article.adoc
+----
+<.> config-file
+<.> Folder with images
+<.> Folder with pages
+<.> Folder with blog posts
+
+
+
+
+
 == Text formatting
 
 * Text with *strong* significance to me
@@ -316,7 +362,12 @@ Content of the sidebar block.
 [[passthrough-blocks]]
 == Passthrough blocks
 
-With passthrough blocks (delimited with `&#43;&#43;&#43;&#43;`), you can embed raw HTML code directly into your AsciiDoc document. Common examples are the inclusion of an HTML form, CSS and JavaScript snippets.
+With https://docs.asciidoctor.org/asciidoc/latest/pass/[passthrough blocks] (delimited with `&#43;&#43;&#43;&#43;`),
+you can embed raw HTML code directly into your AsciiDoc document.
+Common examples are the inclusion of an HTML form, CSS and JavaScript snippets.
+
+CAUTION: Keep in mind that this only affects the HTML output. It will be visible as-is in other output formats like PDF.
+
 
 To add a form to your document, you can use:
 
@@ -605,7 +656,7 @@ https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/barcode/[Bar
 // https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/bpmn/[BPMN],
 // https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/d2/[D2],
 // https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/diagrams/[Diagrams],
-// https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/meme/[Meme],
+https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/meme/[Meme],
 https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/tikz/[TikZ].
 
 
@@ -1135,6 +1186,20 @@ qrcode::This QR code is generated with Asciidoctor Diagram and presented in PNG
 
 
 
+[[meme]]
+=== Meme
+
+The https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/meme/[meme extension] is based on https://imagemagick.org/[ImageMagick] and is used to create simple memes with text overlaid on images.
+
+:pic_2_src: ../assets/images/cat.jpg
+
+.Example of a meme created with the Meme diagram type, featuring an image of a cat with overlaid text at the top and bottom. The text is styled with a stroke width of 2 and a white fill color to enhance visibility against the background image.
+meme::{pic_2_src}[Markdown? // Really?, Did you understand // a single word written here?, stroke-width=2, fill-color=white]
+
+
+
+
+
 [[tikz]]
 === TikZ
 https://github.com/pgf-tikz/pgf[TikZ] is a powerful and user-friendly syntax layer built upon the PGF (Portable Graphic Format) package for creating high-quality graphics programmatically within LaTeX documents.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Sven Boekhoff
@@ -288,6 +288,7 @@ files:
 - _sass/tag-cloud.scss
 - _sass/user.scss
 - assets/css/main.scss
+- assets/images/cat.jpg
 - assets/images/tree-3822149_640.jpg
 - lib/jekyll-theme-endless.rb
 - lib/jekyll-theme-endless/generate-tagpages.rb