jekyll-oedipus-theme 0.5.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247f35fd43d5ad6558f3dadfaff25f8c9810cfe6ea3756d497af92d387b20add
-  data.tar.gz: 74731ab0f28e29cf73117da85608eb42845410fa3bafbfa8746cbd2806190066
+  metadata.gz: 2a135d74c506d1aff540cda4077592df9d7edb74af2ceb00a1ce6ad413f14f38
+  data.tar.gz: 15bb7a54385486481d12ff828416298bf652f7f548aab28885bcada436de31eb
 SHA512:
-  metadata.gz: 8947a9c0a5fefdb3d636d8b990803384480dd12758da5a52836e5aef94c34ea67f943bf51a3b7f3e2dc09e13db183cc6c7cdb72a02f6dfa5889222c5704c4590
-  data.tar.gz: 0e8400076d1f4ff7f32c741f6e729a55fb47ddabd82470fc62eb21ebd3024c130853a4452a0a86ffa3b990f44311eb0d7a660d6f9f9bb2428929f2582c5a4bfe
+  metadata.gz: de13fb49286552a0d74a30b6bd1235e3bed0579c90c90f9b153505a0955f8b2780933dac8f6859869187c25f9542fd25fb8ed85139b009b79de9b92a27652dd1
+  data.tar.gz: 61ab7042cae4cb0218dc963fe3d40a296322292c884027e361e5b544c34fa4acc74af961910210b07610f70fc4762243d360b6b03b02c7ca1a0fdfb74bd5bd04

data/README.md

@@ -6,7 +6,7 @@ Build a motherfucking website with Jekyll (patricide optional).
 
 ## Screenshot
 
