jekyll-oedipus-theme 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3e6768b444b549237c61dd99532bb1f0133a47140ee4ed6a85d163f12a28e79
-  data.tar.gz: ce47ca3de6e0a676a71d6185a91a4c7da4fb6e7d7ea9d54d35b1a13f7d5cf5b1
+  metadata.gz: 247f35fd43d5ad6558f3dadfaff25f8c9810cfe6ea3756d497af92d387b20add
+  data.tar.gz: 74731ab0f28e29cf73117da85608eb42845410fa3bafbfa8746cbd2806190066
 SHA512:
-  metadata.gz: 2e3ff13c887718b872d218d452a7becc7337ade2e8a85ca71abb7f43afadf44405ba5ade01b5b4a99acf438caa88d033b48f4b0bad61ebe2483025c19b88931f
-  data.tar.gz: '0159cb53f76c71f68e47802cb707b320796664f7aa5dd1fce10f211b3901d1f5f66b6ecd6a73046092e96c95d8d369623d9720748fce7adb9f4e4fa589f3e736'
+  metadata.gz: 8947a9c0a5fefdb3d636d8b990803384480dd12758da5a52836e5aef94c34ea67f943bf51a3b7f3e2dc09e13db183cc6c7cdb72a02f6dfa5889222c5704c4590
+  data.tar.gz: 0e8400076d1f4ff7f32c741f6e729a55fb47ddabd82470fc62eb21ebd3024c130853a4452a0a86ffa3b990f44311eb0d7a660d6f9f9bb2428929f2582c5a4bfe

data/README.md

