Web API Docs

Slate ReadMe

Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API.

The example above was created with Slate. Check it out at tripit.github.io/slate.

Slate Workflow

1. Make changes on master mainly to source/index.md or includes/
2. Commit and push yo' codez
3. Make sure you have checked out gh-pages branch
4. On master run rake publish

Getting Started with Slate

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. Clone this repository to your hard drive
2. cd web-api-docs
3. Install all dependencies: bundle install
4. Start the test server: bundle exec middleman server

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.