jekyll-theme-endless 0.15.0 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3affa436a6ef829a6b365277fc4bc8edfe2642304e1a2707a80c95980132d99e
-  data.tar.gz: 72d46c7972912ca6ddf3797ddbb2e36fe800c9cae9b3f4d79af3ebe9aeadfded
+  metadata.gz: a7bbaeca21ac57a821e22eb43f438b9328b3dd0330277eeb479a9c10a0d42c5b
+  data.tar.gz: 27cce9d41f9f364ac29d86287b3f37fd15cbb829c3b6cb76ded552bdfc070abc
 SHA512:
-  metadata.gz: 6f30ef2f112cbef73f2ead8984f9572ed02a1ed3dc76189302d739cde00e65bedeb0ca5d4e5a886ed013d6855195b6b2ef3430d4478690378c652af50ded513c
-  data.tar.gz: d8e7dbe09a5aee6c893ee7b12c4a14ed74298e0f00ac97bb10479d7c482f28395f4e2605f0123e6895680af1ed46b64d47735d2f74039d09533f3f7065508bbf
+  metadata.gz: 0d452bcc2934df29c0211eba621849717a13ed163321b387f2b8e1369facdfab14e3b3e3b63bc984934f3db082a8fbe2b4571bb83a1537e22b1e593084213cec
+  data.tar.gz: caac122db717ca3962838479dff411f35f0110df8b932c0b05347cdc9a614d921780b34bdafa6198e61a438e35a5d1bc0e12b7fc6b64dce46a9e807e6a0c0d67

data/README.adoc

@@ -4,6 +4,7 @@
 :toc: preamble
 :toclevels: 3
 :page-summary: "Explore the documentation for jekyll-theme-endless: a Jekyll theme for AsciiDoc blogging, featuring tag cloud, code highlighting, responsive design, and more."
+:page-permalink: /documentation/
 
 
 
@@ -119,20 +120,27 @@ CAUTION: If you want to use special characters in your tags, you need to create
 
 == Usage
 
-Here I describe available layouts, includes, SASS- and other assets.
+Here I describe available _layouts_, _includes_, SASS- and other _assets_.
 
 To copy all the files of the theme into a folder,
 you can use the following command (in the root directory of your Jekyll project):
 
 [source,bash]
 ----
-cp -r $(bundle show jekyll-theme-endless)/ .
+cp -r "$(bundle show jekyll-theme-endless)" .
 ----
 
 This will copy the theme-folder containing all its files into the current directory.
 From there, you can selectively move files to your project and modify them as needed.
 Your (modified) copy will afterwards overwrite the contents provided by the theme.
 
+If you only want to copy the example pages (like the AsciiDoc showroom) to your project, use:
+
+[source,bash]
+----
+cp -r "$(bundle show jekyll-theme-endless)/pages_examples" .
+----
+
 NOTE: Whenever you create custom versions of files in this theme, consider whether they might also be useful for others. In that case, you could contribute the changes to the project. Feel free to contact me about it.
 
 
@@ -632,6 +640,35 @@ I use, for example:
 
 
 
+[[Dockerfile]]
+=== Dockerfile
+
+This repository includes a `Dockerfile` that defines a custom *Docker image*,
+built and stored in the GitLab Docker registry during the CI/CD process.
+This image provides an optimized environment for building your Jekyll site with all necessary tools pre-installed, including:
+
+* An SSH client, enabling deployment to your own server
+* Dependency managers like Yarn, for handling JavaScript and CSS dependencies
+* Tools for generating graphics from text-based diagrams, such as Graphviz, Ditaa, and PlantUML
+
+If you are using GitLab CI/CD, you can easily leverage this pre-built image
+by adding the following `image:` line to your `.gitlab-ci.yml` file:
+
+[source, yml]
+----
+# Use the pre-built Docker image provided by 'jekyll-theme-endless'
+image: "registry.gitlab.com/jekyll-theme-endless/jekyll-theme-endless.gitlab.io:latest"
+----
+
+By using this Docker image, you avoid the need to install each required tool individually
+in a separate base image (such as `ruby:latest`) during every build process.
+This approach not only simplifies your CI/CD configuration but also reduces build times,
+as all necessary dependencies are already bundled into a single, reusable image.
+
+
+
+
+
 == Settings
 
 === Language
