Chalk is a high quality, completely customizable, performant and 100% free blog template for Jekyll.
Overview¶ ↑
Features: - Dark and Light theme. - Filter on tags. - customizable pagination. - Beautified link sharing in Facebook and other social media. - Automatic time to read post indicator. - Automatic RSS feed. - About page. - 404 page. - SEO optimized. - PageSpeed optimized. - Cross browser support (supports all modern browsers). - Media embed for videos. - Enlarge images on click. - Support for local fonts
Integrations - Google Analytics - Google Fonts - Disqus - Ionicons - Social media links
Used tools - Autoprefixer - Circle CI - Html-proofer - Jekyll - Jekyll assets - Jekyll Sitemap - HTML5 Boilerplate (Influenced by) - Kickster - Retina.js - STACSS - Yarn
Usage¶ ↑
Installation¶ ↑
Add this line to your Jekyll site's Gemfile:
gem "jekyll-theme-chalk"
And add this line to your Jekyll site:
theme: jekyll-theme-chalk
And then execute:
$ bundle
Development¶ ↑
Run Jekyll:
bundle exec jekyll serve
Deploy to GitHub Pages¶ ↑
Before you deploy, commit your changes to any working branch except the gh-pages
one then run the following command:
bin/deploy
Important note: Chalk does not support the standard way of Jekyll hosting on GitHub Pages. You need to deploy your working branch (can be any branch, for xxx.github.io users: use another branch than master) with the bin/deploy
script. This is because Chalk uses Jekyll plugins that aren't supported by GitHub pages. The bin/deploy
script will automatically build the entire project, then push it to the gh-pages
branch of your repo. The script creates that branch for you so no need to create it yourself.
You can find more info on how to use the gh-pages
branch and a custom domain here.
View this for more info about automated deployment with Circle CI.
License¶ ↑
MIT License
Contributing¶ ↑
-
Create your feature branch (
git checkout -b my-new-feature
) -
Commit your changes (
git commit -am 'Add some feature'
) -
Push to the branch (
git push origin my-new-feature
) -
Create a new Pull Request