-![Oedipus rendered on a Thinkpad T60 in Firefox ESR](https://github.com/matthewgraybosch/jekyll-oedipus-theme/blob/main/screenshot.png?raw=true)
+![Oedipus rendered on a Thinkpad T60 in Firefox ESR](https://raw.githubusercontent.com/matthewgraybosch/jekyll-oedipus-theme/main/screenshot.png)
 
 ## Installation
 
@@ -32,19 +32,114 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+**Oedipus** can be customized to a great extent in [`_config.yml`](https://github.com/matthewgraybosch/jekyll-oedipus-theme/blob/main/_config.yml), but if you want to [override any part of the theme](https://jekyllrb.com/docs/themes/), you'll want a list of what's included.
+
+### _config.yml
+
+All options for this theme are contained under the "site.oedipus" root. Therefore, the "rights" option listed below is actually "site.oedipus.rights".
+
+- **rights**: a string that goes into the copyright line in the page footer
+- **license.text.name**: a string identifying the license for your site's text
+- **license.text.url**: the URL of the license for your site's text
+- **license.code.name**: a string identifying the license for your site's code
+- **license.code.url**: the URL of the license for your site's code
+- **made-with**: a string indicating how the site was made.
+
+The stylesheet for Oedipus is also configurable, and all style options are contained under "site.oedipus.style". The default colors were selected from [Color Safe](http://colorsafe.co/) for accessibility. The dark theme takes each of these variables and applies the [Sass `invert()`](https://sass-lang.com/documentation/modules/color) function to them.
+
+- **bg-color**: set background color
+- **fg-color**: set text color
+- **link-color**: set default link color
+- **link-hover-color**: change a link to this color on mouseover
+- **link-active-color**: change a link to this color when clicked
+- **link-visited-color**: change visited links to this color
+- **border-thickness**: set the thickness for borders
+- **hr-border-thickness**: set thickness for <hr> elements. Set this to half your intended value.
+- **html-font-size**: allows use of [rem units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units) for consistent scaling. Defaults to "medium".
+- **body-margin**: control distance between text and screen edges
+- **content-font-size**: Sets font-size for most text.
+- **content-font-family**: Sets the font-family for most text. Use this to define a custom font stack.
+- **content-line-height**: Sets separation between lines of text.
+- **preformatted-font-size**: Sets font-size for preformatted-text and code.
+- **preformatted-font-family**: Sets the font-family for most preformatted-text and code. Use this to define a custom font stack.
+- **content-width**: Sets the content width in <main> and <article>
+- **content-centered**: When true, Oedipus will horizontally center content.
+- **compact-header**: When true, Oedipus will place the site title and description inside the masthead's <h1>.
+- **home-header-icon** When true, any page assigned the "home" layout will show `/assets/favicon.svg` as part of the masthead.
 
 ### Layouts
 
-* **base.html**: a wrapper layout that sets language and encoding, sets up a skip navigation link, and links to favicons, stylesheets, and feeds.
+* **base.html**: a wrapper layout that sets language and encoding, sets up a skip navigation link, and links to favicons, stylesheets, and feeds. Also provides a target for `jekyll-seo-tag`.
+* **default.html**: this wraps around **page.html** and **post.html** to provide headers, footers, and navigation.
+* **home.html**: for your site's home page. It provides custom headers and footers in case you don't want nav bars on your landing page.
+* **page.html**: for pages and other non-blog material. It wraps content inside a <main> element.
+* **post.html**: for blog posts. It wraps content inside an <article> element and provides a footer for subscription and contact info.
+
+### Includes
+
+* **masthead.html**: displays the site's title and description.
+* **skip.html**: implements a [skip navigation](https://webaim.org/techniques/skipnav/) link.
+* **navbar.html**: implements a navigation bar. It accepts "id", "label", and "source" arguments. Source is a data source accessible via `site.data`.
+* **navlist.html**: implements an unordered navigation list and takes the same arguments as navbar.html.
+* **header.html**: the default header for most pages and posts. Includes a navigation bar.
+* **article-header.html**: a sub-header for posts that contains the post title and summary
+* **home-header.html**: a header for the home page, sans nav bar.
+* **footer.html**: the default footer for most pages and posts. Includes a navigation bar.
+* **article-footer.html**: a sub-footer for posts that contains feed and contact links in lieu of a comments section
+* **home-footer.html**: a footer for the home page, sans nav bar.
+* **posts-list.html**: lists all posts as a set of <article> blocks.
+* **recent-posts-list.html**: lists the *n* most recent posts, where the "limit" argument = *n*.
+* **posts-table.html**: lists all posts in a table
+* **recent-posts-table.html**: lists the *n* most recent posts in a table, where the "limit" argument = *n*.
+* **copyright.html**: shows copyright info. used in footers.
+* **license.html**: shows license links for text and code. used in footers.
+* **made-with.html**: can be used to credit tools or represent a location. used in footers.
+
+### Sass
+
+Oedipus' stylesheets are built with Sass, which is included with Jekyll.
+
+- **assets/style.scss**: wrapper file for the main stylesheet. It contains logic to override Sass variables with custom values from `_config.yml`.
+- **assets/print.scss**: wrapper file for the print stylesheet
+- **_sass/variables.scss**: contains variables with default values
+- **_sass/main.scss**: contains style definitions for the screen
+- **_sass/skip.scss**: implements Sass to hide the [skip navigation](https://webaim.org/techniques/skipnav/) link until tabbed into
+- **_sass/dark.scss**: provides dark mode support.
+
+### Data
+
+Oedipus comes with two _data files: `header-nav.yml` and `footer-nav.yml`, which I use to build nav bars. They both contain entries in the following format:
+
+```
+- name: home
+  url: /
+  desc: front page
+```
+
+### Assets
+
+The only asset Oedipus provides, in addition to the stylesheets, is [favicon.svg](https://raw.githubusercontent.com/matthewgraybosch/jekyll-oedipus-theme/main/assets/favicon.svg). You can and should generate your own. I recommend using [Formito's generator](https://formito.com/tools/favicon). You can also use [favicon.io](https://favicon.io/), but you'll want to modify **base.html** and **home-header.html** since this site doesn't generate SVG.
 
 ## 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.
+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. I will fix bugs and consider pull requests at my own discretion.
 
-The code of conduct is simple: **don't annoy me**.
+### Code of Conduct
+
+This is not a professional project, and I am not interested in collaborating with others here. I am most certainly *not* interested in fostering "community", let alone providing an "open and welcoming environment". Nevertheless, I suppose a rudimentary and informal code of conduct is necessary.
+
+1. If you mess with me, you're banned.
+2. If you mess with other contributors on this project, you're messing with me.
+3. When in doubt, refer to rule 1.
+
+(with apologies to Matthew Woodring Stover)
 
 ## License
 
 The theme is available as open source under the terms of the [GNU GPL-3.0](https://opensource.org/licenses/GPL-3.0).
 
+### Commercial/Corporate/Government Use
+
+I cannot prevent commercial use of this theme, but under no circumstance will I provide free technical support for commercial, corporate, or government projects. Issues and pull requests from people using Oedipus in a commercial, corporate, or government project will be summarily dismissed.
+
+Note: I regard inclusion of this theme on a curated site supported by advertising as commercial use. Don't do it and then expect me to provide support to your visitors.

data/_config.yml

@@ -19,7 +19,7 @@ plugins:
   - jekyll-seo-tag
 
 sass:
-  style: expanded
+  style: compressed
 
 permalink: /blog/:year/:month/:day/:title/
 
@@ -32,7 +32,7 @@ oedipus:
     code:
       name: "GNU GPL-3.0"
       url: "https://opensource.org/licenses/GPL-3.0/"
-  madeWith: "♥ in Pennsylvania"
+  made-with: "♥ in Pennsylvania"
   style:
     bg-color: "#FFFFFF"
     fg-color: "#000000"
@@ -50,6 +50,6 @@ oedipus:
     preformatted-font-size: 1rem
     preformatted-font-family: monospace
     content-width: 40rem
-    content-centered: false
-    compact-header: true
+    content-centered: true
+    compact-header: false
     home-header-icon: true

data/_includes/article-footer.html

@@ -0,0 +1,9 @@
+<footer>
+  <p>
+    Thanks for reading.<br />
+    The best way to subscribe is with a feed reader:
+    <a href="/feed.xml" title="subscribe to the Atom feed">Atom</a>
+    <a href="/feed.json" title="subscribe to the JSON feed">JSON</a><br />
+    Questions or comments? Email <a href="mailto:{{ site.email }}" title="please allow up to 7 days for a reply">{{ site.email }}</a>.
+  </p>
+</footer>

data/_includes/article-header.html

@@ -0,0 +1,4 @@
+<header>
+  <h1>{{ page.title }}</h1>
+  <p><em>{{ page.description }}</em></p>
+</header>

data/_includes/copyright.html

@@ -0,0 +1,6 @@
+{% if site.oedipus.rights %}
+© {{ site.time | date: "%Y" }} {{ site.author }}, {{ site.oedipus.rights }}
+{% else %}
+© {{ site.time | date: "%Y" }} {{ site.author }}
+{% endif %}
+<br />

data/_includes/footer.html

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

data/_includes/home-footer.html

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

data/_includes/made-with.html

@@ -0,0 +1,3 @@
+{% if site.oedipus.made-with %}
+made with {{ site.oedipus.made-with }}
+{% endif %}

data/_includes/navlist.html

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

data/_includes/posts-list.html

@@ -1,7 +1,9 @@
-{% for post in site.posts %}
-<article>
-  <h3><a href="{{ post.url }}">{{ post.title }}</a></h3>
-  <p><em>{{ post.description }}</em></p>
-  <p>posted on {{ post.date | date: "%Y-%m-%d" }}</p>
-</article>
-{% endfor %}
+<dl>
+  {% for post in site.posts %}
+  <dt>
+    [{{ post.date | date: "%Y-%m-%d" }}]
+    <a href="{{ post.url }}">{{ post.title }}</a>
+  </dt>
+  <dd>{{ post.description }}</dd>
+  {% endfor %}
+</dl>

data/_includes/recent-posts-list.html

@@ -1,7 +1,9 @@
-{% for post in site.posts | limit: include.limit %}
-<article>
-  <h3><a href="{{ post.url }}">{{ post.title }}</a></h3>
-  <p><em>{{ post.description }}</em></p>
-  <p>posted on {{ post.date | date: "%Y-%m-%d" }}</p>
-</article>
-{% endfor %}
+<dl>
+  {% for post in site.posts | limit: include.limit %}
+  <dt>
+    [{{ post.date | date: "%Y-%m-%d" }}]
+    <a href="{{ post.url }}">{{ post.title }}</a>
+  </dt>
+  <dd>{{ post.description }}</dd>
+  {% endfor %}
+</dl>

data/_layouts/base.html

@@ -4,7 +4,7 @@
     <meta charset="{{ site.encoding }}">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="icon" type="image/svg+xml" href="/assets/favicon.svg" />
-    <link rel="icon" type="image/ico" href="/assets/favicon.ico" />
+    <link rel="icon" href="data:,">
     <link rel="stylesheet" type="text/css" href="/assets/style.css" />
     <link rel="alternate" type="application/atom+xml" href="/feed.xml" title="{{ site.title }} Atom Feed">
     <link rel="alternate" type="text/json" href="/feed.json" title="{{ site.title }} JSON Feed">

data/_layouts/post.html

@@ -3,19 +3,9 @@ layout: default
 ---
 
 <article id="content">
-  <header>
-    <h1>{{ page.title }}</h1>
-    <p><em>{{ page.description }}</em></p>
-  </header>
+  {% include article-header.html %}
   <section>
     {{ content }}
   </section>
-  <footer>
-    <p>
-      Thanks for reading.<br />
-      The best way to subscribe is with a feed reader:
-      <a href="/feed.xml" title="subscribe to the Atom feed">Atom</a>
-      <a href="/feed.json" title="subscribe to the JSON feed">JSON</a><br />
-      Questions or comments? Email <a href="mailto:{{ site.email }}" title="please allow up to 7 days for a reply">{{ site.email }}</a>.</p>
-    </footer>
+  {% include article-footer.html %}
 </article>

data/_sass/dark.scss

@@ -7,6 +7,14 @@
             background: invert($bg-color);
             color: invert($fg-color);
 
+            header {
+                border-bottom: $border-thickness solid invert($fg-color);
+            }
+
+            footer {
+                border-top: $border-thickness solid invert($fg-color);
+            }
+
             a {
                 color: invert($link-color);
             }
@@ -36,8 +44,8 @@
             }
 
             article {
-                hr {
-                    border: $hr-border-thickness dashed invert($fg-color);
+                footer {
+                    border-top: $hr-border-thickness dashed invert($fg-color);
                 }
             }
             

data/_sass/main.scss

@@ -13,7 +13,11 @@ html {
 
         a {
             color: $link-color;
-            text-underline-offset: $border-thickness * 1.5;
+            text-underline-offset: $underline-offset;
+        }
+
+        abbr {
+            text-underline-offset: $underline-offset;
         }
         
         a:hover {
@@ -33,14 +37,14 @@ html {
         }
         
         header, footer, nav {
-            text-align: content-alignment;
+            text-align: $content-alignment;
 
             h1 {
-                font-size: 1rem;
+                font-size: $content-font-size;
                 margin-bottom: 1rem;
 
                 em {
-                    margin-left: 1rem;
+                    margin-left: .5rem;
                     font-weight: normal;
                 }
             }
@@ -60,30 +64,33 @@ html {
         
         nav {
             margin-top: 1.5rem;
-            p {
-                a {
-                    margin-right: 1rem;
-                    border: $border-thickness solid $link-color;
-                    border-radius: .5rem;
-                    padding: .5rem;
-                    text-decoration: none;
-                }
+            a {
+                margin: .5rem;
+                border: $border-thickness solid $link-color;
+                border-radius: .5rem;
+                padding: .5rem;
+                text-decoration: none;
+                display: inline-block;
+            }
 
-                a:last-child {
-                    margin-right: 0;
-                }
+            a:first-child {
+                margin-left: 0;
+            }
 
-                a:hover {
-                    border: $border-thickness solid $link-hover-color;
-                }
-                
-                a:active {
-                    border: $border-thickness solid $link-active-color;
-                }
-                
-                a:visited {
-                    border: $border-thickness solid $link-visited-color;
-                }
+            a:last-child {
+                margin-right: 0;
+            }
+
+            a:hover {
+                border: $border-thickness solid $link-hover-color;
+            }
+            
+            a:active {
+                border: $border-thickness solid $link-active-color;
+            }
+            
+            a:visited {
+                border: $border-thickness solid $link-visited-color;
             }
         }
         
@@ -128,19 +135,19 @@ html {
 
         main, article {
             h1 {
-                font-size: 1.6rem;
+                font-size: $content-font-size * 2;
             }
             
             h2 {
-                font-size: 1.4rem;
+                font-size: $content-font-size * 1.6;
             }
 
             h3 {
-                font-size: 1.2rem;
+                font-size: $content-font-size * 1.2;
             }
 
             h4, h5, h6 {
-                font-size: 1.1rem;
+                font-size: $content-font-size * 1.1;
             }
         }
         

data/_sass/variables.scss

@@ -19,3 +19,4 @@ $content-margin: 2rem auto;
 $content-padding: 0 .62rem;
 $blockquote-font-size: 1.1rem;
 $figure-font-size: 1.1rem;
+$underline-offset: 5px;

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-oedipus-theme
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Matthew Graybosch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +106,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.1
-description: 
+description:
 email:
 - contact@matthewgraybosch.com
 executables: []
@@ -102,11 +116,15 @@ files:
 - LICENSE.txt
 - README.md
 - _config.yml
+- _includes/article-footer.html
+- _includes/article-header.html
+- _includes/copyright.html
 - _includes/footer.html
 - _includes/header.html
 - _includes/home-footer.html
 - _includes/home-header.html
 - _includes/license.html
+- _includes/made-with.html
 - _includes/masthead.html
 - _includes/navbar.html
 - _includes/navlist.html
@@ -125,7 +143,6 @@ files:
 - _sass/paper.scss
 - _sass/skip.scss
 - _sass/variables.scss
-- assets/favicon.ico
 - assets/favicon.svg
 - assets/print.scss
 - assets/style.scss
@@ -133,7 +150,7 @@ homepage: https://github.com/matthewgraybosch/jekyll-oedipus-theme
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,15 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Build a motherfucking website with Jekyll (patricide optional)
 test_files: []