jekyll-theme-hydejack 7.5.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a69f51f687f8e464c1d1ea805b3815026efa6de
-  data.tar.gz: 824c4cb45b51f9a185073a63c5097d8d17d5df18
+  metadata.gz: 975665c41d618887d2afcc15ec904b5116714682
+  data.tar.gz: f3cb153ded0a15f3fcfe16fc0f1712c74d11a9c8
 SHA512:
-  metadata.gz: c8ba9b55b00635f292c9a10d6c293c92f036e217d2efdcf7146eb391837b0f3038a0068a29f1935ee71e2ad93279dfb7f620b73a4a3048cf6af848d6b7e1c37b
-  data.tar.gz: c2cbe14af1e72255a8905fd038baa0d3942b7b89bf2181cf59039c49ee66e421b189c8b6de2e0c4ff3504e06c18c69ae73df22320f4f16d089eeaeaecc6db664
+  metadata.gz: fad6141a332020bfd7dade9f48d3a43c4c36b3a4d5af141e5604a7291b53721fb078840b40615a88c77942c8bbee84d9c1a5a0cdc6a898fc4794e16e0baddb17
+  data.tar.gz: 7408eb629862fa4ad0b314b6bf2ecf4d8701b08a0e223793be4ce8ce682acfb1ea5c33264475a3297259b7c92b8c0376860fdc921503dafad6be8a044aba02b8

data/LICENSE.md

@@ -1,7 +1,4 @@
----
-layout: page
-title: LICENSE
----
+# LICENSE
 
 ## GNU GENERAL PUBLIC LICENSE
 

data/README.md

@@ -1,121 +1,174 @@
 # Hydejack
