jekyll-theme-yat 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0954d4c51777697199a54a66a627b3cc90409d59848d14df4abb9764dda0d2e8'
-  data.tar.gz: ce60f95ab927cc5906660ab535d4b7cfdafa7184880fe0f1e51937e824626ee4
+  metadata.gz: aa66b045f81c89271c8b0253f29ed221e4a244f141eb8647ced39b6339c2ca1f
+  data.tar.gz: 4f16a912676e9c3e8ff15958921243395e6293800459b791b0051ffd51956fcf
 SHA512:
-  metadata.gz: dd5cfab85c8b5bf0ad083288b9a5c59b49d99e51b3bb6927e2d8c24870721734290333d71a8f295bd780913ecf59516d005914b9567f64562b47456801694e1a
-  data.tar.gz: e990d15e9c98b43d10e4e274d5a26130a3e980cdd579a35b20406a8b5a4c21d6e8d9cf58bd0d52ccb63149f13083fb4a86ec12e486db5a7397d0dde16c26eabb
+  metadata.gz: 2fd2e3ddd8c4d0925d6fb1fd4c97a1cf9d18f18c0ce883bef1eaa8420e495a4a0b9cd81e8d935a072d41dbb3a3798f16fce205273b652ec052348698c640688e
+  data.tar.gz: 42e7b333888f073f3d80fb079cc089758300c5491b575109f6f53dd1f4147219482cd26aa60779daa69fb8bc7f9e847c9debddbc51da81f40635840f3230b1d9

data/README.md

@@ -1,11 +1,39 @@
 # jekyll-theme-yat
