Overview
SleekGem is a modern Jekyll theme designed to prioritize speed performance and SEO best practices. It is compatible with Github Pages and offers minimal, responsive design. Please note that this theme is no longer actively maintained.
Features
- Compatible with Github Pages
- Minimal, responsive design optimized for speed performance
- SEO friendly, with the help of Jekyll SEO Plugin
- Easy integration with Google Tag Manager
- Support for Disqus comments
- Form submissions with Formspree
Installation
To use this project, you will need the following on your local machine:
- Jekyll
- NodeJS (8 or greater)
- Download and open the NodeJS installer.
- Install Jekyll by running the command
gem install jekyll. - Install Gulp CLI (optional, but recommended) by running the command
npm install -g gulp-cli. - Fork the repo, clone or download it into a directory of your choice:
git clone https://github.com/your-github-username/sleek.git. - Inside the directory, run
bundle installandnpm install. - If you want to use Gulp, run
gulpornpm start. If you don’t want to use Gulp, you can runbundle exec jekyll serveinstead.
To install the theme to an existing Jekyll project:
- Add the following line to your Jekyll site’s Gemfile:
gem "sleek", "~> 1.0" - Add the following line to your Jekyll site’s
_config.ymlfile:theme: sleek - Execute the command
bundle installor install it manually as:gem install sleek.
Summary
SleekGem is a modern Jekyll theme that focuses on speed performance and SEO best practices. It offers a minimal, responsive design and is compatible with Github Pages. It also provides features like Google Tag Manager integration, Disqus comments, and Formspree for form submissions. The installation process is straightforward, requiring Jekyll and NodeJS. It can be used either as a standalone theme or added to an existing Jekyll project.