Slate logo

Slate

Beautiful static documentation for your API, inspired by Stripe's and Paypal's API docs
26
53
+ 1
7

What is Slate?

Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API.
Slate is a tool in the Documentation as a Service & Tools category of a tech stack.
Slate is an open source tool with 28.6K GitHub stars and 18.1K GitHub forks. Here’s a link to Slate's open source repository on GitHub

Who uses Slate?

Companies
11 companies reportedly use Slate in their tech stacks, including iAgree, Compile Inc, and Web.

Developers
15 developers on StackShare have stated that they use Slate.

Why developers like Slate?

Here’s a list of reasons why companies and developers use Slate
Top Reasons
Slate Reviews

Here are some stack decisions, common use cases and reviews by companies and developers who chose Slate in their tech stack.

Tim Nolet
Tim Nolet
Founder, Engineer & Dishwasher at Checkly · | 7 upvotes · 64.7K views
atChecklyHQChecklyHQ
JavaScript
JavaScript
Node.js
Node.js
hapi
hapi
Vue.js
Vue.js
Swagger UI
Swagger UI
Slate
Slate

JavaScript Node.js hapi Vue.js Swagger UI Slate

Two weeks ago we released the public API for Checkly. We already had an API that was serving our frontend Vue.js app. We decided to create an new set of API endpoints and not reuse the already existing one. The blog post linked below details what parts we needed to refactor, what parts we added and how we handled generating API documentation. More specifically, the post dives into:

  • Refactoring the existing Hapi.js based API
  • API key based authentication
  • Refactoring models with Objection.js
  • Validating plan limits
  • Generating Swagger & Slate based documentation
See more

Slate's 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 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 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's 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, you're welcome to not use Github and host your docs elsewhere!

Slate Alternatives & Comparisons

What are some alternatives to Slate?
Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
Swagger UI
Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API
Apiary
It takes more than a simple HTML page to thrill your API users. The right tools take weeks of development. Weeks that apiary.io saves.
ReadMe.io
Collaborative Developer Hubs
jsdoc
JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you.
See all alternatives

Slate's Followers
53 developers follow Slate to keep up with related blogs and decisions.
Tom Bazarnik
Mohamma76685757
Francis Perron
joaquinito01
kavaro
Ravi Gairola
Max Litnitskiy
Not Robert Lord
Dieter Lunn
Peter van Dam