Jekyll 101

1 minute read

Jekyll 101

Easiest, simplest way to public GitHub Pages with Jekyll

What is Jekyll

Reference

Transform your plain text into static websites and blogs!

Jekyll is, at its heart, a text transformation engine. It is a simple, blog-aware static site generator. You can create page templates and page elements like headers, footers, and navbars. You can create blog-type dated posts, or static pages.

Unlike wordpress its not a CMS, but in this case your github repo will fill that role.

Jekyll supports a variety of markup languages (Markdown, HTML, Textile), and Liquid to create templates and add dynamic page elements.

Github pages has built in Jekyll support, so your repo acts as a webhost.

Install Ruby

OSX

Incase of OSX 10.13 High Sierra

  1. First install Homebrew if you haven’t:

     $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
  2. run this script to install ruby-buildand rbenv packages:

     $ curl https://gist.githubusercontent.com/DirtyF/5d2bde5c682101b7b5d90708ad333bf3/raw/bbac59647ac66016cf443caf7d48c6ae173ae57f/setup-rbenv.sh | bash
    
  3. Check your ruby install:

     $ ruby -v
     ruby 2.4.3p205 (2017-12-14 revision 61247) [x86_64-darwin17]
    
  4. Update rubygems:

     gem update --system
    
  5. Install bundler and jekyll gems:

     $ gem install jekyll bundler
    

    Windows

TBD

Configure Jekyll

1. Make a new Jekyll worksapce

$ jekyll new .

2. Gemfile modify

source "https://rubygems.org"
gem "jekyll"
gem "github-pages", group: :jekyll_plugins

3. Install dependencies

$ bundle install

Comments