Skip to content
This repository has been archived by the owner on Sep 6, 2019. It is now read-only.

Latest commit

 

History

History
76 lines (47 loc) · 2.44 KB

INSTALL.md

File metadata and controls

76 lines (47 loc) · 2.44 KB

Installation

Install Ruby

OS X and most Linux systems come with Ruby pre-installed.

You can check whether you have Ruby installed by running:

$ ruby --version

Your Ruby version should begin with 1.9.3 or 2.0.0. If you've got that, you're all set.

For more information refer to ruby-lang.org.

Install RVM

"[Ruby Virtual Manager] is a command-line tool which allows you to easily install, manage, and work with multiple ruby environments from interpreters to sets of gems."

$ curl -L https://get.rvm.io | bash

For more information refer to rvm.io

Update RubyGems

RubyGems is a package management framework for Ruby.

$ gem update --system 

For more information refer to rubygems.org

Install with RubyGems

The best way to install Jekyll is via RubyGems. At the terminal prompt, simply run the following command to install Jekyll

$ gem install jekyll

For more information refer to jekyllrb.com

Running with Jekyll

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

$ jekyll build
# => The current folder will be generated into ./_site

$ jekyll build --destination <destination>
# => The current folder will be generated into <destination>

$ jekyll build --source <source> --destination <destination>
# => The <source> folder will be generated into <destination>

$ jekyll build --watch
# => The current folder will be generated into ./_site,
#    watched for changes, and regenerated automatically.

Jekyll also comes with a built-in development server that will allow you to preview what the generated site will look like in your browser locally.

$ jekyll serve
# => A development server will run at http://localhost:4000/

$ jekyll serve --detach
# => Same as `jekyll serve` but will detach from the current terminal.
#    If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
#    If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.

$ jekyll serve --watch
# => Same as `jekyll serve`, but watch for changes and regenerate

For more information refer to jekyllrb.com