@@ -667,7 +704,13 @@ To set up your environment to develop this theme:
 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`.
+To test the theme *with example-data*, run:
+
+[source, bash]
+----
+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`.

data/_config.yml

@@ -48,12 +48,6 @@ asciidoctor:
     # https://github.com/asciidoctor/jekyll-asciidoc#font-based-admonition-and-inline-icons
     icons: font
 
-# Keep files generated by AsciiDoctor-diagram during the build process
-# https://github.com/asciidoctor/jekyll-asciidoc#preserving-generated-images
-# The paths in keep_files must not have a / at the beginning or end.
-keep_files:
-- _diagrams
-
 
 
 
@@ -79,6 +73,19 @@ plugins:
   - jekyll-feed
   - asciidoctor-diagram
 
+
+
+# Keep files generated by AsciiDoctor-diagram during the build process
+# https://github.com/asciidoctor/jekyll-asciidoc#preserving-generated-images
+# The paths in keep_files must not have a / at the beginning or end.
+# Note: Settings like `keep_files`, `exclude`, `include`, and some others
+# are not automatically inherited by the project using the theme
+# and must be explicitly defined in the project's `_config.yml`.
+keep_files:
+- _diagrams
+
+
+
 # Exclude files from processing.
 #
 # Excluded items can be processed by explicitly listing the directories or
@@ -107,8 +114,6 @@ exclude:
 
 
 
-
-
 # compressed: Produces minified CSS in a single line, with no spaces or comments, for the smallest file size.
 # expanded: Outputs fully expanded CSS with indentation, making it easy to read but larger in size.
 # nested: Generates CSS with nested indentation, resembling the structure of the Sass code, for improved readability.

data/_sass/adoc-admonition.scss

@@ -4,6 +4,8 @@ div.admonitionblock {
 	background: #fff;
 	color: #111;
 	margin: 2em 0;
+	// Workaround for overflow issues with code blocks inside admonition blocks. (see release notes 0.13.X)
+	overflow-x: auto;
 }
 .admonitionblock table {
 	background-color: transparent;
@@ -12,6 +14,9 @@ div.admonitionblock {
 		padding: .75em .25em;
 		border-width: 0;
 	}
+	td.content {
+		padding-right: .75em;
+	}
 }
 /* See:
  * https://github.com/asciidoctor/jekyll-asciidoc#font-based-admonition-and-inline-icons

data/_sass/adoc-code.scss

@@ -8,6 +8,8 @@
 		code {
 			position: relative;
 			display: block;
+			// Workaround to prevent the language label from overlapping the source code (see release notes 0.10.X).
+			z-index: 0;
 		}
 
 		code::before {
@@ -21,6 +23,8 @@
 			color: #333;
 			border-radius: 3px;
 			border: 1px solid #ccc;
+			// Workaround to prevent the language label from overlapping the source code (see release notes 0.10.X).
+			z-index: -10;
 		}
 
 		/* If data-lang is empty or not set, ::before will be hidden. */

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

@@ -1,5 +1,5 @@
 module Jekyll
 	module Endless
-		VERSION = '0.15.0'
+		VERSION = '0.15.2'
 	end
 end

data/pages_examples/showroom-asciidoc-code.html

@@ -0,0 +1,14 @@
+---
+published: false
+---
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Document</title>
+</head>
+<body>
+    HTML boilerplate code.
+</body>
+</html>

data/pages_examples/showroom-asciidoc.adoc

