Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cwksc/cwksc.github.io_backup


https://github.com/cwksc/cwksc.github.io_backup

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README 

          
[![Netlify Status](https://api.netlify.com/api/v1/badges/5f205b3a-73c2-472c-b052-82b95bdf36b7/deploy-status)](https://app.netlify.com/sites/sleepy-bhabha-00eedf/deploys)



# Jekflix Template



![Jekflix Template Cover Image](https://res.cloudinary.com/dm7h7e8xj/image/upload/v1505354182/jekflix-logo_mfngps.png)



See the [demo here](https://jekflix.rossener.com/).



## What is it?



A theme for Jekyll inspired by Netflix panel for who loves movies and series and would like to have a blog with this cool appearance.



![Jekflix Screenshot Image](https://res.cloudinary.com/dm7h7e8xj/image/upload/v1566390829/jekflix-screenshot-2_zfiog2.jpg)



## Features



- [Live Search](https://github.com/thiagorossener/jekflix-template/wiki/Features#live-search)

- [Estimated Reading Time](https://github.com/thiagorossener/jekflix-template/wiki/Features#estimated-reading-time)

- [Reading Progress Bar](https://github.com/thiagorossener/jekflix-template/wiki/Features#reading-progress-bar) *(optional)*

- ["New Post" tag](https://github.com/thiagorossener/jekflix-template/wiki/Features#new-post-tag)

- [Load images on demand](https://github.com/thiagorossener/jekflix-template/wiki/Features#load-images-on-demand)

- [Push Menu](https://github.com/thiagorossener/jekflix-template/wiki/Features#push-menu)

- [SVG icons](https://github.com/thiagorossener/jekflix-template/wiki/Features#svg-icons)

- [Shell script to create posts](https://github.com/thiagorossener/jekflix-template/wiki/Features#shell-script-to-create-posts)

- [Tags page](https://github.com/thiagorossener/jekflix-template/wiki/Features#tags-page)

- [About page](https://github.com/thiagorossener/jekflix-template/wiki/Features#about-page)

- [Contact page](https://github.com/thiagorossener/jekflix-template/wiki/Features#contact-page)

- [404 error page](https://github.com/thiagorossener/jekflix-template/wiki/Features#404-error-page)

- [Feed RSS](https://github.com/thiagorossener/jekflix-template/wiki/Features#feed-rss)

- [Disqus](https://github.com/thiagorossener/jekflix-template/wiki/Features#disqus) *(optional)*

- [Featured post](https://github.com/thiagorossener/jekflix-template/wiki/Features#featured-post) *(optional)*

- [Home page pagination](https://github.com/thiagorossener/jekflix-template/wiki/Features#home-page-pagination) *(optional)*

- [Posts sidebar](https://github.com/thiagorossener/jekflix-template/wiki/Features#posts-sidebar) *(optional)*

- [Paginated posts](https://github.com/thiagorossener/jekflix-template/wiki/Features#paginated-posts) *(optional)*

- ["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!**

- [Math Expressions](https://github.com/thiagorossener/jekflix-template/wiki/Features#math-expressions) *(optional)* **new!**



## SEO



- Google Analytics

- Meta tags

- JSON-LD

- 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



See the [settings documentation](https://github.com/thiagorossener/jekflix-template/wiki/settings) to customize layout, titles, social media and more.



### 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



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.



To see how your website is going to look like when you deploy it, run `bundle exec jekyll serve` locally and access `http://127.0.0.1:4000/`.



## Posts



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.1.0



- Fixed hero URL, thanks to [@JoelSalzesson](https://github.com/JoelSalzesson)

- 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



- Created theme `gem`

- Enabled text translations

- Added heading anchor links

- Changed code highlight colors

- Changed from Stylus to SASS



### v2.0.1

- Fixed bugs

- Optimized to support disabled JS



### v2.0.0

- Added optional [sidebar](https://github.com/thiagorossener/jekflix-template/wiki/Features#posts-sidebar)

- Added optional [Featured post](https://github.com/thiagorossener/jekflix-template/wiki/features#featured-post)

- Added optional ["Before you go" modal](https://github.com/thiagorossener/jekflix-template/wiki/features#before-you-go-modal)

- Added optional [post pagination](https://github.com/thiagorossener/jekflix-template/wiki/features#paginated-posts)

- Added [post recommendation](https://github.com/thiagorossener/jekflix-template/wiki/features#post-recommendation)

- Added meta keywords to improve SEO

- Added JSON-LD to improve SEO

- Changed pagination to be [optional](https://github.com/thiagorossener/jekflix-template/wiki/features#home-page-pagination)

- Improved [Tags page](https://github.com/thiagorossener/jekflix-template/wiki/features#tags-page)

- Cleaned up and improved [Front Matter properties](https://github.com/thiagorossener/jekflix-template/wiki/post#front-matter-properties)

- Set up [Netlify CMS](https://github.com/thiagorossener/jekflix-template/wiki/features#netlify-cms-ready)

- Improved customization settings

- Minor design updates



### v1.0.1

- Fixed bugs

- Upgraded to Gulp 4



### v1.0.0

- Initial release



## Questions?



File a [GitHub issue](https://github.com/thiagorossener/jekflix-template/issues/new) please.



## Donation



Did you like my work? Buy me a beer 😁🍺



[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SAKL66RSDGH48&source=url)



## Author



[Thiago Rossener](https://rossener.com/)



## License



*Jekflix Template* is available under the MIT license. See the [LICENSE](https://github.com/thiagorossener/jekflix-template/blob/master/LICENSE) file for more info.