jekyll-theme-nix 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d825a61dffc85243635131573be5e34127eda05c9851c352d62e44fbf8d3db0
+  data.tar.gz: a72c48b318b8910dcd8116b1a3b3d63621feab833cd628e83cbf1641b552705a
+SHA512:
+  metadata.gz: 2099ca9400e23da9a4a2cd49b20a58d8f1701565ac331564297ac12e5566b72e34af4b1bce3c263509aeece4f5cb3a246da06b4bd1484ca2b8e5c60dd933ff9d
+  data.tar.gz: 9b7694206e58366a5c3d53a0bdfc7054d13be115432e3f9fbe50e48f50baf5bef8a4206c43511dc566b13efa66e4bb99d7a5b0a9ea2c54049571399e745a8aac

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Michael Nordmeyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Jekyll Theme Nix
+
+A barebones theme for [Jekyll](https://github.com/jekyll/jekyll), which doesn't need any dependencies except `jekyll-redirect-from`, if you want to redirect pages.
+
+Its purpose is to be a minimalistic, single-author theme. Because there is no menu, pages can be manually linked in the body of `index.md`.
+
+It also changes as little as possible from the default browser settings to improve legibility.
+
+## Limited Features
+
+- Dark mode, because we want to be respectful
+- Posts
+- Pages, including custom error pages
+- No visible authors, categories, or tags
+- No header or footer
+- No pagination for the home page
+- A feed.xml containing an Atom feed, but no JSON or outdated RSS feeds
+- A sitemap.xml, because search engines should index us
+- No semantic info like Open Graph, Twitter cards, or JSON-LD, but inline Microdata
+
+## Minutiae
+
+### Default Colors
+
+The default browser link colors don't look great, if they're inverted in dark mode, just like white is inverted to black for the background:
+
+- Link: <span style="background-color: white; color: #0000ee">&nbsp;#0000ee&nbsp;</span> => <span style="background-color: black; color: #ffff11">&nbsp;#ffff11&nbsp;</span>
+- Link visited: <span style="background-color: white; color: #551a8b">&nbsp;#551a8b&nbsp;</span> => <span style="background-color: black; color: #aae574">&nbsp;#aae574&nbsp;</span>
+
+Therefore, they're set to somewhat lighter versions of the default colors:
+
+- Link: <span style="background-color: white; color: #0000ee">&nbsp;#0000ee&nbsp;</span> => <span style="background-color: black; color: lightskyblue">&nbsp;lightskyblue&nbsp;</span>
+- Link visited: <span style="background-color: white; color: #551a8b">&nbsp;#551a8b&nbsp;</span> => <span style="background-color: black; color: plum">&nbsp;plum&nbsp;</span>
+
+### Favicon
+
+The favicon is currently `icon.webp` for the light mode, and there's also a dark variant `icon-dark.webp`.
+
+### Nix?
+
+<q>Nix</q> is the grammatically incorrect form of the German <q>nichts</q>, which in English means <q>nothing</q>. It's colloquially used to stress the nothingness.
+
+Or, if you will, it could be UNIX without the <q>U</q>, because of the theme's somewhat archaic properties.
+
+## Installation
+
+Installation from Gem is recommended, but using a remote theme is also possible, even though it will increase build time a little, depending on your internet connection.
+
+### Installation from Gem
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-nix"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-nix
+```
+
+Make sure that this is the only `theme:` in `_config.yml`.
+
+### Installation as Remote Theme
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-remote-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+remote_theme: michaelnordmeyer/jekyll-theme-nix
+```
+
+Make sure that this is the only `remote_theme:` in `_config.yml`, and that there are no other `theme:`.
+
+Finally, add `jekyll-remote-theme` to your plugin section in `_config.yml` as well.

data/_config.yml

@@ -0,0 +1,20 @@
+## Remove URL for Github Pages
+url: https://jekyll-theme-nix.michaelnordmeyer.com
+title: Jekyll Theme Nix
+author:
+  name: Michael Nordmeyer
+  uri: https://jekyll-theme-nix.michaelnordmeyer.com
+description: "A barebones theme for Jekyll"
+
+timezone: Europe/Berlin
+ignore_theme_config: true
+exclude: [CNAME, Gemfile, Gemfile.lock, LICENSE, README.md]
+date_format: "%Y-%m-%d"
+
+plugins:
+  - jekyll-include-cache
+  # - jekyll-redirect-from
+
+## Jekyll build settings
+kramdown:
+  show_warnings: true

data/_layouts/default.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/webp" href="{{ '/icon.webp' | relative_url }}">
+  <style>
+    html {
+      max-width: 43rem;
+      margin: 0 auto;
+      padding: 1em;
+      font: 1rem / 1.5 sans-serif;
+    }
+    body { margin: 0; }
+    img, table { margin: 0 auto; }
+    table { border-collapse: collapse; }
+    th, td { padding: 0.25em; border: 1px solid lightgrey; }
+    img { display: block; max-width: 100%; height: auto; }
+    figure { margin: 0; text-align: center; font-size: small; }
+    blockquote { margin: 1em 1.5em 1em 0.5em; padding-left: 1em; border-left: 1px solid lightgrey; }
+    code { font-size: 1.125em; }
+    sub, sup { line-height: 0; }
+    hr { border: 0; border-top: 1px solid; }
+    body > header > h1 { margin-bottom: 2rem; text-align: center; }
+    body > main > ul { padding: 0; }
+    body > main > ul > li { margin: 0.5em 0; list-style-type: none; line-height: 1.25em; }
+    body > main > ul > li time { font-size: small; }
+    body > header > a { display: block; margin-block-start: 0.67em; margin-block-end: 1em;text-align: center; font-size: 2rem; font-weight: bold; }
+    article > header { margin-bottom: 2rem; }
+    article > header > h1 { margin-bottom: 0; }
+    article h1 { margin-bottom: 1rem; font-size: 2rem; }
+    header > time { display: block; color: grey; }
+    @media (prefers-color-scheme: dark) {
+      html { background-color: black; color: white; }
+      a { color: lightskyblue; }
+      a:visited { color: plum; }
+      header > time { color: darkgrey; }
+      th, td { border-color: grey; }
+    }
+    .footnotes { margin: 0; font-size: small; }
+    .footnotes ol { padding-inline-start: 30px; }
+  </style>
+  <meta name="theme-color" content="#white">
+  <title>{%- if page.title -%}{{ page.title | smartify }} • {{ site.title | smartify }}{%- else -%}{{ site.title | smartify }} • {{ site.description | smartify }}{%- endif -%}</title>
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | smartify }}{% else %}{{ site.description | smartify }}{% endif %}">
+  <meta name="author" content="{{ site.author.name }}">
+  <link rel="canonical" href="{{ page.url | absolute_url }}">
+  <link type="application/atom+xml" rel="alternate" href="{{ '/feed.xml' | relative_url }}" title="{{ site.title | smartify }}">
+</head>
+<body>
+  {{ content }}
+</body>
+</html>

