- About page.
- Automatic RSS feed.
- Automatic sitemap.
- Automatic time to read post indicator.
- Cross browser support (supports all modern browsers).
- Custom 404 page.
- Custom code highlighting.
- Customizable pagination.
- Dark and Light theme.
- Easy setup and deploying.
- Enlarge images on click.
- Filter on tags.
- Frequently updated with new versions.
- Many social media links supported.
- Media embed for videos.
- PageSpeed optimized.
- Proper sharing links for posts on Facebook, Twitter and Google Plus.
- SEO optimized.
- Support for local fonts.
- Support for emoji’s.
- Circle CI
- Jekyll Assets
- Jekyll Sitemap
- HTML5 Boilerplate (Influenced by)
If you haven’t installed the following tools then go ahead and do so (make sure you have Homebrew installed):
On windows, install Ruby and Node with the installers found here:
Next setup your environment:
Deploy to GitHub Pages
Before you deploy, commit your changes to any working branch except the
gh-pages one and run the following command:
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. Reason for 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.
If you have any questions about using or configuring Chalk please create an issue here!