-[![Gem Version](https://badge.fury.io/rb/jekyll-theme-hydejack.svg)](https://badge.fury.io/rb/jekyll-theme-hydejack)
 
-**Hydejack** is a Jekyll theme with JavaScript powers, combining the best of static sites and modern web apps.
-It features a suite of JavaScript that makes the page feel like an app, without sacrificing backwards-compatibility,
-page-load speed or SEO.
+> "Best Jekyll Theme by a Mile"
+
+
+![Screenshot](assets/img/hydejack-8.jpg)
+Hydejack's cover page on a variety of screens.
+
+
+**Hydejack** is your presence on the web. It gives you a *blog* that is suitable for both prose and technical documentation, a *portfolio* to showcase your projects, and a beautiful *resume* template that looks amazing on the web and in print.
 
 > Your presence on the web — A [blog], a [portfolio] and a [resume].
 
-**Hydejack** aims to be the complete package for professionals on the web.
-It features a blog suitable for both prose and technical documentation,
-a showcase for your projects, and a resume that fits with the rest of the design.
 
-![Screenshot](https://qwtel.com/assets/img/projects/default.jpg)
+There are two versions of **Hydejack**: The base version is free, while features that are specific to *professionals* are a payed upgrade.
+
+[**Download Free**][kit]
+– or –
+[**Buy PRO**][buy]
+
+
+## The Basics of Blogging
+**Hydejack** started out as a free blogging theme for Jekyll — and continues to be so.
+
+<!--posts-->
+
+
+## An Impressive Portfolio
+A portfolio that's guaranteed to be impressive — no matter what you put into it.
+
+<!--projects-->
+
+
+## A Printable Resume
+Get a resume that's consistent across the board — whether it's on the web, mobile, print, or [PDF](assets/Resume.pdf).
+
+![Resume PDF](assets/img/resume.png)
+Front and center page of a print resume generated by Hydejack.
+
+
+
+## Just Markup
+**Hydejack** boasts a plethora of modern JavaScript, but make no mistake: It's still a plain old *web page* at its core. It works without JavaScript, and you can even view it in a text-based browser like `w3m`:
+
+![w3m Screenshot](assets/img/w3m.png)
+The Hydejack blog, as seen by the text browser `w3m`.
+
+
+## Syntax Highlighting
+**Hydejack** features syntax highlighting, powered by [Rouge].
+
+```js
+document.getElementsByTagName("hy-push-state")[0].addEventListener("hy-push-state-load", function() {
+  // <your init code>
+});
+```
+
+
+## Beautiful Math
+They say math is beautiful — and with **Hydejack**'s [math support][latex] it's also guaranteed to *look* beautiful.
+
+![Math Screenshot](assets/img/example-content-iii.jpg)
+Hydejack uses KaTeX to efficiently render math.
+
+
+<!-- $$
+\begin
+  \phi(x,y) &= \phi \left(\sum_^n y_je_j \right) \\[2em]
+            &= \sum_^n x_i y_j \phi(e_i, e_j)            \\[2em]
+            &= (x_1, \ldots, x_n)
+               \left(\begin
+                 \phi(e_1, e_1)  & \cdots & \phi(e_1, e_n) \\
+                 \vdots          & \ddots & \vdots         \\
+                 \phi(e_n, e_1)  & \cdots & \phi(e_n, e_n)
+               \end\right)
+               \left(\begin
+                 y_1    \\
+                 \vdots \\
+                 y_n
+               \end\right)
+\end
+$$ -->
+
+
+## Build an Audience
+The PRO version has built-in support for customizable [Tinyletter] newsletter subscription boxes.
+
+If you are using a different service like MailChimp, you can build a custom newsletter subscription box using [Custom Forms][forms].
+
+
+
+
+## A Personal Site That Belongs to You
+**Hydejack** is 100% built on Open Source software, and is Open Source itself, save for parts of the PRO version. The PRO version is a one-time payment that gives you the right to use it forever.
 
-## Demo
-It's best to just [see it in action](https://qwtel.com/hydejack/).
 
 ## Features
-Both versions include these features:
+An incomplete list of features included in all versions of **Hydejack**:
 
 * Full in-app page loading, powered by [hy-push-state]
-* A customizable sidebar that turns into a drawer menu on mobile, powered by [hy-drawer]
+* Customizable sidebar and touch-enabled drawer menu, powered by [hy-drawer]
+* Lazy image loading with cancellation and placeholder, powered by [hy-img]
 * Advanced FLIP animations, inspired by Material Design
-* Good [Google PageSpeed Score][gpss][^3]
-* Higher *perceived speed* thanks to content pre-fetching
-* [Syntax highlighting][syntax], powered by [Rouge]
+* 99/100 [Google PageSpeed Score][gpss][^2]
+* [Syntax highlighting](#syntax-highlighting), powered by [Rouge]
 * [LaTeX math blocks][latex], powered by [KaTeX]
 * Change the wording of built-in strings and possibly translate in other languages
 * Support for categories and tags
 * Built-in icons for many social networks
-* Simple and semantic HTML — can be viewed even with text-based browsers
+* Simple and semantic HTML
+* Structured Data for core entities
 * Author section below each article and support for multiple authors
-* Progressive enhancement — sacrifice features, not content
 * Google Analytics and Google Fonts support
 * Disqus comments
-* Print layout — Used to render Hydejack's [PDF documentation][pdf]
-* Blog layout via `jekyll-paginate` (optional)
-* SEO meta tags via `jekyll-seo-tag` (optional)
-* Github avatars via `jekyll-avatar` (optional)
-* Gist support via `jekyll-gist` (optional)
+* Optional cookies banner
 
-## Documentation
-Hydejack is well documented. You can read the docs [on the Jekyll site][docs], or [on GitHub][wiki], or [download the PDF][pdf].
 
 ## Download
-There are two versions of **Hydejack**: The *free version* includes basic blogging functionality,
-as did previous versions of the theme.
+There are two versions of **Hydejack**: The *free version* includes basic blogging functionality, as did previous versions of the theme.
 The *PRO version* includes additional features for professionals:
-A [portfolio], a [resume] layout and a [welcome] page to feature your favorite projects and posts.
-
-This table details what is and isn't included in each respective version.
-
-|                                     | Free                                   | PRO                                          |
-|:------------------------------------|:--------------------------------------:|:--------------------------------------------:|
-| Blog                                | &#x2714;                               | &#x2714;                                     |
-| [Features][feat]                    | &#x2714;                               | &#x2714;                                     |
-| [Portfolio] Layout                  |                                        | &#x2714;                                     |
-| [Resume] Layout                     |                                        | &#x2714;                                     |
-| [Welcome] Layout                    |                                        | &#x2714;                                     |
-| [Newsletter Box][news]              |                                        | &#x2714;                                     |
-| [Custom Forms][forms]               |                                        | &#x2714;                                     |
-| No Hydejack Branding                |                                        | &#x2714;                                     |
-| License                             | [GPL-3.0][license]                     | [PRO]                                        |
-| Source                              | [GitHub][src]                          | Included                                     |
-| Support[^1]                         | No                                     | No                                           |
-| Price                               | Free                                   | $29                                          |
-|                                     | [**Download**][kit]                    | [**Buy Now - $29**][buy] [^2]                |
-{:.stretch-table}
+A [portfolio], a [resume] layout, and a [welcome] page to highlight your favorite projects and posts.
+
+This table below shows what's included in each version:
+
+|                        | Free           | PRO      |
+|:-----------------------|:--------------:|:--------:|
+| Blog                   | &#x2714;       | &#x2714; |
+| [Features]             | &#x2714;       | &#x2714; |
+| [Portfolio]            |                | &#x2714; |
+| [Resume]               |                | &#x2714; |
+| [Welcome]              |                | &#x2714; |
+| [Newsletter Box][news] |                | &#x2714; |
+| [Custom Forms][forms]  |                | &#x2714; |
+| No Hydejack Branding   |                | &#x2714; |
+| License                | [GPL-3.0][lic] | [PRO]    |
+| Source                 | [GitHub][src]  | Included |
+| Support[^1]            | No             | No       |
+| Price                  | Free           | $59      |
+| | [**Download**][kit] | [**Buy PRO**][buy] |
+
 
 [^1]: You MAY open an issue on GitHub, but no response and/or fix is guaranteed.
-      You understand that using Jekyll requires technical know-how, and is NOT comparable to Wordpress in terms of usability.
-      Please use the free version to confirm that Hydejack works for you.
-      For more, see the [PRO] license.
-
-[^2]: Transactions secured by [Stripe](https://stripe.com). Downloads handled by [Simple Goods](https://simplegoods.co/).  
-
-[^3]: Actual page load speed depends on your hosting provider, resolution of embedded images and usage of 3rd party plugins.  
-
-~~~
- __  __                __                                     __
-/\ \/\ \              /\ \             __                    /\ \
-\ \ \_\ \   __  __    \_\ \      __   /\_\      __       ___ \ \ \/'\
- \ \  _  \ /\ \/\ \   /'_` \   /'__`\ \/\ \   /'__`\    /'___\\ \ , <
-  \ \ \ \ \\ \ \_\ \ /\ \L\ \ /\  __/  \ \ \ /\ \L\.\_ /\ \__/ \ \ \\`\
-   \ \_\ \_\\/`____ \\ \___,_\\ \____\ _\ \ \\ \__/.\_\\ \____\ \ \_\ \_\
-    \/_/\/_/ `/___/> \\/__,_ / \/____//\ \_\ \\/__/\/_/ \/____/  \/_/\/_/
-                /\___/                \ \____/
-                \/__/                  \/___/
-~~~
-
-[blog]: https://qwtel.com/hydejack/blog/
-[portfolio]: https://qwtel.com/hydejack/variations/
-[resume]: https://qwtel.com/hydejack/resume/
-[download]: https://qwtel.com/download/
-[welcome]: https://qwtel.com/hydejack/
-[forms]: https://qwtel.com/hydejack/forms-by-example/
-
-[feat]: https://qwtel.com/hydejack/#features
-[news]: https://qwtel.com/hydejack/#newsletter-subscription-box
-[syntax]: https://qwtel.com/hydejack/#syntax-highlighting
-[latex]: https://qwtel.com/hydejack/#latex-math-blocks
-
-[license]: LICENSE.md
+      You understand that using Jekyll requires technical know-how and is not comparable to Wordpress in terms of ease of use. Please use the free version to confirm that Hydejack works for you. For details, see the [PRO] license.
+
+[^2]: Actual page load speed depends on your hosting provider, resolution of embedded images and usage of 3rd party plugins.
+
+[blog]: https://hydejack.com/blog/
+[portfolio]: https://hydejack.com/projects/
+[resume]: https://hydejack.com/resume/
+[download]: https://hydejack.com/download/
+[welcome]: https://hydejack.com/
+[forms]: https://hydejack.com/forms-by-example/
+
+[features]: #features
+[news]: #build-an-audience
+[syntax]: #syntax-highlighting
+[latex]: hydejack/_posts/2018-06-01-example-content-iii.md#math
+
+[lic]: LICENSE.md
 [pro]: licenses/PRO.md
-[docs]: docs/7.5.2/index.md
+[docs]: docs/8.0.0/README.md
 
-[kit]: https://github.com/qwtel/hydejack-starter-kit/archive/v7.5.2.zip
+[kit]: https://github.com/qwtel/hydejack-starter-kit/archive/v8.0.0.zip
 [src]: https://github.com/qwtel/hydejack
-[git]: https://github.com/qwtel/hydejack-starter-kit
 [gem]: https://rubygems.org/gems/jekyll-theme-hydejack
-[buy]: https://app.simplegoods.co/i/AQTTVBOE
+[buy]: https://app.simplegoods.co/i/NATYVLYT
 
-[gpss]: https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fqwtel.com%2Fhydejack%2F
-[wiki]: https://github.com/qwtel/hydejack/blob/master/docs/7.5.2/index.md
-[pdf]: https://github.com/qwtel/hydejack/releases/download/v7.5.2/Documentation._.Hydejack.pdf
+[gpss]: https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fhydejack.com%2F
 [hy-push-state]: https://qwtel.com/hy-push-state/
 [hy-drawer]: https://qwtel.com/hy-drawer/
+[hy-img]: https://qwtel.com/hy-img/
 [rouge]: http://rouge.jneen.net
 [katex]: https://khan.github.io/KaTeX/
 [tinyletter]: https://tinyletter.com/

data/_includes/body/analytics.html

@@ -0,0 +1,36 @@
+{% if site.google_analytics %}
+  <script>
+    window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
+
+    /*{% if site.hydejack.cookies_banner %}*/
+      if (navigator.CookiesOK) {
+        ga('create', '{{ site.google_analytics }}', 'auto');
+      } else if (document.cookie.indexOf("hy--cookies-ok=true") > -1) {
+        ga('create', '{{ site.google_analytics }}', {
+          'storage': 'none',
+          'clientId': localStorage ? localStorage.getItem('ga--client-id') : undefined
+        });
+      } else {
+        ga('create', '{{ site.google_analytics }}', {
+          'storage': 'none'
+        });
+        ga('set', 'forceSSL', true);
+        ga('set', 'anonymizeIp', true);
+      }
+    /*{% else %}*/
+      ga('create', '{{ site.google_analytics }}', 'auto');
+    /*{% endif %}*/
+
+    var pushStateEl = document.getElementsByTagName('hy-push-state')[0];
+    var timeoutId;
+    pushStateEl.addEventListener('hy-push-state-load', function() {
+      window.clearTimeout(timeoutId);
+      timeoutId = window.setTimeout(function() {
+        ga('set', 'page', window.location.pathname);
+        ga('send', 'pageview');
+      }, 500);
+    });
+
+    window.loadJSDeferred('https://www.google-analytics.com/analytics.js');
+  </script>
+{% endif %}

data/_includes/{footer.html → body/footer.html}

@@ -1,3 +1,4 @@
+{% if site.copyright.size > 0 or site.legal.size > 0 or site.hydejack.advertise %}
 <footer role="contentinfo">
   <hr/>
   {% if site.copyright.size > 0 %}
@@ -6,11 +7,12 @@
   {% if site.legal.size > 0 %}
     <nav class="legal"><small>
     {% for le in site.legal %}
-      <a href="{% include smart-url url=le.href %}">{{ le.name | default:le.title }}</a>
+      <a class="heading flip-title" href="{% include smart-url.txt url=le.href %}">{{ le.name | default:le.title }}</a>
       {% unless forloop.last %}{{ site.data.strings.separator | default:'|' }}{% endunless %}
     {% endfor %}
     </small></nav>
   {% endif %}
-  <p><small>Powered by <a class="external" href="https://qwtel.com/hydejack/">Hydejack</a> v<span id="_version">7.5.2</span></small></p>
+  <p><small>Powered by <a class="external" href="https://hydejack.com/">Hydejack</a> v<span id="_version">8.0.0</span></small></p>
   <hr class="sr-only"/>
 </footer>
+{% endif %}

data/_includes/body/index.html

@@ -0,0 +1,22 @@
+{% include body/menu.html %}
+
+<hy-push-state
+  replace-ids="_main"
+  link-selector="a[href]:not([href*='/assets/']):not(.external):not(.no-push-state)"
+  duration="250"
+  script-selector="script:not([type^='math/tex'])"
+  prefetch
+>
+  {% if page.cover %}
+    {% include body/sidebar.html %}
+    {% include body/main.html %}
+  {% else %}
+    {% include body/main.html %}
+    {% include body/sidebar.html %}
+  {% endif %}
+</hy-push-state>
+
+{% include body/scripts.html %}
+{% include my-body.html %}
+
+{% include templates/index.html %}

data/_includes/body/main.html

@@ -0,0 +1,18 @@
+<main
+  id="_main"
+  class="content fade-in layout-{{ page.layout }}"
+  role="main"
+  data-color="{{ color | escape }}"
+  data-theme-color="{{ theme_color | escape }}"
+  {% unless image.background %}
+    data-image="{% if image == 'none' %}none{% else %}{% capture tmp %}{% include smart-url.txt url=image %}{% endcapture %}{{ tmp | escape }}{% endif %}"
+    {% if image != 'none' %}data-overlay{% endif %}
+  {% else %}
+    data-background="{{ image.background | escape }}"
+    {% if image.overlay %}data-overlay{% endif %}
+  {% endunless %}
+  >
+  {{ content }}
+  {% include body/comments.html %}
+  {% include body/footer.html %}
+</main>

data/_includes/{menu.html → body/menu.html}

@@ -9,3 +9,4 @@
     </div>
   </div>
 </div>
+<hr class="sr-only" hidden />

data/_includes/body/scripts.html

@@ -0,0 +1,22 @@
+{% unless page.redirect %}
+  <!--[if gt IE 9]><!---->
+  <script>window.loadJSDeferred(document.getElementById('_hrefJS').href);</script>
+  {% include my-scripts.html %}
+  <!--<![endif]-->
+
+  {% include body/analytics.html %}
+
+  <script>
+    if ('serviceWorker' in navigator) {
+      {% if site.hydejack.offline.enabled %}
+        navigator.serviceWorker.register('{{ "sw.js" | relative_url }}')
+          .then(r => r.update())
+          .catch(() => {});
+      {% else %}
+        navigator.serviceWorker.getRegistration()
+          .then(r => r.unregister())
+          .catch(() => {});
+      {% endif %}
+    }
+  </script>
+{% endunless %}

data/_includes/{sidebar.html → body/sidebar.html}

@@ -1,17 +1,29 @@
-<hy-drawer>
+<hy-drawer
+  class="{% if page.cover %}cover{% endif %}"
+  align="left"
+  threshold="10"
+  touch-events
+  prevent-default
+>
   <header id="_sidebar" class="sidebar" role="banner">
     {% if image.background %}
       {% capture bg_style %}background:{{ image.background }}{% endcapture %}
       {% capture bg_class %}sidebar-bg {% if image.overlay %}sidebar-overlay{% endif %}{% endcapture %}
     {% else %}
-      {% capture bg_style %}background-color:{{ color }};{% if image != 'none' %}background-image:url({% include smart-url url=image %}){% endif %}{% endcapture %}
+      {% assign bg_color = page.theme_color | default:site.theme_color | default:color %}
+      {% capture bg_style %}background-color:{{bg_color}};{% if image != 'none' %}background-image:url({% include smart-url.txt url=image %}){% endif %}{% endcapture %}
       {% capture bg_class %}sidebar-bg {% if image != 'none' %}sidebar-overlay{% endif %}{% endcapture %}
     {% endif %}
-    <div class="{{ bg_class }}" style="{{ bg_style }}"></div>
+    <div class="{{bg_class}}" style="{{bg_style}}"></div>
 
     <div class="sidebar-sticky">
       <div class="sidebar-about">
-        <h2 class="h1"><a href="{{ '/' | relative_url }}">{{ site.title }}</a></h2>
+        {% if site.logo %}
+          <a class="no-hover" href="{{ '/' | relative_url }}" tabindex="-1">
+            <img src="{{ site.logo | relative_url }}" class="avatar" alt="{{ site.short_title | default:site.title }}" re-ignore />
+          </a>
+        {% endif %}
+        <h2 class="h1"><a href="{{ '/' | relative_url }}">{{ site.short_title | default:site.title }}</a></h2>
         {% assign text = site.tagline | default:site.description %}
         {% if text %}
           <p class="{% if text.size > 100 %}fine{% endif %}">
@@ -21,14 +33,15 @@
       </div>
 
       <nav class="sidebar-nav heading" role="navigation">
-        {% include nav.html %}
+        {% include body/nav.html %}
       </nav>
 
       {% assign author = site.data.authors.first[1] | default:site.author %}
 
       <div class="sidebar-social">
-        {% include social.html author=author %}
+        {% include components/social.html author=author %}
       </div>
     </div>
   </header>
 </hy-drawer>
+<hr class="sr-only" hidden />