|
| 1 | +Zolan - Modern & Minimal Theme for Jekyll |
| 2 | +====== |
| 3 | +Zolan is a minimal blog theme for Jekyll. |
| 4 | + |
| 5 | +* * * |
| 6 | + |
| 7 | +Table of Contents |
| 8 | +----------------- |
| 9 | +* [Features](#features) |
| 10 | +* [Demo](#demo) |
| 11 | +* [Deployment](#deployment) |
| 12 | +* [Posts](#posts) |
| 13 | +* [Disqus Comments](#DisqusComments) |
| 14 | +* [Instagram](#instagram) |
| 15 | +* [Google Analytics](#GoogleAnalytics) |
| 16 | +* [Update favicon](#UpdateFavicon) |
| 17 | +* [Credits](#Credits) |
| 18 | +* [Support](#Support) |
| 19 | + |
| 20 | +* * * |
| 21 | + |
| 22 | +### Features |
| 23 | + |
| 24 | +* 100% responsive and clean theme |
| 25 | + |
| 26 | +* Optimized for mobile devices |
| 27 | + |
| 28 | +* Minimal design |
| 29 | + |
| 30 | +* Valid HTML5 code |
| 31 | + |
| 32 | +* Post sharing |
| 33 | + |
| 34 | +* Subscription form |
| 35 | + |
| 36 | +* Supports Disqus Comments |
| 37 | + |
| 38 | +* Instagram Feed |
| 39 | + |
| 40 | +* Ionicons Icons |
| 41 | + |
| 42 | +* Google Fonts |
| 43 | + |
| 44 | + |
| 45 | +* * * |
| 46 | + |
| 47 | +### Demo |
| 48 | + |
| 49 | +Check the theme in action [Demo](https://zolan-jekyll.netlify.app/) |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +The post page would look like this: |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +* * * |
| 58 | + |
| 59 | +### Deployment |
| 60 | + |
| 61 | +To run the theme locally, navigate to the theme directory and run `bundle install` to install the dependencies, then run `jekyll serve` or `bundle exec jekyll serve` to start the Jekyll server. |
| 62 | + |
| 63 | +I would recommend checking the [Deployment Methods](https://jekyllrb.com/docs/deployment-methods/) page on Jekyll website. |
| 64 | + |
| 65 | +* * * |
| 66 | + |
| 67 | +### Posts |
| 68 | + |
| 69 | +To create a new post, you can create a new markdown file inside the \_posts directory by following the [recommended file structure](https://jekyllrb.com/docs/posts/#creating-post-files). |
| 70 | + |
| 71 | + --- |
| 72 | + layout: post |
| 73 | + title: Time to give gifts to everyone |
| 74 | + date: 2018-08-23 16:04:00 +0300 |
| 75 | + image: 03.jpg |
| 76 | + tags: Life |
| 77 | + --- |
| 78 | + |
| 79 | + |
| 80 | +You can set the tags and the post image. |
| 81 | + |
| 82 | +Add post images to **/images/** directory. |
| 83 | + |
| 84 | +For tags, try to not add space between two words, for example, `Ruby on Rails`, could be something like (`ruby-on-rails`, `Ruby_on_Rails`, or `Ruby-on-Rails`). |
| 85 | + |
| 86 | +* * * |
| 87 | + |
| 88 | +### Disqus Comments |
| 89 | + |
| 90 | +Zolan Theme comes with Disqus comments enabled. |
| 91 | + |
| 92 | +Open `_data/settings.yml` file, and change the `mr-brown` value on line 26 with your [Disqus account shortname](https://help.disqus.com/customer/portal/articles/466208). |
| 93 | + |
| 94 | + Comment Section (Disqus) |
| 95 | + disqus-identifier: mr-brown # Add your shortname for Disqus Comment. For example mr-brown |
| 96 | + |
| 97 | + |
| 98 | +That’s all you need to setup Disqus from the theme side. If you get any issue regarding that comments are unable to load. First, make sure you have [registered your website with Disqus (Step 1)](https://help.disqus.com/customer/portal/articles/466182-publisher-quick-start-guide). |
| 99 | + |
| 100 | +And also check [Disqus troubleshooting guide](https://help.disqus.com/customer/portal/articles/472007-i-m-receiving-the-message-%22we-were-unable-to-load-disqus-%22) if you still have issues. |
| 101 | + |
| 102 | +* * * |
| 103 | + |
| 104 | +### Instagram |
| 105 | + |
| 106 | +The Instagram feed is working using [Instafeed.js](http://instafeedjs.com/) to show the photos. |
| 107 | + |
| 108 | +First, you will need to get your account `userId` and `accessToken` from the following URLs: |
| 109 | + |
| 110 | +* userId: [http://codeofaninja.com/tools/find-instagram-user-id/](http://codeofaninja.com/tools/find-instagram-user-id/) |
| 111 | +* accessToken: [instagram.pixelunion.net](http://instagram.pixelunion.net/) |
| 112 | + |
| 113 | +Second, open the `js/common.js` file and replace the `userId` and `accessToken` values. |
| 114 | + |
| 115 | + var instagramFeed = new Instafeed({ |
| 116 | + get: 'user', |
| 117 | + limit: 6, |
| 118 | + resolution: 'standard_resolution', |
| 119 | + userId: '8987997106', |
| 120 | + accessToken: '8987997106.924f677.8555ecbd52584f41b9b22ec1a16dafb9', |
| 121 | + template: '' |
| 122 | + }); |
| 123 | + |
| 124 | + |
| 125 | +Third, open the `_data/settings.yml` file and replace the `instafeed: false` on `instafeed: true` value. |
| 126 | + |
| 127 | + # Instagram Feed |
| 128 | + instafeed: false # To enable the instafeed, use the value true. To turn off use the value false. |
| 129 | + |
| 130 | + |
| 131 | +* * * |
| 132 | + |
| 133 | +### Google Analytics |
| 134 | + |
| 135 | +To integrate Google Analytics, open `_data/settings.yml`, and add your Google Analytics identifier. |
| 136 | + |
| 137 | + # Google Analytics |
| 138 | + google-analytics: # Add your identifier. For example UA-99631805-1 |
| 139 | + |
| 140 | + |
| 141 | +* * * |
| 142 | + |
| 143 | +### Update favicon |
| 144 | + |
| 145 | +You can find the current favicon (favicon.ico) inside the theme root directory, just replace it with your new favicon. |
| 146 | + |
| 147 | +* * * |
| 148 | + |
| 149 | +### Credits |
| 150 | + |
| 151 | +I have used the following scripts, fonts or other files as listed. |
| 152 | + |
| 153 | +* [Google Fonts](https://fonts.google.com/specimen/Nunito) (Roboto, Sans Serif). |
| 154 | +* [Ionicons Icons](https://ionicons.com/) |
| 155 | +* [FitVids.js](http://fitvidsjs.com/) |
| 156 | +* [Medium’s Image Zoom](https://github.com/fat/zoom.js) |
| 157 | +* [Instafeed.js](http://instafeedjs.com/) |
| 158 | +* [jQuery.com](https://jquery.com/) |
| 159 | +* Preview Images form [unsplash.com](https://unsplash.com/), [pexels.com](https://www.pexels.com/) |
| 160 | + |
| 161 | +* * * |
| 162 | +### License |
| 163 | + |
| 164 | +Mit License |
| 165 | + |
| 166 | +* * * |
| 167 | + |
| 168 | +### Support |
| 169 | +<p>If you like the themes that I create you can become my sponsor on <a href="https://www.patreon.com/artemsheludko" target="_blank">Patreon</a>. |
| 170 | +<p align="center"><b>Thank you for your support ❤️</b></p> |
0 commit comments