Skip to content

Home

Jump to bottom
Ankit R. Gadiya edited this page Oct 25, 2018 · 4 revisions

Gem Travis (.org) GitHub issues GitHub stars GitHub license Gem

Demo: https://st.argp.in/jekyll/

Usage

The template is available as Ruby Gem. To add the Gem to your jektll site do the following:

  • Add the Gem in the Gemfile. 
    source "https://rubygems.org"
"jekyll-simple-template"
  • Add the Theme in _config.yml. 
    theme: jekyll-simple-template

Alternatively, you can fork the repository and use it as your website.

Plugins

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

Configuration

The template expects following variables in the _config.yml.

lang : Langauge of the Website (for html tag)

title : Title of the Website (for SEO and Header)

author : Author of the Website (for SEO and Footer)

url : Url of the website (for SEO)

baseurl : [Optional] Baseurl of the Website (for relative URL)

logo : [Optional] Logo of the Website (for SEO)

Example

Navigation

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"

Where url can be external or relative.

Example

Social Links

For social links in footer, the template looks for _data/social.yml file. Following is the supported social networks and format in which it should be added.

facebook : username
twitter  : username
github   : username
youtube  : channel
instagram: username
linkedin : username

Example

Micro.Blog

If you want to link the blog/site with Micro.blog, add following in _config.yml.

micro_blog: username

This will generate a link tag in head (to verify site) and add a link to follow on Blog page.

Pocket

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 _config.yml.

pocket_verification: verification_code

SEO

As mentioned above, the template uses jekyll-seo-tag for SEO information. All the options from that can be used. For more information read its Usage.

Sitemap and Feed

As mentioned above, the template uses jekyll-sitemap and 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.

Layouts

The template provides following layouts:

  • default
  • home
  • blog
  • page
  • post
  • archive
  • redirect

To override any of the built-in layouts, just create the file with same name in _layouts/ directory.

Tests

Imgur Imgur Imgur Imgur

Links

License

BSD 3-Clause License.

Clone this wiki locally