- Customising Oscailte
Install as Remote Theme
Using Jekyll Remote Theme (enabled by default on Github Pages) is the quickest way to install Oscailte.
- Add the following to your site's
_config.ymlto activate Oscailte
Install via Gemfile
- Add this line to your Jekyll site's
- And add this line to your Jekyll site's
- And then execute:
- Or install it yourself as:
$ gem install oscailte
The majority of Oscailte's settings are nested under the
Below are a list of all available ones, and their default values.
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.,
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.
https://example.com, must be set in you config file for Disqus to
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
oscailte: google_analytics: UA-NNNNNNNN-N
Google Analytics will only appear in production, i.e.,
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
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).
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.
The theme is available as open source under the terms of the MIT License.