After creating my own Jekyll theme, on which this blog is based, I decided to share it with others. Here is a detailed guide to get started with the theme.
(Assuming you know what Jekyll and Github pages are.)
Download this theme’s zip file from here or clone the repository using
git clone https://github.com/brijeshb42/bitwiser.git. If you are cloning, then make sure to delete the
gh-pagesbranch as it includes the files for the theme website.
rubyand then do
gem install jekyll. This theme uses the latest
jekyllversion. So if you already have it installed, then upgrade it.
_config.ymldescribes all the variables which you are required to set. The description begins with double hash(
##). And the value to be set is commented below it using
_config.ymlaccording to your requirements.
Your website name
disqusForumNameIf this value is present, disqus commenting will be automatically added to all your blog posts.
googleAnalyticsIDIf this value is present, google analytics will be added to your website/blog. If
ga_idis present, make sure that
ga_domainis also present.
A short description of your website to be included in meta tag of your homepage
a few frequently used keywords on your site
links: This variable has a few commonly used social networks’ links
about_image: This is a new variable introduced. If defined, make sure the image is present in
imgdirectory. If not defined, a provided placeholder image is used. ** If github link is provided in
linksvariable, then the github profile picture will be used if
about_imageis not defined.
sidebar: This is a new variable introduced. It is used to enable/disable sidebar. If present, a sidebar will be displayed. To disable sidebar, just comment this line using
After setting the values in
_config.yml, you can start adding posts in the
_postsdirectory. Remove the example posts from the directory. The name of files in this directory should be according to specifications by
YYYY-MM-DD-your-post-title.md. Note that the file name extenion can be anything from md, markdown, mkd, textile or html.
Replace the image files
sharer.pngwith images of your own.
Test the site on local machine using
jekyll servein the theme directory.
If all works well,
git pushyour changes to your github pages repository
Then visit your blog at http://githubUserName.github.io.
- If you want to use a custom domain, then edit the
CNAMEfile and add your own domain
example.com. Make sure your domain points to github ip address.