Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
The template is available as Ruby Gem. To add the Gem to your jektll site do the following:
- Add the Gem in the
source "https://rubygems.org" "jekyll-simple-template"
- Add the Theme in
Alternatively, you can fork the repository and use it as your website.
Instead of inventing the wheel, the template uses the following popular plugins for Jekyll, to add features to the template:
- jekyll-archives: Generates Archive pages for Year, Month, Day, Tags and Categories
- jekyll-feed: Generates the Atom (RSS like) Feed for Blog Posts
- jekyll-seo-tag: Adds necesarry SEO information in the head tag
- jekyll-sitemap: Generates sitemap.org compliant sitemap for the website
The template expects following variables in the
: Langauge of the Website (for html tag)
: Title of the Website (for SEO and Header)
: Author of the Website (for SEO and Footer)
: Url of the website (for SEO)
: [Optional] Baseurl of the Website (for relative URL)
: [Optional] Logo of the Website (for SEO)
For navigation links, the template looks for
_data/navigation.yml file. The
links should be added to the file in following format.
- title: "Link Name" url: "http://example.com"
url can be external or relative.
For social links in footer, the template looks for
Following is the supported social networks and format in which it should be
facebook : username twitter : username github : username youtube : channel instagram: username linkedin : username
If you want to link the blog/site with Micro.blog, add
This will generate a link tag in head (to verify site) and add a link to follow on Blog page.
To use Pocker for Publishers with the
website, you need to add the Pocket verification code in the HEAD tag of the
website. The template uses a variable
pocket_verification in the global
configuration to insert it into HEAD. To use this, add the following line in
Sitemap and Feed
As mentioned above, the template uses
jekyll-feed for sitemap and feed
respectively. By default sitemap is available at
/sitemap.xml and feed of
posts is available at
/feed.xml. For more information about the plugins, check
out there repositories and read the documentations.
The template provides following layouts:
To override any of the built-in layouts, just create the file with same name in
BSD 3-Clause License.