jekyll-theme-hydeout 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9f88c5964e43774f164f651b97248abd56a28cf
+  data.tar.gz: 858ebd71a0570ef6ef6b087c844c544db320e569
+SHA512:
+  metadata.gz: 31e2540d39265eebab607e984f4624b94c320f6a8fa94e3620649cc4178c43abfce62e2c8287b15acc8f90e7020527848634410ea110c398b3f27604edebe3ac
+  data.tar.gz: db149f719af24f63086e30164ea0b1e57a2e8355b81740411bd4c67543039f497e06299b0eaed112bca5883d52320e3f11dd7e1e456a68480b76923880fa640d

data/LICENSE.md

@@ -0,0 +1,11 @@
+# Released under MIT License
+
+Copyright (c) 2013 Mark Otto.
+
+Copyright (c) 2017 Andrew Fong.
+
+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,98 @@
+# Hydeout
+
+Hydeout updates the original [Hyde](https://github.com/poole/hyde)
+theme for [Jekyll](http://jekyllrb.com) 3.x and adds new functionality.
+
+![Desktop](/_screenshots/1.png?raw=true)
+![Mobile home page](/_screenshots/2.png?raw=true)
+![Mobile post page](/_screenshots/3.png?raw=true)
+
+### Usage
+
+Hydeout is available as the `jekyll-theme-hydeout` Ruby Gem.
+Add `gem "jekyll-theme-hydeout", "~> 3.1.0"` to your Gemfile and run
+`bundle install`.
+
+Hydeout uses pagination, so if you have an `index.md`, you'll need to swap
+it with an `index.html` that uses the `home` layout:
+
+```
+---
+layout: home
+title: Home
+---
+```
+
+### Keep It Simple
+
+In keeping with the original Hyde theme, Hydeout aims to keep the overall
+design lightweight and plugin-free. JavaScript is currently limited only
+to Disqus and Google Analytics (and is only loaded if you provide configuration
+variables).
+
+Hydeout makes heavy use of Flexbox in its CSS. If Flexbox is not available,
+the CSS degrades into a single column layout.
+
+### Customization
+
+Hydeout replaces Hyde's class-based theming with the use
+of the following SASS variables:
+
+```scss
+$sidebar-bg-color: #202020 !default;
+$sidebar-sticky: true !default;
+$layout-reverse: false !default;
+$link-color: #268bd2 !default;
+```
+
+To override these variables, create your own `assets/css/main.scss` file.
+Define your own variables, then import in Hydeout's SCSS, like so:
+
+```scss
+---
+# Jekyll needs front matter for SCSS files
+---
+
+$sidebar-bg-color: #ac4142;
+$link-color: #ac4142;
+$sidebar-sticky: false;
+@import "hydeout";
+```
+
+See the [_variables](_sass/hydeout/_variables.scss) file for other variables
+you can override.
+
+You can also insert custom head tags (e.g. to load your own stylesheets) by
+defining your own `_includes/custom-head.html` or insert tags at the end
+of the body (e.g. for custom JS) by defining your own
+`_includes/custom-foot.html`.
+
+### New Features
+
+* Hydeout also adds a new tags page (accessible in the sidebar) and a new
+  "category" layout for dedicated category pages.
+
+* Category pages are automatically added to the sidebar. All other pages
+  must have `sidebar_link: true` in their front matter to show up in
+  the sidebar.
+
+* A simple redirect-to-Google search is available. If you want to use
+  Google Custom Search or Algolia or something with more involved,
+  override the `search.html`.
+
+* Disqus integration is ready out of the box. Just add the following to
+  your config file:
+
+  ```yaml
+  disqus:
+    shortname: my-disqus-shortname
+  ```
+
+  If you don't want Disqus or want to use something else, override
+  `comments.html`.
+
+* For Google Analytics support, define a `google_analytics` variable with
+  your property ID in your config file.
+
+There's also a bunch of minor tweaks and adjustments throughout the
+theme. Hope this works for you!

data/_includes/comments.html

@@ -0,0 +1,6 @@
+{% if page.comments != false %}
+  <section class="comments">
+    <h2>Comments</h2>
+    {% include disqus.html %}
+  </section>
+{% endif %}

data/_includes/copyright.html

@@ -0,0 +1,4 @@
+<p>
+  &copy; {{ site.time | date: '%Y' }}.
+  <a href="/LICENSE.md">MIT License.</a>
+</p>

data/_includes/custom-foot.html

@@ -0,0 +1 @@
+<!-- Optional footer content -->

data/_includes/custom-head.html

@@ -0,0 +1 @@
+<!-- Additional head bits without overriding original head -->

data/_includes/disqus.html

@@ -0,0 +1,43 @@
+{% if site.disqus.shortname %}
+  <div id="disqus_thread">
+    <button class="disqus-load" onClick="loadDisqusComments()">
+      Load Comments
+    </button>
+  </div>
+  <script>
+
+  /**
+  *  RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW
+  *  TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
+  *  LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT:s
+  *  https://disqus.com/admin/universalcode/#configuration-variables
+  */
+  var disqus_config = function () {
+    this.page.url = "{{ page.url | absolute_url }}";
+    this.page.identifier = "{{ page.guid or page.id }}" ||
+                           "{{ page.url | absolute_url }}";
+  }
+  function loadDisqusComments() { // DON'T EDIT BELOW THIS LINE
+    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>
+    Please enable JavaScript to view the
+    <a href="https://disqus.com/?ref_noscript">comments powered by Disqus</a>.
+  </noscript>
+
+{% elsif jekyll.environment != "production" %}
+  <p>
+    You are seeing this because your Disqus shortname is not properly set. To
+    configure Disqus, you should edit your <code>_config.yml</code> to include
+    either a <code>disqus.shortname</code> variable.
+  </p>
+
+  <p>
+    If you do not wish to use Disqus, override the
+    <code>comments.html</code> partial for this theme.
+  </p>
+{% endif %}

data/_includes/favicons.html

@@ -0,0 +1,2 @@
+<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/favicon.png" />
+<link rel="shortcut icon" href="{{ site.baseurl }}/favicon.ico" />

data/_includes/font-includes.html

@@ -0,0 +1,6 @@
+{% comment %}
+  Separate partial for Google Webfont include, so we can override with
+  different fonts as applicable.
+{% endcomment %}
+
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Abril+Fatface" />

data/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+{% if jekyll.environment == 'production' and site.google_analytics %}
+  <script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+  </script>
+{% endif %}

data/_includes/head.html

@@ -0,0 +1,30 @@
+<head>
+  <link href="http://gmpg.org/xfn/11" rel="profile" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+  <!-- Enable responsiveness on mobile devices-->
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1" />
+
+  <title>
+    {% if page.title == "Home" %}
+      {{ site.title }} &middot; {{ site.tagline }}
+    {% else %}
+      {{ page.title }} &middot; {{ site.title }}
+    {% endif %}
+  </title>
+
+  {% include google-analytics.html %}
+
+  <!-- CSS -->
+  <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css" />
+  {% include font-includes.html %}
+
+  <!-- Icons -->
+  {% include favicons.html %}
+
+  <!-- RSS -->
+  <link rel="alternate" type="application/rss+xml" title="RSS" href="/feed.xml" />
+
+  {% include custom-head.html %}
+</head>

data/_includes/pagination.html

@@ -0,0 +1,16 @@
+<div class="pagination">
+  {% if paginator.next_page %}
+    <a class="pagination-item older" href="{{ site.baseurl }}/page{{paginator.next_page}}">Older</a>
+  {% else %}
+    <span class="pagination-item older">Older</span>
+  {% endif %}
+  {% if paginator.previous_page %}
+    {% if paginator.page == 2 %}
+      <a class="pagination-item newer" href="{{ site.baseurl }}">Newer</a>
+    {% else %}
+      <a class="pagination-item newer" href="{{ site.baseurl }}/page{{paginator.previous_page}}">Newer</a>
+    {% endif %}
+  {% else %}
+    <span class="pagination-item newer">Newer</span>
+  {% endif %}
+</div>

data/_includes/post-meta.html

@@ -0,0 +1,30 @@
+<div class="post-meta">
+  <span class="post-date">{{ include.post.date | date_to_string }}</span>
+  <span class="post-categories">
+    {% for category in include.post.categories %}
+      &bull;
+
+      {% comment %}
+        Check if this category has a corresponding page before decide
+        to link to it. This is an O(n^2) operations so consider removing
+        it and linking for all categories (or no categories) if this
+        site has a lot of pages and/or a lot of categories.
+      {% endcomment %}
+      {% assign category_page = false %}
+      {% for node in site.pages %}
+        {{ node.category }}
+        {% if node.category == category or node.title == category %}
+          {% assign category_page = node %}
+        {% endif %}
+      {% endfor %}
+
+      {% if category_page %}
+        <a href="{{ site.baseurl }}{{ category_page.url }}">
+          {{ category }}
+        </a>
+      {% else %}
+        {{ category }}
+      {% endif %}
+    {% endfor %}
+  </span>
+</div>

data/_includes/post-tags.html

@@ -0,0 +1,9 @@
+<div class="post-tags">
+  {% for tag in include.post.tags %}
+    <a href="{{ site.baseurl }}/tags#{{ tag | slugify }}">
+      <span class="icon">
+        {% include svg/tags.svg %}
+      </span>&nbsp;<span class="tag-name">{{ tag }}</span>
+    </a>
+  {% endfor %}
+</div>

data/_includes/related_posts.html

@@ -0,0 +1,15 @@
+<section class="related">
+  <h2>Related Posts</h2>
+  <ul class="posts-list">
+    {% for post in site.related_posts limit:3 %}
+      <li>
+        <h3>
+          <a href="{{ post.url }}">
+            {{ post.title }}
+            <small>{{ post.date | date_to_string }}</small>
+          </a>
+        </h3>
+      </li>
+    {% endfor %}
+  </ul>
+</section>

data/_includes/search-form.html

@@ -0,0 +1,17 @@
+<form action="https://google.com/search" class="search-form">
+  <div class="search-row">
+    <input id="search-bar" type="search" name="q" />
+
+    {% comment %}
+      Hacky strip of protocol to the sitesearch value we pass to Google
+    {% endcomment %}
+    {% assign url = site.url | replace_first: 'https://', '' %}
+    {% assign url = url | replace_first: 'http://', '' %}
+    {% assign url = url | replace_first: 'spdy://', '' %}
+    {% assign url = url | replace_first: '//', '' %}
+    <input name="sitesearch" type="hidden"
+           value="{{ url }}{{ site.baseurl }}" />
+
+    <input type="submit" value="Search" />
+  </div>
+</form>

data/_includes/sidebar-icon-links.html

@@ -0,0 +1,26 @@
+<nav id="sidebar-icon-links">
+  {% if site.github.repo %}
+    <a class="icon" title="Github Project" aria-label="Github Project"
+        href="{{ site.github.repo }}">
+      {% include svg/github.svg %}
+    </a>
+    <a class="icon" title="Download" aria-label="Download"
+        href="{{ site.github.repo }}/archive/v{{ site.version }}.zip">
+      {% include svg/download.svg %}
+    </a>
+  {% endif %}
+  <a class="icon" title="Subscribe" aria-label="Subscribe"
+      href="{{ site.baseurl }}/feed.xml">
+    {% include svg/feed.svg %}
+  </a>
+  <a class="icon{% if page.url == '/tags' %} active{% endif %}"
+      title="Tags" aria-label="Tags"
+      href="{{ site.baseurl }}/tags">
+    {% include svg/tags.svg %}
+  </a>
+  <a class="icon{% if page.url == '/search' %} active{% endif %}"
+      title="Search" aria-label="Tags"
+      href="{{ site.baseurl }}/search">
+    {% include svg/search.svg %}
+  </a>
+</nav>

data/_includes/sidebar-nav.html

@@ -0,0 +1,34 @@
+<nav id="sidebar-nav">
+  <a class="{% if page.url == '/' %} active{% endif %}"
+      href="{{ site.baseurl }}/">Home</a>
+
+  {% comment %}
+    The code below dynamically generates a sidebar nav of pages with
+    `sidebar_link: true` in the front-matter. See readme for usage.
+  {% endcomment %}
+  {% assign pages_list = site.pages %}
+  {% for node in pages_list %}
+    {% if node.title != null %}
+      {% if node.sidebar_link %}
+        <a class="{% if page.url == node.url %} active{% endif %}"
+            href="{{ site.baseurl }}{{ node.url }}">{{ node.title }}</a>
+      {% endif %}
+    {% endif %}
+  {% endfor %}
+
+  {% comment %}
+    Now do it again, but for category pages
+  {% endcomment %}
+  {% for node in pages_list %}
+    {% if node.title != null %}
+      {% if node.layout == "category" %}
+        <a class="{% if page.url == node.url %} active{% endif %}"
+            href="{{ site.baseurl }}{{ node.url }}">{{ node.title }}</a>
+      {% endif %}
+    {% endif %}
+  {% endfor %}
+
+  {% if site.version %}
+    <span>Currently v{{ site.version }}</span>
+  {% endif %}
+</nav>

data/_includes/sidebar.html

@@ -0,0 +1,16 @@
+<div id="sidebar">
+  <header>
+    <{% if page.layout == "home" %}h1{% else %}div{% endif %} class="site-title">
+      <a href="{{ site.baseurl }}/">
+        {% unless page.url == "/" %}
+          <span class="back-arrow icon">{% include svg/back-arrow.svg %}</span>
+        {% endunless %}
+        {{ site.title }}
+      </a>
+    </{% if page.layout == "home" %}h1{% else %}div{% endif %}>
+    <p class="lead">{{ site.description }}</p>
+  </header>
+  {% include sidebar-nav.html %}
+  {% include sidebar-icon-links.html %}
+  {% include copyright.html %}
+</div>

data/_includes/svg/back-arrow.svg

@@ -0,0 +1,4 @@
+<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+  <path d="M0 0h24v24H0z" fill="none"/>
+  <path d="M20 11H7.83l5.59-5.59L12 4l-8 8 8 8 1.41-1.41L7.83 13H20v-2z"/>
+</svg>

data/_includes/svg/download.svg

@@ -0,0 +1,4 @@
+<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+    <path d="M19 9h-4V3H9v6H5l7 7 7-7zM5 18v2h14v-2H5z"/>
+    <path d="M0 0h24v24H0z" fill="none"/>
+</svg>

data/_includes/svg/feed.svg

@@ -0,0 +1,5 @@
+<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+    <path d="M0 0h24v24H0z" fill="none"/>
+    <circle cx="6.18" cy="17.82" r="2.18"/>
+    <path d="M4 4.44v2.83c7.03 0 12.73 5.7 12.73 12.73h2.83c0-8.59-6.97-15.56-15.56-15.56zm0 5.66v2.83c3.9 0 7.07 3.17 7.07 7.07h2.83c0-5.47-4.43-9.9-9.9-9.9z"/>
+</svg>

data/_includes/svg/github.svg

@@ -0,0 +1,2 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 28"><path d="M12 2c6.625 0 12 5.375 12 12 0 5.297-3.437 9.797-8.203 11.391-0.609 0.109-0.828-0.266-0.828-0.578 0-0.391 0.016-1.687 0.016-3.297 0-1.125-0.375-1.844-0.812-2.219 2.672-0.297 5.484-1.313 5.484-5.922 0-1.313-0.469-2.375-1.234-3.219 0.125-0.313 0.531-1.531-0.125-3.187-1-0.313-3.297 1.234-3.297 1.234-0.953-0.266-1.984-0.406-3-0.406s-2.047 0.141-3 0.406c0 0-2.297-1.547-3.297-1.234-0.656 1.656-0.25 2.875-0.125 3.187-0.766 0.844-1.234 1.906-1.234 3.219 0 4.594 2.797 5.625 5.469 5.922-0.344 0.313-0.656 0.844-0.766 1.609-0.688 0.313-2.438 0.844-3.484-1-0.656-1.141-1.844-1.234-1.844-1.234-1.172-0.016-0.078 0.734-0.078 0.734 0.781 0.359 1.328 1.75 1.328 1.75 0.703 2.141 4.047 1.422 4.047 1.422 0 1 0.016 1.937 0.016 2.234 0 0.313-0.219 0.688-0.828 0.578-4.766-1.594-8.203-6.094-8.203-11.391 0-6.625 5.375-12 12-12zM4.547 19.234c0.031-0.063-0.016-0.141-0.109-0.187-0.094-0.031-0.172-0.016-0.203 0.031-0.031 0.063 0.016 0.141 0.109 0.187 0.078 0.047 0.172 0.031 0.203-0.031zM5.031 19.766c0.063-0.047 0.047-0.156-0.031-0.25-0.078-0.078-0.187-0.109-0.25-0.047-0.063 0.047-0.047 0.156 0.031 0.25 0.078 0.078 0.187 0.109 0.25 0.047zM5.5 20.469c0.078-0.063 0.078-0.187 0-0.297-0.063-0.109-0.187-0.156-0.266-0.094-0.078 0.047-0.078 0.172 0 0.281s0.203 0.156 0.266 0.109zM6.156 21.125c0.063-0.063 0.031-0.203-0.063-0.297-0.109-0.109-0.25-0.125-0.313-0.047-0.078 0.063-0.047 0.203 0.063 0.297 0.109 0.109 0.25 0.125 0.313 0.047zM7.047 21.516c0.031-0.094-0.063-0.203-0.203-0.25-0.125-0.031-0.266 0.016-0.297 0.109s0.063 0.203 0.203 0.234c0.125 0.047 0.266 0 0.297-0.094zM8.031 21.594c0-0.109-0.125-0.187-0.266-0.172-0.141 0-0.25 0.078-0.25 0.172 0 0.109 0.109 0.187 0.266 0.172 0.141 0 0.25-0.078 0.25-0.172zM8.937 21.438c-0.016-0.094-0.141-0.156-0.281-0.141-0.141 0.031-0.234 0.125-0.219 0.234 0.016 0.094 0.141 0.156 0.281 0.125s0.234-0.125 0.219-0.219z"></path>
+</svg>