Using Jekyll within GitHub Pages is relatively straight forward, but due to some operating system (OS 10.9.2, Xcode 5.1) issues it became more difficult than necessary.
At the time of writing, if you are using OS X, do not use the version of ruby that comes with your computer.
Issue #2125 is the problem and although the ARCHFLAGS work around worked to install Jekyll, it didn’t work when running
jekyll serve --watch.
xcode-select --installin Mavericks.)
Navigate to brew.sh for more information or type:
ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
Navigate to rvm.io for more information or type:
\curl -sSL https://get.rvm.io | bash -s stable
At this point I had to quit Terminal and reopen it to get it to recognize the
After reopening Terminal you’ll want to run
rvm install 2.1.1 or you can attempt to find a newer version of Ruby by running
rvm list known.
The install should’ve switched to this version of Ruby (2.1.1), but to make sure you aren’t using the native version of Ruby, type
rvm use 2.1.1 or verify you’re using the latest by typing
which ruby and
Navigate to jekyllrb.com for more information or type:
gem install -V jekyll
You can omit the
-V, but your Terminal window will be blank for a lengthy amount of time.
jekyll new /path/to/repository/project-name
/path/to/repository/project-namemust be a path, you cannot run
jekyll newfrom within the directory you wish to use.
Conflict: /path/to/repository/project-name exists and is not empty., you’ll have to move the files in your project to a temporary location and rerun the command.
jekyll serve --watch --drafts
--watchupdates your local copy every time you save a file.
--draftsshows drafts on your local copy
Good luck and hopefully this guide was of some help!
Also, feel free to checkout the source of this website.
Update [05/13/2014]: Using this method may cause slow load times As you may have noticed, as of last week this site uses a custom domain, but the content is being stored by GitHub. I seem to be...