Documentation - Configuration & First Steps


All configuration options are in the _config.yml file.

Created by Hannah Sharp
General Settings
  • name: Your name.
  • job_title: Your job title.
  • email: Your email. There are two cases where email is used. First, if you entered the email and you’ve activated show_email option the end result will be a visible social email icon in the sidebar. The second use of your email is when you do not set your own avatar. In this case your email is used by the gravatar plugin to automatically fetch your gravatar.
  • description: Describe yourself with a couple of words.
  • avatar: Write down the full path to the avatar If you comment this row, “Steve” checks if you have an email and shows your gravatar if you have any.
  • favicon: Want a favicon? Enter the full path here. For example
  • twitter_handler: Add your Twitter username without the @. It will be used for Twitter Cards. The default card type for “Steve” is Summary Card with Large Image.
  • analytics_code: Add your Google Analytics Tracking ID. Example ID: UA-XXXXXXX-2.
  • disqus: Add your website shortname from Disqus.

Important Note: Keep in mind that name, job_title, twitter_handler and some of the post specific variables are used as default meta data in some cases.

Read More


I assume you have already downloaded and installed Ruby. Here’s what you need to do next:

  1. Run gem install jekyll bundler.
  2. Copy the theme in your desired folder.
  3. Enter into the folder by executing cd name-of-the-folder.
  4. Run bundle install.
  5. If you want to access and customize the theme, use bundle exec jekyll serve. This way it will be accessible on http://localhost:4000.
  6. Upload the content of the compiled _site folder on your host server.

What is Jekyll?

Jekyll is a parsing engine bundled as a ruby gem used to build static websites from dynamic components such as templates, partials, liquid code, markdown, etc. Jekyll is known as “a simple, blog aware, static site generator”.

Alt Text

Read More

Sample Data

Markdown (or Textile), Liquid, HTML & CSS go in. Static sites come out ready for deployment.


Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6


No more databases, comment moderation, or pesky updates to install—just your content.

Unordered List

  • Jekyll
    • Nested Jekyll
    • Nested Ruby
  • Ruby
  • Markdown
  • Liquid

Ordered List

  1. Jekyll
    1. Nested Jekyll
    2. Nested Ruby
  2. Ruby
  3. Markdown
  4. Liquid

This is an example inline link.

Paragraph w/ strong, em, etc.

These are just a few of the available configuration options. Many configuration options can either be specified as flags on the command line, or alternatively (and more commonly) they can be specified in a _config.yml file at the root of the source directory. Jekyll will automatically use the options from this file when run. For example, if you place the following lines in your _config.yml file.


Photo by Rachel Davis.


Default Code Block

This is code blog.

Styled Code Block


$LOAD_PATH << '.'
require "support"

class Decade
include Week
   def no_of_months
      puts Week::FIRST_DAY
      puts number
puts Week::FIRST_DAY

Definition Lists

Definition Title
Definition Description

Paragraphs w/ Aligned Images

The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways.

Photo by Dustin Lee.

This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.

Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through a converter (like Markdown) and our Liquid renderer, and spits out a complete, ready-to-publish static website suitable for serving with your favorite web server. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your project’s page, blog, or website from GitHub’s servers for free.

Photo by LoboStudio Hamburg.

Throughout this guide there are a number of small-but-handy pieces of information that can make using Jekyll easier, more interesting, and less hazardous. Here’s what to look out for.

If you come across anything along the way that we haven’t covered, or if you know of a tip you think others would find handy, please file an issue and we’ll see about including it in this guide.

The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines.