alvinsjq / chalk

Chalk is a high quality, completely customizable, performant and 100% free blog template for Jekyll.

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 (like Medium).

Integrations

• Google Analytics
• Google Fonts
• Disqus
• Ionicons
• Social media links

Used tools

• Autoprefixer
• Bower
• Circle CI
• Html-proofer
• Jekyll
• Jekyll assets
• Jekyll Sitemap
• HTML5 Boilerplate (Influenced by)
• Kickster
• Retina.js
• STACSS

Usage

Installation

If you haven't installed the following tools then go ahead and do so (make sure you have Homebrew installed):

brew install ruby
brew install npm

Next setup your environment:

bin/setup

Development

Run Jekyll:

bundle exec jekyll serve

Deploy to GitHub Pages

Run this in the root project folder in your console:

bin/deploy

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

1. Fork it ( https://github.com/[my-github-username]/chalk/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request