Skip to content

BrightLocal/ApiDocs

 
 

Repository files navigation

Slate

Build Status Dependency Status

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

Screenshot of Example Documentation created with Slate

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

Features

  • Clean, intuitive design — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripe's and Paypal's API docs. Slate is responsive, so it looks great on tablets, phones, and even print.

  • Everything on a single page — gone are the days where your users had to search through a million pages to find what