Repository files navigation

This repository contains the CloudMC API documentation

You're going to need one of the following:

• Local install
  • Ruby, version 2.2.5 or newer
  • Bundler — If Ruby is already installed, but thebundle command doesn't work, just rungem install bundler in a terminal.
• Docker (preferred)
• Vagrant

Clone this repository

Option 1: use docker

cd /path/to/repo/cloudmc-api-docs/docker compose up -d

Option 2: local or vagrant

cd /path/to/repo/cloudmc-api-docs/slate# either run locallybundle installbundleexec middleman server# OR use vagrantvagrant up

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

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

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

TODO: update with instructions on deploying the docs with jenkins

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

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