jekyll-theme-yat 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b89d81bb145293e81ec3ce978f1edd21f7fc3d6f415582cfa96162f9f56db586
-  data.tar.gz: 99a004e736ff24d67ea6e89f54b8cc166c6551517892d44660fdcaeec48152be
+  metadata.gz: 33ad64189dbb0e80834f1dec85a7327ea7fac4a20dcad45adfac9da1265a2ff6
+  data.tar.gz: e927ef2806d2d939b8c61e3fd0f7247a285d0d1d131177859a6516beba2d225b
 SHA512:
-  metadata.gz: c75c4559995c0fe4766848031f1bc8d02335674e474e54fe1ffacaa6c7dafca04db93c8d277eae42169d3bea9f8c9cf7fecd6f10d7c5c13d7a172e4b62c0c034
-  data.tar.gz: 82379c7e536507ac69df959573ff951cae42e36a023b7a9833a067736275500879bceb98507704f08f231cbd5d15c0690b28126e4dcc694a10364e86d89bb4c6
+  metadata.gz: 4ff46c013cf3e91f16542c871168641961d0949e0a4afa4112defb1c52a3ccdd76e0986efcab2ca9aa323deb69460dc4e92c8894997b07605395ae296af72ab8
+  data.tar.gz: 64cc10e3dde27ec64395fc0527f10c94f84b1f14b40d455b433faf3ed01c069d8bd3d94bea5471d0604127a27e4db2694920c5a96b77d55d94f39bdd4ce9b1d0

data/README.md

@@ -46,6 +46,14 @@ Also, visit the [Live Demo][yat-live-demo] site for the theme.
 
 ## Installation
 
+There are three ways to install:
+
+- As a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes).
+- As a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible).
+- Forking/directly copying all of the theme files into your project.
+
+### Gem-based Theme Method
+
 Add this line to your Jekyll site's `Gemfile`:
 
 ```ruby
@@ -60,20 +68,53 @@ theme: jekyll-theme-yat
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install jekyll-theme-yat
+```bash
+$ gem install jekyll-theme-yat
+```
 
-## Usage
+### Remote Theme Method with GitHub Pages
 
-Add or update your available layouts, includes, sass and/or assets.
+Remote themes are similar to Gem-based themes, but do not require `Gemfile` changes or whitelisting making them ideal for sites hosted with GitHub Pages.
+
+To install:
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "github-pages", group: :jekyll_plugins
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+# theme: owner/name --> Don't forget to remove/comment the gem-based theme option
+remote_theme: "jeffreytse/jekyll-theme-yat"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## GitHub Pages without limitation
+
+GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins/themes](https://pages.github.com/versions/). __In other words, the third-party gems will not work normally__.
 
-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:
 
-* Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
+Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
+
+
+## Usage
+
+Add or update your available layouts, includes, sass and/or assets.
 
 ## Development
 

data/_includes/extensions/theme-toggle.html

@@ -9,6 +9,10 @@
   </label>
 </div>
 
+{%- assign name = 'night_mode' -%}
+{%- include functions.html func='get_value' default='auto' -%}
+{%- assign night_mode = return -%}
+
 <script>
   (function() {
     var sw = document.getElementById('theme-switch');
@@ -24,7 +28,7 @@
       try {
         data = JSON.parse(data ? data : '');
       } catch(e) {
-        data = { nightShift: null, autoToggleAt: 0 };
+        data = { nightShift: false, autoToggleAt: 0 };
         saveThemeData(data);
       }
       return data;
@@ -72,19 +76,28 @@
       };
     }
 
-    var data = autoThemeToggle();
-
     // Listen the theme toggle event
     sw.addEventListener('change', function(event) {
       handleThemeToggle(event.target.checked);
     });
 
-    // Toggle theme by local setting
-    if (data.toggleAt > themeData.autoToggleAt) {
-      themeData.autoToggleAt = data.toggleAt;
-      handleThemeToggle(data.nightShift);
-    } else {
+    var nightModeOption = '{{ night_mode }}';
+    nightModeOption = nightModeOption.toLowerCase();
+
+    if (nightModeOption == 'auto') {
+      var data = autoThemeToggle();
+
+      // Toggle theme by local setting
+      if (data.toggleAt > themeData.autoToggleAt) {
+        themeData.autoToggleAt = data.toggleAt;
+        handleThemeToggle(data.nightShift);
+      } else {
+        handleThemeToggle(themeData.nightShift);
+      }
+    } else if (nightModeOption == 'mannual') {
       handleThemeToggle(themeData.nightShift);
+    } else {
+      handleThemeToggle(nightModeOption == 'on');
     }
   })();
 </script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-yat
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - jeffreytse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-03 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -228,5 +228,6 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Yet another theme for elegant writers with modern flat style.
+summary: Yet another theme for elegant writers with modern flat style and beautiful
+  night/dark mode.
 test_files: []