@@ -0,0 +1,548 @@
+= AsciiDoc showroom
+:page-menu_label: AsciiDoc
+:page-menu_position: 200
+:page-permalink: /asciidoc-showroom/
+// Enable support for experimental features like "keyboard shortcuts"
+:experimental:
+// Enable support for mathematical expressions
+:stem:
+:toc: preamble
+:toclevels: 5
+:page-summary: "Discover the AsciiDoc showroom: See what's possible with AsciiDoc in this theme, including code, tables, lists, quotes, and more for advanced formatting."
+
+
+
+Here are a few examples to demonstrate what AsciiDoc, as a markup language, has to offer.
+Its capabilities far exceed those of Markdown.
+Thus, this page will only cover a small portion to give you a sense of what's possible.
+
+Checking out the source code of this page can also help you get started with AsciiDoc.
+For more information, you can refer to the official AsciiDoc and Asciidoctor documentation.
+
+* https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc Syntax Quick Reference]
+* https://docs.asciidoctor.org/asciidoctor/latest/[Asciidoctor Documentation]
+* https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]
+
+
+
+
+
+== Source code listings
+
+.Python source code (language is shown in the upper right corner):
+[source, python]
+----
+# Python code
+def greet(name):
+    print(f"Hello, {name}!")
+
+greet('World')
+----
+
+.Code block with an unknown language (language info ist not shown):
+[source]
+----
+Start
+Set counter to 0
+While counter < 5 do
+    Print "This is loop iteration", counter
+    Increment counter by 1
+End
+----
+
+// For detailed information see:
+// https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#literals-and-source-code
+.Python code block with annotations.
+[source,python]
+----
+def square(number):// <1>
+    return number ** 2
+
+result = square(4)// <2>
+print(result)// <3>
+----
+<1> The function `square` calculates the square of a given number.
+<2> The function is called with the number 4, and the result is stored in `result`.
+<3> The result is printed to the console.
+
+You can also directly insert source code from a file into your AsciiDoc document.
+This way, you can display the same code in multiple places but only need to update it in one location.
+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:
+[source, html]
+----
+include::showroom-asciidoc-code.html[lines=4..]
+----
+
+
+
+
+
+== Text formatting
+
+* Text with *strong* significance to me
+* _Emphasized_ text
+* *_Combination_* of both
+* You can also format parts of a word:
+** **C**reate, **R**ead, **U**pdate, and **D**elete (CRUD)
+** Counter__clock__wise
+** ``string``s
+* ^super^script
+* ~sub~script
+* [.line-through]#This is strikethrough text#
+* [.underline]#This is underlined text#
+* `monospace text`
+
+
+
+
+
+[[links]]
+== Links
+
+* https://example.com
+* https://example.com[Link to example.com]
+* test@example.com
+* mailto:test@example.com[send a test message to example.com]
+// Link to a page with a permalink.
+* In AsciiDoc, you can easily add links to other articles: link:/asciidoc-example/[Example post for AsciiDoc with explanations].
+// Link to the section on the page marked with the anchor [[admonition]].
+* You can also link to sections on the page using link anchors: link:#admonition[Link to the section: "Adminition blocks" on this page]
+
+
+
+
+
+== Keyboard shortcuts and menu paths
+
+kbd:[Ctrl + Alt + Del]
+
+menu:View[Appearance > Full Screen]
+
+
+
+
+
+[[admonition]]
+== Admonition blocks
+
+TIP: Admonition: `TIP`.
+
+IMPORTANT: Admonition: `IMPORTANT`.
+
+[NOTE]
+====
+Admonition blocks (here shown for the admonition: `NOTE`) can contain several lines and complex content like:
+
+.A list with several items.
+- one
+- two
+- three
+
+.Another paragraph.
+
+.And even blocks with source code.
+[source, java]
+----
+public class HelloWorld {
+    public static void main(String[] args) {
+        System.out.println("Hello, World!");
+    }
+}
+----
+====
+
+CAUTION: Admonition: `CAUTION`.
+
+WARNING: Admonition: `WARNING`.
+
+
+
+
+
+== Tables
+
+.A simple table
+[options="header", cols="3*"]
+|===
+| Name
+| Age
+| City
+
+| Max Mustermann
+| 30
+| Berlin
+
+// The cells in AsciiDoc can be in the same row or shifted
+| John Doe | 45 | New York
+
+| Maria Musterfrau | 28
+
+
+// They can be also separated by blank lines.
+| München
+|===
+
+
+
+.Table showcasing AsciiDoc table capabilities
+[options="header", cols="<.<3,^2,>2"]
+|===
+| Feature                       | Description                                     | Example
+
+| **Bold and Italics**          | Supports *italic* and **bold** text formatting  | _Italic_ and *bold* formatting
+3+| **This cell spans 3 columns**
+
+.2+| **This cell spans 2 rows** | First row of the spanned cell                   | Another cell
+// In the following, I manually corrected the disrupted cell count and
+// the resulting formatting issues caused by the colspanning for each individual cell.
+                               ^| Second row of the spanned cell                  >| Another cell
+
+// Cells do not have to be placed side by side; they can simply be written one above the other:
+| **Links**
+| Supports links within the table
+| https://example.com[Example Link]
+
+|===
+
+
+
+
+
+== Images
+
+// AsciiDoc commands are not stripped/processed when used within `alt=""`.
+:pic_1_src: /assets/images/tree-3822149_640.jpg
+:pic_1_title: Image by https://pixabay.com/de/users/jplenio-7645255/[jplenio] published on https://pixabay.com/de/[Pixabay].
+:pic_1_alt: The sun setting next to the trunk of an old tree.
+image::{pic_1_src}[link="{pic_1_src}", title="{pic_1_title}", alt="{pic_1_alt}"]
+
+
+
+
+
+== Lists
+
+=== Unordered
+
+* Item 1
+* Item 2
+** Item 2.1
+** Item 2.2
+** Item 2.3
+* Item 3
+
+=== Numbered
+
+. Numbered item 1
+. Numbered item 2
+.. Numbered item 2.1
+.. Numbered item 2.2
+.. Numbered item 2.3
+. Numbered item 3
+
+=== Checklist
+
+* [*] checked: `* [*]`
+* [x] checked: `* [x]` (lower case x!)
+- [*] checked: `- [*]`
+- [x] checked: `- [x]`
+- [ ] unchecked: `- [ ]`
+* [ ] unchecked: `* [ ]`
+** item without checkbox
+** [ ] unchecked item on level 2: `** [ ]`
+*** [x] checked item on level 3: `*** [x]`
+
+
+
+
+
+== Quotes
+
+Fully annotated quote:
+
+.After being searched for Lorem ipsum:
+[quote, Wikipedia, published on https://en.wikipedia.org/wiki/Lorem_ipsum]
+____
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+____
+
+Quotation lacking attribution and further information:
+____
+Veni, vidi, vici.
+____
+
+
+
+
+
+== Glossary
+
+Glossary entries can also contain lists, quotations, code-blocks, ...
+
+Lorem ipsum::
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum (with code block)::
+
+A common form of Lorem ipsum in a code block.
++
+[source, text]
+----
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+----
+
+Lorem ipsum (with list)::
+
+* Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+* Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+* Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+* Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+
+
+
+
+== Table of contents (TOC)
+
+As you can see at the top of this page, AsciiDoc can also generate a table of contents for you.
+
+You can enable this directly in the AsciiDoc page attributes.
+For this page I used:
+
+[source, asciidoc]
+----
+:toc: preamble
+:toclevels: 5
+----
+
+// == Level 1 corresponds to <h2>
+
+=== Level 2 corresponds to <h3>
+
+==== Level 3 corresponds to <h4>
+
+===== Level 4 corresponds to <h5>
+
+====== Level 5 corresponds to <h6>
+
+
+
+
+
+[[stem]]
+== Using Mathematical Formulas (STEM)
+
+In this blog, you can easily https://asciidoctor.org/docs/user-manual/#stem[use STEM]
+(**S**cience, **T**echnology, **E**ngineering and **M**ath) expressions in your pages and posts.
+To do this, simply add the `:stem:` attribute to the document header of your page or post
+(You can also https://github.com/asciidoctor/jekyll-asciidoc#enabling-stem-support[enable it for all posts] in your `_config.yml`):
+
+[source, asciidoc]
+----
+= Page Title
+:stem:
+----
+
+Two syntaxes for the formulas are are available:
+
+* http://asciimath.org/[AsciiMathML] (AsciiMath is the *default*)
+* https://en.wikibooks.org/wiki/LaTeX/Mathematics[TeX and LaTeX]
+
+
+
+
+
+=== Examples using AsciiMath
+
+*Inline Command*: (here `asciimath:[[[a,b\],[c,d\]\]((n),(k))].`)
+
+asciimath:[[[a,b\],[c,d\]\]((n),(k))].
+
+
+
+*Block command*:
+
+.The formula for the sum of cubes.
+[asciimath]
+++++
+sum_(i=1)^n i^3=((n(n+1))/2)^2
+++++
+
+.The AsciiDoc code using AsciiMath that was used to create the above formula for the sum of cubes.
+[source, asciidoc]
+----
+[asciimath]
+++++
+sum_(i=1)^n i^3=((n(n+1))/2)^2
+++++
+----
+
+
+
+
+
+=== Examples using LaTeX
+
+*Inline command* (here: `latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon]`):
+
+latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon]
+
+
+
+*Block command*:
+
+.Exponential Decay: The limit of the exponential function latexmath:[exp(-x)] as latexmath:[x] approaches infinity is zero.
+[latexmath]
+++++
+\lim\limits_{x \to \infty} \exp(-x) = 0
+++++
+
+.The AsciiDoc code for the exponential decay equation shown above, written in LaTeX syntax.
+[source, asciidoc]
+----
+[latexmath]
+++++
+\lim\limits_{x \to \infty} \exp(-x) = 0
+++++
+----
+
+
+
+
+
+[[diagram]]
+== Ascii Diagrams
+
+Text-based diagrams enable easy integration with version control systems, as they are saved in plain text.
+This format avoids binary files, making *changes visible in diffs*, so you can track updates precisely over time.
+Additionally, because they are text, *different themes and styles can be applied* without needing to redesign the diagram.
+Another benefit is that these diagrams can be generated automatically during the build process,
+eliminating the need for graphics editors or manual exports to specific formats.
+This makes them *ideal for automated workflows* and consistent documentation across projects.
+
+Asciidoctor Diagram supports a https://docs.asciidoctor.org/diagram-extension/latest/[wide range of text-based diagram types]
+making it a versatile choice for creating diagrams directly within documentation.
+
+
+
+=== Ditaa
+
+Ideal for converting ASCII art into diagrams, especially useful for quick sketches and block diagrams.
+
+.Example of a Ditaa diagram illustrating the flow of processing in Asciidoctor Diagram, where a text document is converted through Asciidoctor with Ditaa to produce a PNG output, showcasing the transformation from plain text to visually structured output.
+[ditaa,, svg]
+....
+                   +-------------+
+                   | Asciidoctor |-------+
+                   |   diagram   |       |
+                   +-------------+       | PNG out
+                       ^                 |
+                       | ditaa in        |
+                       |                 v
+ +--------+   +--------+----+    /---------------\
+ |        |---+ Asciidoctor +--->|               |
+ |  Text  |   +-------------+    |   Beautiful   |
+ |Document|   |   !magic!   |    |    Output     |
+ |     {d}|   |             |    |               |
+ +---+----+   +-------------+    \---------------/
+     :                                   ^
+     |          Lots of work             |
+     +-----------------------------------+
+....
+
+Check the AsciiDoc source of this page to see that the diagram is clearly recognizable even in the text.
+This is a unique feature of Ditaa.
+
+
+.Example of a table-style diagram in Ditaa, illustrating a 2x2 matrix layout with labeled cells and placeholder mathematical expressions, showcasing how different background colors can be applied to each cell.(Parameter: a=4, b=6);
+[ditaa,, svg]
+....
++------+---------+
+|cF00  |cFF0     |
+|  a²  |   a×b   |
+|      |         |
+|      |         |
++------+---------+
+|cFF0  |c0F0     |
+|      |         |
+| b×a  |   b²    |
+|      |         |
+|      |         |
+|      |         |
++------+---------+
+....
+
+
+
+=== PlantUML
+
+Great for creating UML diagrams like class diagrams, sequence diagrams, and activity diagrams.
+
+.Example of a class diagram in PlantUML, depicting a hierarchy where `DiagramBlock` and `BlockProcessor` classes are related, with `DiagramBlock` having subclasses `DitaaBlock` and `PlantUmlBlock`.
+[plantuml, , svg]
+....
+class BlockProcessor
+class DiagramBlock
+class DitaaBlock
+class PlantUmlBlock
+
+BlockProcessor <|-- DiagramBlock
+DiagramBlock <|-- DitaaBlock
+DiagramBlock <|-- PlantUmlBlock
+....
+
+.Example of a sequence diagram in PlantUML, showing an interaction where Bob greets Alice with 'hello,' and Alice responds with 'hi.'
+[plantuml,, format="svg", id="myDiagram", width="200px"]
+----
+Bob->Alice : hello
+Alice --> Bob : hi
+----
+
+
+
+=== Graphviz
+
+Useful for directed and undirected graphs, including flowcharts, state diagrams, and dependency graphs.
+
+.Example of a directed graph in Graphviz, illustrating nodes with connections, including a self-loop on node b and cyclical paths between nodes.
+[graphviz,,svg]
+....
+digraph g {
+    a -> b
+    b -> c
+    b -> d
+    b -> b
+    c -> d
+    d -> a
+}
+....
+
+
+
+=== Lilypond
+
+LilyPond is a music engraving program that enables users to create beautifully typeset sheet music through a text-based input system, focusing on producing high-quality, professional-looking scores suitable for publication.
+
+// The output format SVG is not supported by LilyPond.
+.Example of a melody in LilyPond notation, demonstrating a simple sequence of notes with pitches relative to the starting note c'.
+[lilypond]
+....
+\version "2.22.1"
+\relative c' { f d f a d f e d cis a cis e a g f e }
+....
+
+
+

data/pages_examples/showroom-markdown.md

@@ -0,0 +1,194 @@
+---
+layout: page
+menu_label: Markdown
+menu_position: 150
+permalink: /markdown-showroom/
+summary: "Explore the Markdown showroom: See Markdown's capabilities in this theme, including code, tables, lists, links, and quotes for clean, simple formatting."
+---
+# Markdown showroom
+
+Here are a few examples in Markdown.
+While Markdown has significantly fewer features compared to other markup languages like AsciiDoc,
+it still offers a simple and efficient way to write and format blog posts.
+It's especially useful for quickly creating clean, readable content without much overhead.
+Jekyll uses **Kramdown** as its Markdown processor.
+Therefore, you can also use Kramdown syntax.
+
+For more information, you can check out
+
+* [The official Markdown syntax guide](https://daringfireball.net/projects/markdown/syntax)
+* [Wikipedia article about Markdown](https://en.wikipedia.org/wiki/Markdown)
+* [Kramdown Syntax](https://kramdown.gettalong.org/syntax.html)
+* [Kramdown Quick Reference](https://kramdown.gettalong.org/quickref.html)
+* [Kramdown Cheat Sheet](https://aoterodelaroza.github.io/devnotes/kramdown-cheatsheet/)
+
+
+
+## Source code listings
+
+Python source code:
+
+```python
+# Python code
+def greet(name):
+    print(f"Hello, {name}!")
+
+greet('World')
+```
+
+Ruby code listings using Kramdown syntax:
+
+~~~
+puts "Hello! What's your name?"
+# gets user input and removes the newline
+name = gets.chomp
+puts "Hi, #{name}!"
+~~~
+{: .language-ruby}
+
+
+~~~ ruby
+# Define the function
+def square(number)
+  number * number
+end
+
+# Use the function
+puts "Enter a number to square:"
+num = gets.chomp.to_i
+result = square(num)
+
+puts "The square of #{num} is #{result}"
+~~~
+
+
+
+
+## Text formatting
+
+* Text with **strong** significance to me
+* *Emphasized* text
+* ***Combination*** of both
+* You can also format parts of a word:
+  * **C**reate, **R**ead, **U**pdate, and **D**elete (CRUD)
+  * Counter*clock*wise
+  * `string`s
+* ~~This is strikethrough text~~
+* `monospace text`
+
+
+
+
+
+## Links
+
+* <https://example.com>
+* [Link to example.com](https://example.com)
+* <mailto:test@example.com>
+* [send a test message to example.com](mailto:test@example.com)
+
+
+
+
+
+## Tables
+
+A simple table:
+
+| Name             | Age   | City        |
+|------------------|-------|-------------|
+| Max Mustermann   | 30    | Berlin      |
+| Maria Musterfrau | 28    | München     |
+| John Doe         | 45    | New York    |
+
+
+
+A table with alignment and some markdown features:
+
+| Left          | Center        | Right         |
+|:--------------|:-------------:|--------------:|
+| Text A        | Text B        | Text C        |
+| AAAAAAAAAAAAA | BBBBBBBBBBBBB | CCCCCCCCCCCCC |
+| **Formatting** | _is_ | ***supported*** |
+| Links | are also supported | [https://example.com](https://example.com) |
+
+<!--
+Cells in Markdown do not need to have the same width.
+However, rows must not be separated by blank lines.
+At the end of the table, there must be a blank line.
+-->
+
+
+
+
+
+## Lists
+
+### Unordered
+
+- Item 1
+- Item 2
+  - Item 2.1
+  - Item 2.2
+  - Item 2.3
+- Item 3
+
+### Numbered
+
+1. Numbered item 1
+2. Numbered item 2
+   7. Numbered item 2.1
+   6. Numbered item 2.2
+   9. Numbered item 2.3
+666. Numbered item 3
+
+### Checklist
+
+* [x] checked: `* [x]` (lower case x)
+* [X] checked: `* [X]` (or upper case X)
+- [x] checked: `- [x]`
+- [ ] unchecked: `- [ ]`
+* [ ] unchecked: `* [ ]`
+  * item without checkbox
+  * [ ] unchecked item on level 2: `* [ ]`
+    * [x] checked item on level 3: `* [x]`
+
+
+
+
+## Images
+
+![Alterntive Text for the image](/assets/images/tree-3822149_640.jpg "Title of the image.")
+
+
+
+
+
+## Quotes
+
+> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+> Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+> Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+>
+> Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+
+
+
+
+## Glossary
+
+Term 1
+: Definition for Term 1.
+
+Term 2
+: Definition for Term 2.
+Text can have multiple lines.
+They can also contain lists ...
+* item 1
+* item 2
+* item 3
+> ... and they can also contain quotes.
+
+
+: Another definition for Term 2.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.2
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-asciidoc
@@ -154,6 +154,9 @@ files:
 - lib/jekyll-theme-endless.rb
 - lib/jekyll-theme-endless/generate-tagpages.rb
 - lib/jekyll-theme-endless/version.rb
+- pages_examples/showroom-asciidoc-code.html
+- pages_examples/showroom-asciidoc.adoc
+- pages_examples/showroom-markdown.md
 homepage: https://gitlab.com/jekyll-theme-endless/jekyll-theme-endless.gitlab.io
 licenses:
 - MIT