README.md

Wufoo API Docs

Here is the source for the new Wufoo API documentation. It's built using Slate, a great tool for generating static HTML documentation from Markdown files.

Check out the live view

Getting Started with Slate

To build and deploy Slate, here's what you need to do:

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 repo and switch into the new directory
2. Install all dependencies: bundle install
3. 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.

4. When you've committed your changes, and you're ready to publish, run: rake publish
5. To publish to a different remote: bundle exec rake publish REMOTE_NAME=personal

Other examples of Slate documentation

• Travis-CI's API docs
• Mozilla's localForage docs
• Mozilla Recroom
• ChaiOne Gameplan API docs
• Drcaban's Build a Quine tutorial
• PricePlow API docs
• Emerging Threats API docs
• Appium docs
• Golazon Developer
• Dwolla API docs
• RozpisyZapasu API docs
• Codestar Framework Docs
• Buddycloud API
• Crafty Clicks API
• Paracel API Reference
• Switch Payments Documentation & API
• Coinbase API Reference
• Whispir.io API
• NASA API
• CardPay API
• IBM Cloudant
• Bitrix basis components

Attribution

Slate makes use of several other projects, such as:

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