Getting Started

Prerequisites

You're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.0 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. cd api-documentation
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 your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

Need Help? Found a bug?

Submit an issue if you found a problem. And, of course, feel free to submit pull requests with bug fixes or changes.

Contributors

This is build with Slate Thanks, you rock! 🤘

Special Thanks

• Middleman
• jquery.tocify.js
• middleman-syntax
• middleman-gh-pages
• Font Awesome