This repository contains the CloudMC API documentation

You're going to need:

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

1. Clone this repository
2. cd slate
3. 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!

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown

If you'd prefer to use Docker, instructions are available in the wiki.

TODO: update with instructions on deploying the docs with jenkins

1. Make sure your changes have been merged into cmc-dev
2. git checkout cmc-dev
3. ./deploy.sh

The docs should go live once GitHub processes the new gh-pages branch contents.