A modern Jekyll theme focused on speed performance & SEO best practices.

• Compatible with Github Pages
• Minimal, responsive and speed performance optimized
• SEO friendly, with help of Jekyll SEO Plugin
• Easy Google Tag Manager Integration
• Support for Disqus comments
• Form submissions with Formspree

Preview Demo

To use this project, you'll need the following things on your local machine:

gem install jekyll

Download and open the NodeJS installer

sudo npm install -g gulpfile

1. Fork the repo
2. Clone or download the repo into directory of your choice: git clone https://github.com/your-github-username/sleek.git
3. Inside the directory run bundle install and npm install
4. If you want to use gulp.js run gulp or npm start

• if you don't want to use gulp you can simply run bundle exec jekyll serve

Add this line to your Jekyll site's Gemfile:

gem "jekyll-sleek"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-sleek

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-sleek

sleek
├── _includes	                 # theme includes
├── _js	                       # javascript files (by default jquery will be included with the scripts inside)
├── _layouts                   # theme layouts (see below for details)
├── _pages                     # pages folder (empty by default)
├── _posts                     # blog posts
├── _sass                      # Sass partials
├── assets
|  ├── css	                   # minified css files  
|  ├── img                     # images and icons used for the template
|  └── js		                   # bundled and minified files from _js folder
├── _config.yml                # sample configuration
├── gulpfile.js                # gulp tasks (tasks autorunner)
├── index.md                   # sample home page (blog page)
└── package.json               # gulp tasks

TODO

TODO

TODO

To enable Disqus comments, add your Disqus shortname to _config.yml:

disqus:
  shortname: my_disqus_shortname

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

Bug reports and pull requests are welcome on GitHub at https://github.com/janczizikow/sleek. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-sleek.gemspec accordingly.

The theme is available as open source under the terms of the MIT License.