jekflix 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f7e32eba02d7236470d9ecc5c2f4cb3b90fb411
-  data.tar.gz: fd73a72d2446ae09605ca43ece83e041c500091d
+SHA256:
+  metadata.gz: bcccca10845eee7df16c9998eeaa82de3ae0e8eb2990b533d63f1f723005e85c
+  data.tar.gz: 8ffdf60cb7bf138a2ffc181093d64c9370d0fdca6af56dc727ccf24a153da148
 SHA512:
-  metadata.gz: 2d8970d2064f7b2030e157bcc0ba8e315538ef324e5ae8c8393f51434d758e3ee1fa545c2ebb3b9e625eaf1cad8c00cc67939d0c2b1dc53b810a7e699e0cb03b
-  data.tar.gz: 61ff519658c08296abdd9de65534ada8bbe6d4d8b14687d60b04928a6d9996c523e509796b6acfc0ba3ae52f6930dfe63b041f78dc167e185d32b45da5cb02ab
+  metadata.gz: 5d716d2f1cd766331e86fd866e379d26754a60f3b1e1759a90f3dc9c7635e318244079102dd434b68cfaad7f25b97488ad861217b29b8a901f0afa1bf2849a36
+  data.tar.gz: e356b529774107591ea76c2c1d16829a684b85c2b2aeb7e2de17f7478570fa34fafda60d87bc203edbdb77bfb493b591d2df7a7cb295c977f6b4589bcbfed37c

data/README.md

