Skip to content
Oscailte — A powerful light, clean, and responsive Jekyll theme.
CSS HTML Ruby
Branch: master
Clone or download

README.md

Oscailte — A Jekyll theme Gem Version

Oscailte (IPA: [ˈɔsˠkɪlʲtʲɪ] Gaeilge for "Open") is a light and clean theme for use on Jekyll sites, released under the MIT Licence.

Quicklinks

Installation

Install as Remote Theme

Using Jekyll Remote Theme (enabled by default on Github Pages) is the quickest way to install Oscailte.

  1. Add the following to your site's _config.yml to activate Oscailte
remote_theme: coogie/oscailte

Install via Gemfile
  1. Add this line to your Jekyll site's Gemfile:
gem "oscailte"
  1. And add this line to your Jekyll site's _config.yml:
theme: oscailte
  1. And then execute:
$ bundle
  1. Or install it yourself as:
$ gem install oscailte

Usage

The majority of Oscailte's settings are nested under the oscailte key. Below are a list of all available ones, and their default values.

oscailte:
  posts_url:
  google_analytics:
  social:
    twitter: jekyllrb
    github: jekyll
    dribbble: jekyll
    facebook: jekyll
    flickr: jekyll
    instagram: jekyll
    linkedin: jekyll
    pinterest: jekyll
    telegram: jekyll
    keybase: jekyll
    rss: rss
  strings:
    skip_to_main_content: "Skip to main content"
    x_minute_read: "$x$ minute read"
    hero_title: "Welcome to Oscailte!<br> A powerful, clean, and responsive Jekyll theme."
    recent_posts: "Recent posts"
    view_all: "View all"
    read_full: "Read full"
    disqus_enable_javascript: 'Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus</a>.'

Enabling Comments (via Disqus)

Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.

To enable it, add the following lines to your Jekyll site:

disqus:
  shortname: my_disqus_shortname

You can find out more about Disqus' shortnames here.

Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production

If you don't want to display comments for a particular post you can disable them by adding comments: false to that post's YAML Front Matter.

⚠️ url, e.g. https://example.com, must be set in you config file for Disqus to work.

Social Networks

You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config. These usernames are nested under oscailte.social, with the keys being simply the social network's name:

oscailte:
  social:
    twitter: jekyllrb
    github: jekyll
    dribbble: jekyll
    facebook: jekyll
    flickr: jekyll
    instagram: jekyll
    linkedin: jekyll
    pinterest: jekyll
    telegram: jekyll
    keybase: jekyll
    rss: rss

Enabling Google Analytics

To enable Google Analytics, add the following lines to your _config.yml:

oscailte:
  google_analytics: UA-NNNNNNNN-N

Google Analytics will only appear in production, i.e., JEKYLL_ENV=production Oscailte will also inform Google Analytics of your user's request for DNT.

Enabling Excerpts on the Home Page

To display post-excerpts on the Home Page, simply add the following to your _config.yml:

show_excerpts: true

Customising Oscailte

Site Colours

Oscailte makes extensive use of CSS Custom Properties for various parts of its look and feel. A full list of the properties used throughout can be found in /_sass/_oscailte.scss. Some of these properties are generated via SCSS (such as typography), but are still Custom Properties in-browser (not Sass variables).

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/coogie/oscailte. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.

You can’t perform that action at this time.