jekyll-theme-endless 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 895ee6675bf014e980f0cedef57fdc044087039a7448798aa74734539b99421d
-  data.tar.gz: c448fa60ced14cd1cc70b30d8152abc05aa3c970e9d38901bb6b86b1b8034549
+  metadata.gz: 9c92dfedce5cc6880471ae7994859fd5b388634e4067407abd00daa28faf4ddb
+  data.tar.gz: e8a8c5fe9a45b37e80442f091f0054f7600cd942e6c7886bdd69eede6ed46875
 SHA512:
-  metadata.gz: 73eb66c8bf2493deff4f3003ec9c6b336e98431d141d28300ad7fce87d41607e6fa090cd43e553147d4cf5266ed2320b55927f4e1424d0026004938841794e0a
-  data.tar.gz: cc5f8ebc667554dde143e957c3d294700ca7655ddb2203ed1e9bd7402e5913ffcb7f3aa11706ca4724d0d3af060bb267275a3beae8eec1f844e206e09e5f2fdf
+  metadata.gz: 1712475fc0dcef617efb69fc282d8cf38e791e24355fbbb17b75bd7cc592d6806ec44bc6a8d335b8ad88ca7aa9a79edd113df6b297eef96ee68b7d68a5843404
+  data.tar.gz: af48af0c6da7245c89385b9b34b83952ea12811f56f3fd016feca673b7f3083b0837da59e3a106bb135f9e3de9e89d931436a8c3a214034321354b01f968b4ed

data/README.adoc

@@ -1,5 +1,7 @@
 = jekyll-theme-endless
 
+
+
 == Installation
 
 Add this line to your Jekyll site's `Gemfile`:
@@ -24,6 +26,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 +52,79 @@ 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'
+----
+
+
 `_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/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,6 +132,15 @@ 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.
@@ -64,12 +153,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:
@@ -87,6 +191,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

@@ -29,6 +29,17 @@ url: "" # the base hostname & protocol for your site, e.g. http://example.com
 #twitter_username: jekyllrb
 #github_username:  jekyll
 
+
+
+# Theme specific settings
+# Language. Is overriden by value of page.lang.
+lang: en
+# Brand is not escaped in the layout.
+# Thus, HTML-commands can be used.
+brand: '"<i>endless</i>"-Theme'
+
+
+
 # Build settings
 #theme: minima
 #plugins:
@@ -57,3 +68,4 @@ exclude:
 #   - vendor/gems/
 #   - vendor/ruby/
 
+

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

@@ -3,6 +3,41 @@
 layout: html
 ---
 
-{% include function_list-pages.html %}
+<!-- Navigation -->
+<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+	<div class="container">
+
+		<!-- Brand Icon -->
+		<a class="navbar-brand" href="{{ "/" | relative_url}}">{{ site.brand }}</a>
+
+		<!-- 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 content -->
+<main class="container" aria-label="Content">
+
+	{{ content }}
+
+</main>
+
+
+
+<!-- Footer -->
+
 
-{{ content }}

data/_layouts/html.html

@@ -3,17 +3,27 @@
 # 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>
+
+		<!-- 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">
 		<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.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 }}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-endless
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sven Boekhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,7 +44,7 @@ files:
 - _sass/background.scss
 - _sass/user.scss
 - assets/css/main.scss
-homepage: https://jekyll-theme-endless.gitlab.io
+homepage: https://gitlab.com/jekyll-theme-endless/jekyll-theme-endless.gitlab.io
 licenses:
 - MIT
 metadata: {}
@@ -66,5 +66,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: []