diff --git a/README.md b/README.md index 1c55f8035f..5e7236a0db 100644 --- a/README.md +++ b/README.md @@ -46,21 +46,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 +205,18 @@ 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.0.2 - Added assets folder + +### v3.0.1 + - Fixed post SVG icons ### v3.0.0