data/_layouts/error.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/webp" href="{{ '/icon.webp' | relative_url }}">
+  <style>
+    html {
+      max-width: 43rem;
+      margin: 0 auto;
+      padding: 1em;
+      font: 1rem / 1.5 sans-serif;
+    }
+    body { margin: 0; }
+    body > header > a { display: block; margin-block-start: 0.67em; margin-block-end: 1em;text-align: center; font-size: 2rem; font-weight: bold; }
+    article > header { margin-bottom: 2rem; }
+    article > header > h1 { margin-bottom: 0; }
+    article h1 { margin-bottom: 1rem; font-size: 2rem; }
+    @media (prefers-color-scheme: dark) {
+      html { background-color: black; color: white; }
+      a { color: lightskyblue; }
+      a:visited { color: plum; }
+    }
+  </style>
+  <meta name="theme-color" content="#white">
+  <title>{%- if page.title -%}{{ page.title | smartify }}{%- else -%}{{ site.title | smartify }}{%- endif -%}</title>
+  <meta name="description" content="Error page">
+  <meta name="robots" content="noindex,follow">
+</head>
+<body>
+  <header>
+    <a rel="author" href="{{ '/' | relative_url }}">{{ site.title }}</a>
+  </header>
+  <main aria-label="Content">
+    <article itemscope itemtype="https://schema.org/WebPage">
+      <header>
+        <h1 itemprop="headline">{{ page.title | smartify }}</h1>
+      </header>
+      <div itemprop="mainContentOfPage" itemscope itemtype="https://schema.org/WebPageElement">
+        {{ content }}
+      </div>
+    </article>
+  </main>
+</body>
+</html>

data/_layouts/home.html

@@ -0,0 +1,24 @@
+---
+layout: default
+---
+<header>
+    <h1><a rel="author" href="{{ '/' | relative_url }}">{{ site.title }}</a></h1>
+  </header>
+  <main aria-label="Content" itemscope itemtype="https://schema.org/Blog">
+    {{ content }}
+
+    {%- if site.posts.size > 0 -%}
+      {%- if page.list_title %}
+    <h2>{{ page.list_title | smartify }}</h2>
+      {%- endif -%}
+      {%- assign date_format = site.date_format | default: "%b %-d, %Y" %}
+    <ul>
+      {%- for post in site.posts %}
+      <li itemscope itemtype="https://schema.org/BlogPosting">
+        <time itemprop="datePublished" datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date: date_format }}</time>
+        <a href="{{ post.url | relative_url }}" itemprop="headline">{{ post.title | smartify }}</a>
+      </li>
+      {%- endfor %}
+    </ul>
+    {%- endif %}
+  </main>

data/_layouts/page.html

@@ -0,0 +1,16 @@
+---
+layout: default
+---
+<header>
+    <a rel="author" href="{{ '/' | relative_url }}">{{ site.title }}</a>
+  </header>
+  <main aria-label="Content">
+    <article itemscope itemtype="https://schema.org/WebPage">
+      <header>
+        <h1 itemprop="headline">{{ page.title | smartify }}</h1>
+      </header>
+      <div itemprop="mainContentOfPage" itemscope itemtype="https://schema.org/WebPageElement">
+        {{ content }}
+      </div>
+    </article>
+  </main>

data/_layouts/post.html

@@ -0,0 +1,18 @@
+---
+layout: default
+---
+<header>
+    <a rel="author" href="{{ '/' | relative_url }}">{{ site.title }}</a>
+  </header>
+  <main aria-label="Content">
+    <article itemscope itemtype="https://schema.org/BlogPosting">
+      <header>
+        <h1 itemprop="headline">{{ page.title | smartify }}</h1>
+        {%- assign date_format = site.date_format | default: "%b %-d, %Y" %}
+        <time itemprop="datePublished" datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: date_format }}</time>
+      </header>
+      <div itemprop="articleBody">
+        {{ content }}
+      </div>
+    </article>
+  </main>

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-nix
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Nordmeyer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description:
+email:
+- michaelnordmeyer@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- _config.yml
+- _layouts/default.html
+- _layouts/error.html
+- _layouts/home.html
+- _layouts/page.html
+- _layouts/post.html
+homepage: https://github.com/michaelnordmeyer/jekyll-theme-nix
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: A very minimalistic, single-author Jekyll theme with almost default browser
+  styling, and a dark mode.
+test_files: []