oscailte 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8a5800d066a43306565d3e703c482bf80579ce3
+  data.tar.gz: 838bdaa17bebdd96c21bb7dc49c2c5fe9c9ed6ec
+SHA512:
+  metadata.gz: f960a65a0aa550f4f11fd822b7c6bb9a8d3bb72c3627bb0552d1a9aa2c42d3aa9c8e962aa82e4c88963695c84436b1b1b820151bf22c21933a98e80c1112e1d7
+  data.tar.gz: c4e677eac2a2d105d94f98de70b4b54e3845fa64040b743fc73370fd192ef331eb7dd99501194e308f59f25e9ecce4a0ca9cfff82a1cc5518cd4b50662b776a9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stephen Coogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# Oscailte — A Jekyll theme
+
+---
+## ![Attention](http://i.imgur.com/iBbFfJH.png) Latest version: 3.0</sup>
+
+---
+
+Oscailte ([IPA: [ˈɔsˠkɪlʲtʲɪ]](http://en.wiktionary.org/wiki/Appendix:Irish_pronunciation) Gaeilge for "Open") is a light and clean theme for use on [Jekyll](https://jekyllrb.org/) sites, released under the MIT Licence.
+
+## Quicklinks
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Enabling Comments (via Disqus)](#enabling-comments-via-disqus)
+    - [Social Networks](#social-networks)
+    - [Enabling Google Analytics](#enabling-google-analytics)
+    - [Enabling Excerpts on the Home Page](#enabling-excerpts-on-the-home-page)
+  - [Customising Oscailte](#customising-oscailte)
+    - [Site Colours](#site-colours)
+
+## Installation
+
+<details>
+  <summary><strong>Install as Remote Theme</strong></summary>
+
+  Using [Jekyll Remote Theme](https://github.com/benbalter/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  
+  ```yml
+  remote_theme: coogie/oscailte
+  ```
+</details>
+
+----
+
+<details>
+  <summary><strong>Install via Gemfile</strong></summary>
+
+  1. Add this line to your Jekyll site's `Gemfile`:  
+  ```ruby
+  gem "oscailte"
+  ```
+
+  2. And add this line to your Jekyll site's `_config.yml`:
+  ```yaml
+  theme: oscailte
+  ```
+
+  3. And then execute:
+  ```sh
+  $ bundle
+  ```
+
+  4. Or install it yourself as:
+  ```sh
+  $ gem install oscailte
+  ```
+</details>
+
+## 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.
+
+```yml
+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:
+
+```yml
+disqus:
+  shortname: my_disqus_shortname
+```
+
+You can find out more about Disqus' shortnames [here](https://help.disqus.com/installation/whats-a-shortname).
+
+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.
+
+:warning: `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:
+
+```yml
+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`:
+
+```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`:
+
+```yaml
+show_excerpts: true
+```
+
+## Customising Oscailte
+
+### Site Colours
+
+Oscailte makes extensive use of [CSS Custom Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*)
+for various parts of its look and feel. A full list of the properties used throughout can
+be found in [`/_sass/_oscailte.scss`](./_sass/_oscailte.scss#L40). _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](https://contributor-covenant.org)
+code of conduct.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/comments.html

@@ -0,0 +1,21 @@
+{%- if page.comments != false and site.disqus.shortname and jekyll.environment == "production" -%}
+<section class="container">
+  <h1 class="SectionTitle">Comments</h1>
+  <div id="disqus_thread" class="Comments"></div>
+  <script>
+    var disqus_config = function () {
+      this.page.url = '{{ page.url | absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+    (function() {
+      var d = document, s = d.createElement('script');
+      s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+      s.setAttribute('data-timestamp', +new Date());
+      (d.head || d.body).appendChild(s);
+    })();
+  </script>
+  <noscript>
+    {{ disqus_enable_javascript }}
+  </noscript>
+</section>
+{%- endif -%}

data/_includes/footer.html

@@ -0,0 +1,10 @@
+<footer class="Site__footer o-circuited">
+  <div class="Container">
+    <p>
+      All content copyright {{ site.author }}<br>
+      <small class="o-muted">Powered by <a href="https://jekyllrb.com/">Jekyll</a>, themed with <a href="https://github.com/coogie/oscailte">Oscailte</a></small>.
+    </p>
+
+    {%- include social.html -%}
+  </div>
+</footer>      

data/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+{%- assign analyics_id = site.oscailte.google_analytics -%}
+{%- if analyics_id and jekyll.environment == 'production' -%}
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ analyics_id }}"></script>
+<script>
+  window['ga-disable-{{ analyics_id }}'] = window.OSCAILTE_DNT;
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+  gtag('config', '{{ analyics_id }}');
+</script>
+{%- endif -%}

data/_includes/head.html

@@ -0,0 +1,12 @@
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta http-equiv="X-UA-Compatible" content="ie=edge">
+  {% seo %}
+  {% feed_meta %}
+  <link rel="icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}">
+  <link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
+  <script>
+    window.OSCAILTE_DNT = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
+  </script>
+</head>

data/_includes/header.html

@@ -0,0 +1,17 @@
+<header class="Header">
+  <div class="Container">
+    {% if site.title %}
+    <h1 class="Header__title">
+      <a href="{{ site.url }}">
+        {{ site.title }}
+        {% if site.subtitle %}
+          <br>
+          <small class="Header__subtitle">{{ site.subtitle }}</small>
+        {% endif %}
+      </a>
+    </h1>
+    {% endif %}
+
+    {% include navigation.html %}
+  </div>
+</header>

data/_includes/hero.html

@@ -0,0 +1,17 @@
+<section class="Hero o-circuited">
+  <div class="Hero__content Container">
+    {%- unless page.layout == 'post' or site.oscailte.social.github == nil -%}
+      {% avatar {{site.oscailte.social.github}} size=350 %}
+    {%- endunless -%}
+
+    <h1 class="Hero__title">
+      {{ include.title }}
+    </h1>
+
+    {% if include.meta %}
+      <div class="Hero__meta">
+        {{ include.meta }}
+      </div>
+    {% endif %}
+  </div>
+</section>

data/_includes/icon.html

@@ -0,0 +1,2 @@
+{%- capture path -%}/assets/oscailte/img/icons.svg#{{ include.icon }}{%- endcapture -%}
+<svg class="Icon Icon--{{ include.icon }}"><use xlink:href="{{ path | relative_url }}"></use></svg>

data/_includes/navigation.html

@@ -0,0 +1,18 @@
+{%- assign default_paths = site.pages | map: "path" -%}
+{%- assign page_paths = site.header_pages | default: default_paths -%}
+{%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
+
+{%- if titles_size > 0 -%}
+<nav class="Navigation">
+  <ul class="Navigation__items o-list-bare">
+    {%- for path in page_paths -%}
+      {%- assign nav_page = site.pages | where: "path", path | first -%}
+      {%- if nav_page.title -%}
+      <li class="Navigation__item{% if page.url == nav_page.url %} is-active{%endif%}">
+        <a class="Navigation__link" href="{{nav_page.url}}">{{nav_page.title | escape}}</a>
+      </li>
+      {%- endif -%}
+    {%- endfor -%}
+  </ul>
+</nav>
+{% endif %}

data/_includes/social.html

@@ -0,0 +1,17 @@
+{%- assign social = site.oscailte.social -%}
+
+<div class="Social">
+  <ul class="Social__list o-list-bare">
+    {%- if social.dribbble -%}<li class="Social__item Social__item--dribbble o-no-owl"><a class="Social__link" href="https://dribbble.com/{{ social.dribbble | cgi_escape | escape }}" title="{{ social.dribbble | escape }}"> {%- include icon.html icon="dribbble" -%} </a></li>{%- endif -%}
+    {%- if social.facebook -%}<li class="Social__item Social__item--facebook o-no-owl"><a class="Social__link" href="https://www.facebook.com/{{ social.facebook | cgi_escape | escape }}" title="{{ social.facebook | escape }}"> {%- include icon.html icon="facebook" -%} </a></li>{%- endif -%}
+    {%- if social.flickr -%}<li class="Social__item Social__item--flickr o-no-owl"><a class="Social__link" href="https://www.flickr.com/photos/{{ social.flickr | cgi_escape | escape }}" title="{{ social.flickr | escape }}"> {%- include icon.html icon="flickr" -%} </a></li>{%- endif -%}
+    {%- if social.github -%}<li class="Social__item Social__item--github o-no-owl"><a class="Social__link" href="https://github.com/{{ social.github | cgi_escape | escape }}" title="{{ social.github | escape }}"> {%- include icon.html icon="github" -%} </a></li>{%- endif -%}
+    {%- if social.instagram -%}<li class="Social__item Social__item--instagram o-no-owl"><a class="Social__link" href="https://www.instagram.com/{{ social.instagram | cgi_escape | escape }}" title="{{ social.instagram | escape }}"> {%- include icon.html icon="instagram" -%} </a></li>{%- endif -%}
+    {%- if social.keybase -%}<li class="Social__item Social__item--keybase o-no-owl"><a class="Social__link" href="https://keybase.io/{{ social.keybase | cgi_escape | escape }}" title="{{ social.keybase | escape }}"> {%- include icon.html icon="keybase" -%} </a></li>{%- endif -%}
+    {%- if social.linkedin -%}<li class="Social__item Social__item--linkedin o-no-owl"><a class="Social__link" href="https://www.linkedin.com/in/{{ social.linkedin | cgi_escape | escape }}" title="{{ social.linkedin | escape }}"> {%- include icon.html icon="linkedin" -%} </a></li>{%- endif -%}
+    {%- if social.pinterest -%}<li class="Social__item Social__item--pinterest o-no-owl"><a class="Social__link" href="https://www.pinterest.com/{{ social.pinterest | cgi_escape | escape }}" title="{{ social.pinterest | escape }}"> {%- include icon.html icon="pinterest" -%} </a></li>{%- endif -%}
+    {%- if social.telegram -%}<li class="Social__item Social__item--telegram o-no-owl"><a class="Social__link" href="https://t.me/{{ social.telegram | cgi_escape | escape }}" title="{{ social.telegram | escape }}"> {%- include icon.html icon="telegram" -%} </a></li>{%- endif -%}
+    {%- if social.twitter -%}<li class="Social__item Social__item--twitter o-no-owl"><a class="Social__link" href="https://twitter.com/{{ social.twitter | cgi_escape | escape }}" title="{{ social.twitter | escape }}"> {%- include icon.html icon="twitter" -%} </a></li>{%- endif -%}
+    {%- if social.rss -%}<li class="Social__item Social__item--rss o-no-owl"><a class="Social__link" href="{{ 'feed.xml' | relative_url }}" title="{{ social.rss | escape }}"> {%- include icon.html icon="rss" -%} </a></li>{%- endif -%}
+  </ul>
+</div>

data/_includes/strings.html

@@ -0,0 +1,9 @@
+{%- assign strings = site.oscailte.strings -%}
+
+{%- assign skip_to_main_content     = strings.skip_to_main_content     | default: "Skip to main content" -%}
+{%- assign x_minute_read            = strings.x_minute_read            | default: "$x$ minute read" -%}
+{%- assign hero_title               = strings.hero_title               | default: "Welcome to Oscailte!<br> A powerful, clean, and responsive Jekyll theme." -%}
+{%- assign recent_posts             = strings.recent_posts             | default: "Recent posts" -%}
+{%- assign view_all                 = strings.view_all                 | default: "View all" -%}
+{%- assign read_full                = strings.read_full                | default: "Read full" -%}
+{%- assign disqus_enable_javascript = strings.disqus_enable_javascript | default: 'Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus</a>.' -%}

data/_layouts/core.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+  {%- include strings.html -%}
+
+  {%- include head.html -%}
+
+  {%- capture body_modifier -%}
+    {%- if page.body_modifier -%}
+      {{ page.body_modifier }}
+    {%- else -%}
+      {{ page.layout }}
+    {%- endif -%}
+  {%- endcapture -%}
+
+  <body class="Site {% if body_modifier != '' %}Site--{{ body_modifier }}{% endif %}">
+    {%- include header.html -%}
+
+    <a href="#main-content" class="SkipNav" tabindex="1">{{ skip_to_main_content }}</a>
+
+    <main class="Site__main o-no-owl" id="main-content">
+      {{ content }}
+    </main>
+
+    {%- include footer.html -%}
+
+    {%- include google-analytics.html -%}
+  </body>
+</html> 

data/_layouts/default.html

@@ -0,0 +1,7 @@
+---
+layout: core
+---
+
+<section class="Container">
+  {{ content }}
+</section>

data/_layouts/home.html

@@ -0,0 +1,44 @@
+---
+layout: core
+---
+{%- include strings.html -%}
+
+{%- include hero.html title=hero_title -%}
+
+<section class="Container">
+  {{ content }}
+
+  {%- if site.posts.size > 0 -%}
+  <aside class="RecentPosts">
+    <h2 class="RecentPosts__title">{{ recent_posts }}</h2>
+    {%- if site.oscailte.posts_url -%}
+    <small>
+      <a class="RecentPosts__all" href="{{ site.oscailte.posts_url | relative_url }}">
+        {{ view_all }}
+      </a>  
+    </small>
+    {%- endif -%}
+    <ul class="RecentPosts__list o-list-bare">
+      {%- for post in site.posts limit: 6 -%}
+      <li class="RecentPosts__item Card o-no-owl">
+        {%- assign date_format = site.oscailte.date_format | default: "%b %-d, %Y" -%}
+        <h3 class="Card__title">
+          <a class="RecentPosts__link" href="{{ post.url | relative_url }}">
+            {{ post.title | escape }}
+          </a>
+        </h3>
+        <small class="Card__meta o-no-owl o-muted">
+          {%- include icon.html icon="calendar" -%} {{ post.date | date: date_format }}
+        </small>
+        {%- if site.show_excerpts -%}
+        <div class="RecentPosts__excerpt o-no-owl">
+          {{ post.excerpt }}
+        </div>
+        {%- endif -%}
+        <a class="Button" href="{{ post.url | relative_url }}">{{ read_full }}</a>
+      </li>
+      {%- endfor -%}
+    </ul>
+  </aside>
+  {%- endif -%}
+</section>

data/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}