Installing Slate

Jump to bottom Edit New page

Jon Kohler edited this page Jun 20, 2018 · 18 revisions

Prerequisites

You're going to need:

Linux or macOS — Windows may work, but is unsupported. For OSX, see installing_nokogiri prior to getting started
Ruby, version 2.2.5 or newer
Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

Fork this repository on Github.
Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/slate.git
cd slate
Initialize and start Slate. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

What Now?

The next step is to learn how to edit source/index.md to change the content of your docs.