jekyll-oedipus-theme

Build a motherfucking website with Jekyll (patricide optional).

Screenshot

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-oedipus-theme"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-oedipus-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-oedipus-theme

Usage

Oedipus can be customized to a great extent in {_config.yml}, but if you want to override any part of the theme, 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”.

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 for accessibility. The dark theme takes each of these variables and applies the {Sass invert()} function to them.

Layouts

Includes

Sass

Oedipus' stylesheets are built with Sass, which is included with Jekyll.

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. You can and should generate your own. I recommend using Formito’s generator. You can also use 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. I will fix bugs and consider pull requests at my own discretion.

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.

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.