Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.11 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.11 KB
Raw

This documentation is generated using the amazing Slate framework.

Getting Started

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 1.9.3 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

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/slate.git
  3. cd slate
  4. 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!

Contributors

The main contributor to this fork is Roberto Marco. Slate Framework was built by Robert Lord while at TripIt.