Slate helps you create beautiful, intelligent, responsive API documentation.

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 in print.

• Everything on a single page — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.

• Slate is just Markdown — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks.

• Write code samples in multiple languages — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown.

• Out-of-the-box syntax highlighting for almost 60 languages, no configuration required.

• Automatic, smoothly scrolling table of contents on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.

• Let your users update your documentation for you — By default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.

Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the sample docs.

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. Fork this repository on Github.
2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/slate.git
3. cd slate
4. Initialize and start (there are a few options for this):

Manual/local

bundle install
bundle exec middleman server

Via Docker (must install it first)

docker-compose up

will spin an environment for you, with the source directory mapped to the container, so you can see your edits instantly after refreshing your browser.

You can now see the docs at http://localhost:4567. Whoa! That was fast!

+Note: if you're not using Docker natively (i.e. on Linux), the docs will be +available at the IP of your docker host. If you're using docker-machine you can +retrieve it with docker-machine ip <your_machine_name>

Note: if you're using the Docker setup on OSX, the docs will be available at the output of docker-machine ip <machine-name> (port: 4567) instead of localhost:4567.

Via Vagrant

vagrant up

You can now see the docs at http://localhost:4567.

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.

Companies Using Slate

• NASA
• IBM Cloudant
• Travis-CI
• Mozilla
• Appium
• Dwolla
• Clearbit
• Coinbase
• Parrot Drones
• Fidor Bank

You can view more in the list on the wiki.

Need Help? Found a bug?

Read our contribution guidelines, and then submit a issue to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes.

Contributors

Slate was built by Robert Lord while at TripIt.

Thanks to the following people who have submitted major pull requests:

• @chrissrogers
• @bootstraponline
• @realityking

Also, thanks to Sauce Labs for helping sponsor the project.

Special Thanks

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