@@ -4,6 +4,10 @@ Build a motherfucking website with Jekyll (patricide optional).
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-oedipus-theme.svg)](https://badge.fury.io/rb/jekyll-oedipus-theme)
 
+## Screenshot
+
+![Oedipus rendered on a Thinkpad T60 in Firefox ESR](https://github.com/matthewgraybosch/jekyll-oedipus-theme/blob/main/screenshot.png?raw=true)
+
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
@@ -30,6 +34,10 @@ Or install it yourself as:
 
 TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
 
+### Layouts
+
+* **base.html**: a wrapper layout that sets language and encoding, sets up a skip navigation link, and links to favicons, stylesheets, and feeds.
+
 ## Contributing
 
 I built this theme for my own use. If you find this theme useful, you are welcome to it. If you wish to customize it, by all means fork it. However, I will not accept pull requests unless they suit my tastes. Any support I provide is at my own discretion.

data/_config.yml

@@ -9,12 +9,6 @@ github_username: matthewgraybosch
 lang: en
 encoding: utf-8
 locale: en_US
-rights: most rights reserved
-license-text-name: "CC BY-NC-SA 4.0"
-license-text-url: "https://creativecommons.org/licenses/by-nc-sa/4.0/"
-license-code-name: "GNU GPL-3.0"
-license-code-url: "https://opensource.org/licenses/GPL-3.0/"
-madeWith: "♥ in Pennsylvania"
 
 # Build settings
 theme: jekyll-oedipus-theme
@@ -27,4 +21,35 @@ plugins:
 sass:
   style: expanded
 
-permalink: /blog/:year/:month/:day/:title/
+permalink: /blog/:year/:month/:day/:title/
+
+oedipus:
+  rights: most rights reserved
+  license:
+    text:
+      name: "CC BY-NC-SA 4.0"
+      url: "https://creativecommons.org/licenses/by-nc-sa/4.0/"
+    code:
+      name: "GNU GPL-3.0"
+      url: "https://opensource.org/licenses/GPL-3.0/"
+  madeWith: "♥ in Pennsylvania"
+  style:
+    bg-color: "#FFFFFF"
+    fg-color: "#000000"
+    link-color: "#0000B5"
+    link-hover-color: "#3A539B"
+    link-active-color: "#20603C"
+    link-visited-color: "#550000"
+    border-thickness: 2px
+    hr-border-thickness: 1px
+    html-font-size: medium
+    body-margin: 1rem
+    content-font-size: 1rem
+    content-line-height: 1.62
+    content-font-family: sans-serif
+    preformatted-font-size: 1rem
+    preformatted-font-family: monospace
+    content-width: 40rem
+    content-centered: false
+    compact-header: true
+    home-header-icon: true

data/_includes/footer.html

@@ -1,8 +1,8 @@
 <footer>
   <p>
-    &copy; {{ site.time | date: "%Y" }} {{ site.author }}, {{ site.rights }}<br />
+    &copy; {{ site.time | date: "%Y" }} {{ site.author }}, {{ site.oedipus.rights }}<br />
     {% include license.html %}
-    made with {{ site.madeWith }}
+    made with {{ site.oedipus.madeWith }}
   </p>
   {% include navbar.html id="footer-nav" label="bottom navigation" source=site.data.footer-nav %}
 </footer>

data/_includes/header.html

@@ -1,5 +1,4 @@
 <header>
-  <h1>{{ site.title }}</h1>
-  <p>{{ site.description }}</p>
+  {% include masthead.html %}
   {% include navbar.html id="header-nav" label="main navigation" source=site.data.header-nav %}
 </header>

data/_includes/home-footer.html

@@ -1,7 +1,7 @@
 <footer>
   <p>
-    &copy; {{ site.time | date: "%Y" }} {{ site.author }}, {{ site.rights }}<br />
+    &copy; {{ site.time | date: "%Y" }} {{ site.author }}, {{ site.oedipus.rights }}<br />
     {% include license.html %}
-    made with {{ site.madeWith }}
+    made with {{ site.oedipus.madeWith }}
   </p>
 </footer>

data/_includes/home-header.html

@@ -1,8 +1,9 @@
 <header>
+  {% if site.oedipus.style.home-header-icon %}
   <img src="/assets/favicon.svg"
        height="128"
        width="128"
        alt="favicon for the Oedipus theme for Jekyll website">
-  <h1>{{ site.title }}</h1>
-  <p>{{ site.description }}</p>
+  {% endif %}
+  {% include masthead.html %}
 </header>

data/_includes/license.html

@@ -1,3 +1,12 @@
-text: <a href="{{ site.license-text-url }}">{{ site.license-text-name }}</a>
-/ code: <a href="{{ site.license-code-url }}">{{ site.license-code-name }}</a>
+{% if site.oedipus.license.text %}
+text: <a href="{{ site.oedipus.license.text.url }}">{{ site.oedipus.license.text.name }}</a>
+{% endif %}
+{% if site.oedipus.license.text and site.oedipus.license.code %}
+/
+{% endif %}
+{% if site.oedipus.license.code %}
+code: <a href="{{ site.oedipus.license.code.url }}">{{ site.oedipus.license.code.name }}</a>
+{% endif %}
+{% if site.oedipus.license.text or site.oedipus.license.code %}
 <br />
+{% endif %}

data/_includes/masthead.html

@@ -0,0 +1,6 @@
+{% if site.oedipus.style.compact-header %}
+<h1>{{ site.title }}<em>{{ site.description }}</em></h1>
+{% else %}
+<h1>{{ site.title }}</h1>
+<p>{{ site.description }}</p>
+{% endif %}

data/_includes/navbar.html

@@ -1,3 +1,4 @@
+{% if include.source %}
 <nav id="{{ include.id }}" aria-label=" {{include.label }}">
   <p>
     {% for item in include.source %}
@@ -5,3 +6,4 @@
     {% endfor %}
   </p>
 </nav>
+{% endif %}

data/_includes/navlist.html

@@ -1,3 +1,4 @@
+{% if include.source %}
 <nav id="{{ include.id }}" aria-label=" {{include.label }}">
   <ul>
     {% for item in include.source %}
@@ -7,3 +8,4 @@
     {% endfor %}
   </ul>
 </nav>
+{% endif %}

data/_sass/dark.scss

@@ -27,6 +27,10 @@
                 border-left: $border-thickness solid invert($fg-color);
             }
 
+            figure {
+                border: $border-thickness solid invert($fg-color);
+            }
+
             hr {
                 border: $hr-border-thickness solid invert($fg-color);
             }

data/_sass/main.scss

@@ -1,13 +1,15 @@
 html {
-    font-size: medium;
+    font-size: $html-font-size;
     background-color: $bg-color;
     color: $fg-color;
 
     body {
         background-color: $bg-color;
         color: $fg-color;
-        margin: 1rem;
-        font: 1rem/1.62 sans-serif;
+        margin: $body-margin;
+        font-size: $content-font-size;
+        font-family: $content-font-family;
+        line-height: $content-line-height;
 
         a {
             color: $link-color;
@@ -31,10 +33,16 @@ html {
         }
         
         header, footer, nav {
-            text-align: center;
+            text-align: content-alignment;
 
             h1 {
+                font-size: 1rem;
                 margin-bottom: 1rem;
+
+                em {
+                    margin-left: 1rem;
+                    font-weight: normal;
+                }
             }
         }
 
@@ -54,14 +62,17 @@ html {
             margin-top: 1.5rem;
             p {
                 a {
-                    margin-left: .5rem;
-                    margin-right: .5rem;
+                    margin-right: 1rem;
                     border: $border-thickness solid $link-color;
                     border-radius: .5rem;
                     padding: .5rem;
                     text-decoration: none;
                 }
 
+                a:last-child {
+                    margin-right: 0;
+                }
+
                 a:hover {
                     border: $border-thickness solid $link-hover-color;
                 }
@@ -77,9 +88,9 @@ html {
         }
         
         main {
-            margin: 2rem auto;
+            margin: $content-margin;
 		        max-width: $content-width;
-		        padding: 0 .62rem;
+		        padding: $content-padding;
 
             article {
                 margin-left: 2rem;
@@ -91,9 +102,9 @@ html {
         }
 
         article {
-            margin: 2rem auto;
+            margin: $content-margin;
 		        max-width: $content-width;
-		        padding: 0 .62rem;
+		        padding: $content-padding;
 
             header, footer {
                 text-align: left;
@@ -101,7 +112,7 @@ html {
             }
 
             section {
-                    margin: 2rem auto;
+                margin: 2rem auto;
             }
 
             header {
@@ -114,9 +125,27 @@ html {
                 border-top: $hr-border-thickness dashed $fg-color;
             }
         }
+
+        main, article {
+            h1 {
+                font-size: 1.6rem;
+            }
+            
+            h2 {
+                font-size: 1.4rem;
+            }
+
+            h3 {
+                font-size: 1.2rem;
+            }
+
+            h4, h5, h6 {
+                font-size: 1.1rem;
+            }
+        }
         
         blockquote {
-            font-size: 1.2rem;
+            font-size: $blockquote-font-size;
             margin: 2rem 4rem;
             padding: 0 1rem;
             border-left: $border-thickness solid $fg-color;
@@ -127,6 +156,22 @@ html {
             }
         }
 
+        figure {
+            font-size: $blockquote-font-size;
+            margin: 2rem 4rem;
+            padding: 1rem;
+            border: $border-thickness solid $fg-color;
+
+            img {
+                width: 100%;
+            }
+            
+            figcaption {
+                font-style: normal;
+                font-weight: bold;
+            }
+        }
+
         dl {
             dt {
                 font-size: 1.1rem;
@@ -152,5 +197,10 @@ html {
                 text-align: left;
             }
         }
+
+        pre, code {
+            font-size: $preformatted-font-size;
+            font-family: $preformatted-font-family;
+        }
     }
 }

data/_sass/variables.scss

@@ -6,4 +6,16 @@ $link-active-color: #20603C;
 $link-visited-color: #550000;
 $border-thickness: 2px;
 $hr-border-thickness: 1px;
+$html-font-size: medium;
+$body-margin: 2rem;
+$content-font-size: 1rem;
+$content-line-height: 1.62;
+$content-font-family: sans-serif;
+$preformatted-font-size: 1rem;
+$preformatted-font-family: monospace;
 $content-width: 40rem;
+$content-alignment: center;
+$content-margin: 2rem auto;
+$content-padding: 0 .62rem;
+$blockquote-font-size: 1.1rem;
+$figure-font-size: 1.1rem;

data/assets/print.scss

@@ -2,4 +2,12 @@
 ---
 
 @import "variables";
+
+// now that our variables are defined, let's override them from the config.
+
+{% if site.oedipus.style.content-width %}
+$content-width: {{ site.oedipus.style.content-width }};
+{% endif %}
+
+
 @import "paper";

data/assets/style.scss

@@ -2,6 +2,83 @@
 ---
 
 @import "variables";
+
+// now that our variables are defined, let's override them from the config.
+
+{% if site.oedipus.style.bg-color %}
+$bg-color: {{ site.oedipus.style.bg-color }};
+{% endif %}
+
+{% if site.oedipus.style.fg-color %}
+$fg-color: {{ site.oedipus.style.fg-color }};
+{% endif %}
+
+{% if site.oedipus.style.link-color %}
+$link-color: {{ site.oedipus.style.link-color }};
+{% endif %}
+
+{% if site.oedipus.style.link-hover-color %}
+$link-hover-color: {{ site.oedipus.style.link-hover-color }};
+{% endif %}
+
+{% if site.oedipus.style.link-active-color %}
+$link-active-color: {{ site.oedipus.style.link-active-color }};
+{% endif %}
+
+{% if site.oedipus.style.link-visited-color %}
+$link-visited-color: {{ site.oedipus.style.link-visited-color }};
+{% endif %}
+
+{% if site.oedipus.style.border-thickness %}
+$border-thickness: {{ site.oedipus.style.border-thickness }};
+{% endif %}
+
+{% if site.oedipus.style.hr-border-thickness %}
+$hr-border-thickness: {{ site.oedipus.style.hr-border-thickness }};
+{% endif %}
+
+{% if site.oedipus.style.body-margin %}
+$body-margin: {{ site.oedipus.style.body-margin }};
+{% endif %}
+
+{% if site.oedipus.style.html-font-size %}
+$html-font-size: {{ site.oedipus.style.html-font-size }};
+{% endif %}
+
+{% if site.oedipus.style.content-font-size %}
+$content-font-size: {{ site.oedipus.style.content-font-size }};
+{% endif %}
+
+{% if site.oedipus.style.content-font-family %}
+$content-font-family: {{ site.oedipus.style.content-font-family }};
+{% endif %}
+
+{% if site.oedipus.style.content-line-height %}
+$content-line-height: {{ site.oedipus.style.content-line-height }};
+{% endif %}
+
+{% if site.oedipus.style.preformatted-font-size %}
+$preformatted-font-size: {{ site.oedipus.style.preformatted-font-size }};
+{% endif %}
+
+{% if site.oedipus.style.preformatted-font-family %}
+$preformatted-font-family: {{ site.oedipus.style.preformatted-font-family }};
+{% endif %}
+
+{% if site.oedipus.style.content-width %}
+$content-width: {{ site.oedipus.style.content-width }};
+{% endif %}
+
+{% if site.oedipus.style.content-centered %}
+$content-alignment: center;
+$content-margin: 2rem auto;
+$content-padding: 0 .62rem;
+{% else %}
+$content-alignment: left;
+$content-margin: 0;
+$content-padding: auto;
+{% endif %}
+
 @import "main";
 @import "skip";
 @import "dark";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-oedipus-theme
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matthew Graybosch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -107,6 +107,7 @@ files:
 - _includes/home-footer.html
 - _includes/home-header.html
 - _includes/license.html
+- _includes/masthead.html
 - _includes/navbar.html
 - _includes/navlist.html
 - _includes/posts-list.html