@@ -37,6 +37,7 @@ A theme for Jekyll inspired by Netflix panel for who loves movies and series and
 - ["Before you go" modal](https://github.com/thiagorossener/jekflix-template/wiki/Features#before-you-go-modal) *(optional)*
 - [Post recommendation](https://github.com/thiagorossener/jekflix-template/wiki/Features#post-recommendation)
 - [Netlify CMS ready](https://github.com/thiagorossener/jekflix-template/wiki/Features#netlify-cms-ready)
+- [Translations](https://github.com/thiagorossener/jekflix-template/wiki/setup#translations) **new!**
 
 ## SEO
 
@@ -46,21 +47,158 @@ A theme for Jekyll inspired by Netflix panel for who loves movies and series and
 - Sitemap.xml
 - Social Media ready
 
+## Quick Install
+
+In the case you're installing to existing Jekyll project, add this line to your project's `Gemfile`:
+
+```
+gem "jekflix"
+```
+
+Add this line to your project's `_config.yml`:
+
+```
+theme: jekflix
+```
+
+And then run:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install jekflix
+```
+
+### Theme Colors
+
+Create the file `/assets/css/styles.scss` and add:
+
+```
+---
+---
+
+$themeColor: #ff0a16;
+$primaryDark: #141414;
+$accentDark: #ffffff;
+$lightGray: #f2f2f2;
+$texts: #333333;
+
+@import "jekflix";
+```
+
+Modify the variables above to change your theme colors.
+
+### Site configuration
+
+Below are some properties you can change in your project `_config.yml`, check the [documentation](https://github.com/thiagorossener/jekflix-template/wiki/settings) for more details.
+
+```
+# Site Settings
+name: Jekflix
+title: Jekflix | A blog theme for Jekyll
+description: Jekflix is a template for Jekyll inspired by Netflix and made by Thiago Rossener.
+tags:
+  - blog
+  - template
+  - jekyll
+  - theme
+  - netlify
+email: youremail@xyz.com
+disqus_username: disqus_username
+show_hero: true
+menu:
+  - title: Home
+    url: /
+  - title: About
+    url: /about
+  - title: Contact
+    url: /contact
+  - title: Feed
+    url: /feed.xml
+
+# Social Media Settings
+# Remove the item if you don't need it
+github_username: github_username
+facebook_username: facebook_username
+twitter_username: twitter_username
+instagram_username: instagram_username
+linkedin_username: linkedin_username
+medium_username: medium_username
+
+# Posts Settings
+show_time_bar: true
+show_modal_on_exit: false
+show_modal_on_finish_post: true
+two_columns_layout: true
+
+# Advanced Settings
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site
+google_analytics: "UA-XXXXXXXX-X"
+language: "en"
+categories_folder: category
+sent_message_url: "/contact/message-sent/"
+
+# Build settings
+markdown: kramdown
+highlighter: rouge
+permalink: /:title/
+collections:
+  authors:
+    output: true
+paginate_path: "/page/:num/"
+show_get_theme_btn: true
+use_logo: false
+
+# Content paginator
+paginate_content:
+  enabled: true
+  debug: false
+  collections:
+    - posts
+  auto: false
+  separator: "--page-break--"
+  permalink: "/:num/"
+  seo_canonical: true
+  properties:
+    part:
+      is_generated: true
+    last:
+      is_generated: true
+    single:
+      is_generated: true
+
+# SASS
+sass:
+  style: compressed
+
+# Plugins
+plugins:
+  - jekyll-paginate
+  - jekyll-paginate-content
+```
+
 ## Setup
 
+In the case you're cloning this repo, follow those instructions:
+
 - [Environment](https://github.com/thiagorossener/jekflix-template/wiki/setup#environment)
 - [Installing template](https://github.com/thiagorossener/jekflix-template/wiki/setup#installing-template)
 - [Running local](https://github.com/thiagorossener/jekflix-template/wiki/setup#running-local)
 
-## Customization
+### Customization
 
 See the [settings documentation](https://github.com/thiagorossener/jekflix-template/wiki/settings) to customize layout, titles, social media and more.
 
-## Theme
+### Theme
 
 You can easily change the theme colors by changing the file `src/yml/theme.yml`, then running `gulp build` in your terminal.
 
-### GitHub pages
+#### GitHub pages
 
 It's a known issue that you can't run Gulp when deploying the website into GitHub pages. So, you must change the theme colors and run `gulp build` locally, then push the changes into your repo, there is no other way.
 
@@ -68,13 +206,24 @@ To see how your website is going to look like when you deploy it, run `bundle ex
 
 ## Posts
 
-You can create posts manually using the [Front Matter properties](https://github.com/thiagorossener/jekflix-template/wiki/post#front-matter-properties) or automatically using the available [script](https://github.com/thiagorossener/jekflix-template/wiki/post#creating-a-post).
+Use the [Front Matter properties](https://github.com/thiagorossener/jekflix-template/wiki/post#front-matter-properties) to create posts.
+
+> **Note:** In the case you're cloning this repo, you can use the available [script](https://github.com/thiagorossener/jekflix-template/wiki/post#creating-a-post) to generate posts automatically.
 
 ## Release notes
 
-### v3.0.1
+### v3.1.0
+
+- Fixed hero URL
+- Updated Google Analytics script, thanks to [@JHLeeeMe](https://github.com/JHLeeeMe)
+- Added MathJax library to render math expressions, thanks to [@XieGuochao](https://github.com/XieGuochao)
+
+### v3.0.2
 
 - Added assets folder
+
+### v3.0.1
+
 - Fixed post SVG icons
 
 ### v3.0.0

data/_includes/stats.html

@@ -1,12 +1,13 @@
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
 <script>
   var host = window.location.hostname;
   if (host != 'localhost') {
-    (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');
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', '{{ site.google_analytics }}');
   }
 </script>
   

data/_layouts/home.html

@@ -32,7 +32,7 @@ layout: main
                 <h1 class="title">{{ featured.title }}</h1>
                 <p class="description">{{ featured.subtitle }}</p>
                 <div class="buttons">
-                    <a href="{{ featured.url }}" role="button" class="button">
+                    <a href="{{ featured.url | prepend: site.baseurl }}" role="button" class="button">
                         <svg><use xlink:href="#icon-read"></use></svg>
                         <span>{{ site.translations.button.read_now | default: "Read Now" }}</span>
                     </a>

data/_layouts/post.html

@@ -103,7 +103,18 @@
         {% if author.linkedin_username %}
             {% assign author_urls = author_urls | append: '"https://www.linkedin.com/in/' | append: author.linkedin_username | append: '",' %}
         {% endif %}
-
+        {% if page.math %}
+        <script>
+            MathJax = {
+                tex: {
+                inlineMath: [['$', '$'], ['\\(', '\\)']]
+                }
+            };
+        </script>
+        <script type="text/javascript" id="MathJax-script" async
+            src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
+        </script>
+        {% endif %}
         <script type="application/ld+json">
         {
             "@context": "http://schema.org",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekflix
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Thiago Rossener
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
@@ -224,8 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Jekyll theme inspired by Netflix.