Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

38 lines (19 sloc) 1.018 kb

Getting Started

Run locally

middleman server

Build & upload pages

middleman build
cd build
git commit -am "regenerate pages"
git push

Goals

Main docs in a single page

Parse API Blog Post explaining why on Parse API

Separate pages ok for long-form parts, like detailed multi-step tutorials, OAuth, etc...

Inline code examples for each language/library we "support"

Stripe's API Docs has a switcher at top to pick your preferred language.

Use the user's token in examples

If the visitor is logged in to github.com, automatically use their username/token in the examples. We'll probably have to punt on several of the examples, though. Eg, /user would show the current user, but we don't want to have to remake the request for each example * language on the page. This would lead nicely into a future javascript API explorer, though.

Jump to Line
Something went wrong with that request. Please try again.