Setting up your system

In a typical jekyll installation, you would normally build the site locally first, then publish it to the web when you are ready and have some content. In order to work locally, you first have to make sure that our computer has all the necessary software installed. Jekyll needs a full Ruby development environment so you’ll need to make sure you have that configured correctly first.

You’ll also want to be sure to have a good code editor on your machine to view and edit your code. We recommend using either Atom, Sublime Text, or Notepad++.

Windows OS

Windows isn’t technically a Jekyll-supported platform, but we do have two options that will allow us to work on Windows machines.

Option 1: Install the RubyInstaller kit

The RubyInstaller kit will run a self-contained environment on Windows machines.

Follow these instructions for option 1.

Option 2: Bash on Windows 10

This option is for Windows 10 users only. On Windows 10, you can install and enable the Windows Subsection for Linux. This option might be useful to set up if you anticipate working on other projects that would require the Unix Shell.

Follow these instructions for option 2.

Once you have completed these steps check that you have Git installed by opening your bash terminal and typing:

git --version

If you do not have Git installed, download it from here..

Mac OS

The Mac operating system needs the Xcode suite to run several tools developers use to create software and applications. So to start, let’s install it from the command line if you don’t already have it.

Install X-Code

First install X-code $ xcode-select --install

This should install GNU Compiler Ccllection (GCC) and Git, but let’s make sure. Verify you are running GCC $ gcc --version You should see a version number in your shell

Verify you have Git $ git --version Again, you should see a version number

Install RVM

Install the most recent stable version of Ruby Version Manager (RVM). RVM will allow you to use different versions of Ruby (which we’ll install next) for website projects and your operating system

$ curl -L | bash -s stable

Now lets verify RVM was installed

$ rvm --version

Install Ruby with RVM

Now install the most recent stable version of Ruby using RVM

$ rvm install "ruby-2.7.0"

Then set that version as the default Ruby installation for our project

$ rvm --default use 2.7.0

Check that Ruby is set to the version we configured

$ ruby -v

And, now generate the core Ruby documentation

$ rvm docs generate-ri

Install Jekyll and Bundler gems

Now that you have a full Ruby dev environment installed, let’s finish by installing Jekyll and Bundler

$ gem install jekyll bundler

We are going to create a new project folder for our Jekyll site installation. Navigate to a folder where you want to locally install and work on your site (maybe a directory where you already have projects like this)

$ cd documents/sites

Create a new Jekyll project called “[your-name]-project-site”

$ jekyll new [your-name]-project-site

And navigate into that new project

$ cd [your-name]-project-site

Serve and view your site

Now navigate into that directory

$ cd [your-name]-project-site

And start the server to see your blank site

$ bundle exec jekyll serve

Now in your web browser (preferably FireFox or Chrome) go to the address and you should see your new blank site!