+[![Github Pages](https://github.com/jeffreytse/jekyll-theme-yat/workflows/Github%20Pages/badge.svg)](https://jeffreytse.github.io/jekyll-theme-yat)
+[![Gem Version](https://badge.fury.io/rb/jekyll-theme-yat.svg)](http://badge.fury.io/rb/jekyll-theme-yat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+[![Donate (Liberapay)](http://img.shields.io/liberapay/goal/jeffreytse.svg?logo=liberapay)](https://liberapay.com/jeffreytse)
+[![Donate (Patreon)](https://img.shields.io/badge/support-patreon-F96854.svg?style=flat-square)](https://patreon.com/jeffreytse)
+<a href="https://ko-fi.com/jeffreytse">
+  <img height="20" src="https://www.ko-fi.com/img/githubbutton_sm.svg"
+    alt="Donate (Ko-fi)" />
+</a>
 
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme is a modern theme, and it's quiet clear, clean and neat for writers and posts.
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
 
-TODO: Delete this and the text above, and describe your gem
+<p align="center">
 
+  <img src="https://user-images.githubusercontent.com/9413601/91711123-f169b280-ebb7-11ea-8f5e-0867c713cdfc.png" alt="demo-screenshot" width="720px"/>
+
+</p>
+
+## Features
+
+- Full layouts `home`, `post`, `tags`, `archive` and `about`.
+- Uses font awesome 5 for icons.
+- Beautiful Syntax Highlight using [hilight.js][hilight-js].
+- RSS support using [Jekyll Feed][jekyll-feed] gem.
+- Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem.
+- Sitemap support using [Jekyll Sitemap][jekyll-sitemap] gem.
+- Complex and flexible table support using [Jekyll Spaceship][jekyll-spaceship] gem.
+- MathJAX and LaTeX optional support using [Jekyll Spaceship][jekyll-spaceship] gem.
+- Media (Youtube, Spotify, etc.) support using [Jekyll Spaceship][jekyll-spaceship] gem.
+- Diagram (PlantUML, Mermaid) support using [Jekyll Spaceship][jekyll-spaceship] gem.
+- Google Translation support.
+- New post tag support.
+
+Also, visit the live [demo][yat-live-demo] site for the theme.
 
 ## Installation
 
@@ -31,11 +59,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+Add or update your available layouts, includes, sass and/or assets.
 
-## Contributing
+GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/).
+To use the third-party gem in GitHub Pages without limitation:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jeffreytse/jekyll-theme-yat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+* Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
 
 ## Development
 
@@ -46,7 +75,22 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 When your theme is released, only the files in `_data`, `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
 To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-yat.gemspec` accordingly.
 
-## License
+## Contributing
+
+Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
 
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+You can start by [opening an issue](https://github.com/jeffreytse/jekyll-theme-yat/issues/new) describing the problem that you're looking to resolve and we'll go from there.
+
+## License
 
+This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.
+
+<!-- External links -->
+[jekyll]: https://jekyllrb.com/
+[yat-git-repo]: https://github.com/jeffreytse/jekyll-theme-yat/
+[yat-live-demo]: https://jeffreytse.github.io/jekyll-theme-yat/
+[jekyll-spaceship]: https://github.com/jeffreytse/jekyll-spaceship
+[jekyll-seo-tag]: https://github.com/jekyll/jekyll-seo-tag
+[jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap
+[jekyll-feed]: https://github.com/jekyll/jekyll-feed
+[hilight-js]: https://github.com/highlightjs/highlight.js

data/_data/translate_langs.yml

@@ -13,10 +13,6 @@
   img: https://www.countryflags.io/cn/flat/64.png
   text: Chinese(Simple)
 
-- lang: zh-TW
-  img: https://www.countryflags.io/tw/flat/64.png
-  text: Chinese(Traditional)
-
 - lang: ja
   img: https://www.countryflags.io/jp/flat/64.png
   text: Japan

data/_includes/functions/get_reading_time.html

@@ -0,0 +1,41 @@
+{% if include.article %}
+  {% assign article = include.article %}
+{% endif %}
+
+{% if include.speed %}
+  {% assign speed = include.speed %}
+{% else %}
+  {% assign speed = 160 %}
+{% endif %}
+
+{% assign total_mins = article
+  | number_of_words
+  | divided_by: speed
+  | at_least: 1 %}
+
+{% assign hours = total_mins | divided_by: 60 %}
+{% assign mins = total_mins | modulo: 60 %}
+
+{% assign return = "About" %}
+
+{% if hours > 0 %}
+  {% assign unit = "hour" %}
+  {% if hours > 1 %}
+    {% assign unit = unit | append: "s" %}
+  {% endif %}
+  {% assign return = return
+    | append: " "
+    | append: hours
+    | append: " "
+    | append: unit %}
+{% endif %}
+
+{% assign unit = "min" %}
+{% if mins > 1 %}
+  {% assign unit = unit | append: "s" %}
+{% endif %}
+{% assign return = return
+  | append: " "
+  | append: mins
+  | append: " "
+  | append: unit %}

data/_includes/head.html

@@ -6,10 +6,17 @@
   {%- seo -%}
   <link rel="shortcut icon" href="{{ site.favicon }}">
   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/typeface-noto-sans@0.0.72/index.min.css">
+  <link rel="stylesheet"
+        href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/default.min.css">
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
+  <!-- and it's easy to individually load additional languages -->
+  <script charset="UTF-8"
+          src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/languages/go.min.js"></script>
   <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}">
   <script src="{{ "/assets/js/main.js" | relative_url }}"></script>
   {%- feed_meta -%}
   {%- if jekyll.environment == 'production' and site.google_analytics -%}
-    {%- include extensions/google-analytics.html -%}
+  {%- include extensions/google-analytics.html -%}
   {%- endif -%}
 </head>

data/_includes/sidebar/article-menu.html

@@ -7,7 +7,7 @@
 </style>
 
 <div class="post-menu">
-  <div class="post-menu-title">Contents</div>
+  <div class="post-menu-title">TOC</div>
   <div class="post-menu-content"></div>
 </div>
 
@@ -36,10 +36,54 @@
     // The header element
     var header = document.querySelector('header.site-header');
 
+    function doMenuCollapse(index, over_items=20) {
+      var items = menuContent.firstChild.children;
+
+      if (items.length < over_items) {
+        return;
+      }
+
+      var activeItem = items[index];
+      var beginItem = activeItem
+      var endItem = activeItem
+      var beginIndex = index;
+      var endIndex = index + 1;
+      while (beginIndex >= 0
+        && !items[beginIndex].classList.contains('h-h2')) {
+        beginIndex -= 1;
+      }
+      while (endIndex < items.length
+        && !items[endIndex].classList.contains('h-h2')) {
+        endIndex += 1;
+      }
+      for (var i = 0; i < beginIndex; i++) {
+        item = items[i]
+        if (!item.classList.contains('h-h2')) {
+          item.style.display = 'none';
+        }
+      }
+      for (var i = beginIndex + 1; i < endIndex; i++) {
+        item = items[i]
+        // if (!item.classList.contains('h-h2')) {
+          item.style.display = '';
+        // }
+      }
+      for (var i = endIndex; i < items.length; i++) {
+        item = items[i]
+        if (!item.classList.contains('h-h2')) {
+          item.style.display = 'none';
+        }
+      }
+    }
+
+    // Init menu collapsed
+    doMenuCollapse(-1);
+
     // Active the menu item
     window.addEventListener('scroll', function (event) {
       var lastActive = menuContent.querySelector('.active');
       var changed = true;
+      var activeIndex = -1;
       for (var i = headings.length - 1; i >= 0; i--) {
         var h = headings[i];
         var headingRect = h.getBoundingClientRect();
@@ -49,9 +93,11 @@
         var headerHeight = headerTop + headerHeight + 20;
         if (headingRect.top <= headerHeight) {
           var id = 'h-' + h.getAttribute('id');
-          var curActive = menuContent.querySelector('a[href="#' + id  + '"]');
+          var a = menuContent.querySelector('a[href="#' + id  + '"]');
+          var curActive = a.parentNode;
           if (curActive) {
             curActive.classList.add('active');
+            activeIndex = i;
           }
           if (lastActive == curActive) {
             changed = false;
@@ -59,8 +105,11 @@
           break;
         }
       }
-      if (lastActive && changed) {
-        lastActive.classList.remove('active');
+      if (changed) {
+        if (lastActive) {
+          lastActive.classList.remove('active');
+        }
+        doMenuCollapse(activeIndex);
       }
       event.preventDefault();
     });

data/_includes/views/banner.html

@@ -19,20 +19,9 @@
 {% assign subheading = return %}
 
 {% if banner %}
-
-  {% assign auto_banner = true %}
-  {% assign array = banner | split: '/' %}
-  {% assign protocol = array[0]  %}
-
-  {% if array.size > 1 and (protocol == '' or protocol == 'http:' or protocol == 'https:') %}
-    {% assign auto_banner = false %}
-  {% endif %}
-
   <section class="page-banner">
     <div class="page-banner-img">
-      {%- if auto_banner == false -%}
-        <div style="background-image: url({{ banner }})"></div>
-      {%- endif  -%}
+      <div style="background-image: url({{ banner | relative_url }})"></div>
     </div>
     <div class="wrapper">
       <div class="page-banner-inner">
@@ -48,36 +37,14 @@
             <h1 class="page-banner-heading">
               {{ heading | default: page.title | escape }}
             </h1>
-            <h3 class="page-banner-subheading">
+            <h2 class="page-banner-subheading">
               {{ subheading | default: page.subtitle | escape }}
-            </h3>
+            </h2>
           </div>
 
         {%- endif -%}
       </div>
     </div>
   </section>
-
-  {%- if auto_banner -%}
-
-    {%- assign selector = ".page-banner-img" -%}
-
-    {%- if banner == "default" -%}
-
-      {%- assign heading = page.heading | default: page.title | escape -%}
-      {%- assign subheading = page.subheading | default: page.subtitle | escape -%}
-      {%- assign seed = page.date | append: heading | append: subheading -%}
-
-    {%- else -%}
-
-      {%- assign seed = 'theme-' | append: banner -%}
-
-    {%- endif -%}
-
-    {%- assign zoom = 1.5 -%}
-    {%- include extensions/trianglify.html -%}
-
-  {%- endif -%}
-
 {%- endif -%}
 

data/_includes/views/header.html

@@ -7,7 +7,7 @@
 {%- include functions.html func='log' level='debug' msg='Get header_transparent value' -%}
 {% assign name = 'header_transparent' %}
 {%- include functions.html func='get_value' -%}
-{% assign header_transparent = return %}
+{% assign header_transparent = return | default: true %}
 
 {%- if banner and header_transparent -%}
   {%- assign header_transparent_class = "site-header-transparent" -%}
@@ -39,9 +39,7 @@
             {%- for path in page_paths -%}
               {%- assign my_page = site.pages | where: "path", path | first -%}
               {%- if my_page.title -%}
-              <a class="page-link" href="{{ my_page.url | relative_url }}">
-                {{ my_page.title | upcase | escape }}
-              </a>
+              <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | upcase | escape }}</a>
               {%- endif -%}
             {%- endfor -%}
 

data/_includes/views/pagination.html

@@ -11,16 +11,29 @@
     {%- for post in paginator.posts -%}
     <li>
       {%- assign date_format = site.yat.date_format | default: "%b %-d, %Y" -%}
-      <span class="post-meta">{{ post.date | date: date_format }}</span>
-      <h3>
+
+      {% assign article = post.content %}
+      {%- include functions.html func='get_reading_time' -%}
+      {% assign reading_time = return %}
+
+      <h2 class="post-title">
         {%- assign post_url = post.url | relative_url -%}
         <a class="post-link" href="{{ post_url }}">
           {{ post.title | escape }}
         </a>
-      </h3>
+      </h2>
+      <div class="post-meta">
+        <span class="post-date"><i class="fa fa-calendar"></i> {{ post.date | date: date_format }}</span>
+        <span class="post-reading-time left-vsplit"><i class="fa fa-clock-o"></i> {{ reading_time }}</span>
+      </div>
       <p class="post-excerpt">
         {{ post.content | strip_html | truncatewords: 50 }}
       </p>
+      <div class="post-tags">
+        {%- for tag in post.tags -%}
+        <a class="post-tag" href="/tags.html#{{tag}}">#{{tag}}</a>
+        {%- endfor -%}
+      </div>
     </li>
     {%- endfor -%}
   </ul>

data/_includes/views/paginator.html

@@ -3,19 +3,23 @@
 {% endif %}
 
 {% if paginator.posts.size > 0 %}
-  <div class="pagination">
+  <div class="paginator">
+    <span class="previous">
     {% if paginator.previous_page %}
-      <a href="{{ paginator.previous_page_path }}">&laquo; Prev</a>
+      <a href="{{ paginator.previous_page_path }}">Prev</a>
     {% else %}
-      <span>&laquo; Prev</span>
+      <span>Prev</span>
     {% endif %}
+    </span>
 
-    <span> {{ paginator.page }}/{{ paginator.total_pages }}</span>
+    <span class="indicator"> {{ paginator.page }}/{{ paginator.total_pages }}</span>
 
+    <span class="next">
     {% if paginator.next_page %}
-      <a href="{{ paginator.next_page_path }}">Next &raquo;</a>
+      <a href="{{ paginator.next_page_path }}">Next</a>
     {% else %}
-      <span>Next &raquo;</span>
+      <span>Next</span>
     {% endif %}
+    </span>
   </div>
 {% endif %}

data/_includes/views/post-header.html

@@ -1,11 +1,25 @@
 <header class="post-header">
   <h1 class="post-title p-name" itemprop="name headline">{{ heading | default: page.title | escape }}</h1>
-  <h3>{{ subheading | default: page.subtitle | escape }}</h3>
+  <h3 class="post-subtitle">{{ subheading | default: page.subtitle | escape }}</h3>
 
   <p class="post-meta">
     <time class="dt-published" datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
       {%- assign date_format = site.yat.date_format | default: "%b %-d, %Y" -%}
-      {{ page.date | date: date_format }}
+      <i class="fa fa-calendar"></i> {{ page.date | date: date_format }}
     </time>
+
+    {% assign article = page.content %}
+    {%- include functions.html func='get_reading_time' -%}
+    {% assign reading_time = return %}
+    <span class="post-reading-time left-vsplit"><i class="fa fa-clock-o"></i> {{ reading_time }}</span>
   </p>
+
+  {%- if page.tags.size > 0 -%}
+  <div class="post-tags">
+    {%- for tag in page.tags -%}
+    <a class="post-tag" href="/tags.html#{{tag}}">#{{tag}}</a>
+    {%- endfor -%}
+  </div>
+  {%- endif -%}
+
 </header>

data/_layouts/about.html

@@ -0,0 +1,9 @@
+---
+layout: post
+hidden:
+  - header
+  - navigator
+  - related_posts
+---
+
+{{ content }}

data/_layouts/post.html

@@ -1,7 +1,8 @@
 ---
 layout: framework
-banner: 'default'
+banner:
 banner_html: post-header.html
+hidden: []
 sidebar:
   - article-menu
 ---
@@ -13,39 +14,64 @@ sidebar:
     {%- include functions.html func='get_value' -%}
     {%- assign banner = return -%}
 
-    {%- if banner == nil -%}
+    {%- assign name = 'hidden' -%}
+    {%- include functions.html func='get_value' -%}
+    {%- assign hidden = return -%}
+
+    {%- assign result = hidden | where_exp: "item", "item == 'header'" -%}
+    {%- if banner == nil and result.size == 0 -%}
     {%- include views/post-header.html -%}
     {%- endif -%}
 
     {%- include views/article.html -%}
 
+    {%- assign result = hidden | where_exp: "item", "item == 'navigator'" -%}
+    {%- if result.size == 0 -%}
     <div class="post-nav">
       {%- if page.previous -%}
-      <a href="{{ page.previous.url }}" title="{{ page.previous.title | escape }}">&laquo; Prev</a>
+        <a class="previous" href="{{ page.previous.url }}" title="{{
+          page.previous.title | escape }}">{{ page.previous.title | escape | truncatewords: 6 }}</a>
       {%- else -%}
       <span></span>
       {%- endif -%}
 
       {%- if page.next -%}
-      <a href="{{ page.next.url }}" title="{{ page.next.title | escape }}">Next &raquo;</a>
+        <a class="next" href="{{ page.next.url }}" title="{{ page.next.title | escape }}">{{ page.next.title | escape | truncatewords: 6 }}</a>
       {%- else -%}
       <span></span>
       {%- endif -%}
     </div>
-
-    {%- if page.comments != false -%}
-
-    {%- if site.disqus.shortname -%}
-    {%- include extensions/comments/disqus.html -%}
     {%- endif -%}
 
-    {%- if site.gitment.username -%}
-    {%- include extensions/comments/gitment.html -%}
+    {%- assign result = hidden | where_exp: "item", "item == 'related_posts'" -%}
+    {%- if result.size == 0 -%}
+    <div class="post-related">
+      <div>Related Articles</div>
+      <ul>
+        {% assign posts = site[page.collection] | sample:4 %}
+        {%- for post in posts -%}
+        <li><a class="post-link" href="{{post.url}}" title="{{ page.next.title | escape }}">{{ post.title | escape | truncatewords: 12 }}</a></li>
+        {%- endfor -%}
+      </ul>
+    </div>
     {%- endif -%}
 
+    {%- assign result = hidden | where_exp: "item", "item == 'comments'" -%}
+    {%- if result.size == 0 -%}
+    <div class="post-comments">
+      {%- if page.comments != false -%}
+
+      {%- if site.disqus.shortname -%}
+      {%- include extensions/comments/disqus.html -%}
+      {%- endif -%}
+
+      {%- if site.gitment.username -%}
+      {%- include extensions/comments/gitment.html -%}
+      {%- endif -%}
+
+      {%- endif -%}
+    </div>
     {%- endif -%}
 
   </section>
 </div>
-
-