Slate API Docs Generator
Create beautiful, intelligent, responsive API documentation.
- Free • Open Source
- Documentation Generators
- Mac
- Linux
- Self-Hosted
▼
What is Slate API Docs Generator?
Slate - beautiful static documentation for your API.
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.
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.
Show full description ▾
Features Vote on or suggest new features
This app doesn't have any features at the moment.Comments and Reviews Post a comment / review all • positive • negative relevance • date
No comments or reviews, maybe you want to be first?Tags
- Documentation Generators
- api-documentation
Lists containing Slate API Docs Generator
My Setup - All Apps and Software • Need2Try
Slate API Docs Generator
Summary
Our users have written 0 comments and reviews about Slate API Docs Generator, and it has gotten 18 likes
- Developed by TripIt
- Open Source and Free product.
- 30 alternatives listed
Popular alternatives
View allSlate API Docs Generator was added to AlternativeTo by Ugotsta on Mar 2, 2016 and this page was last updated Jul 9, 2019.
Recent user activities on Slate API Docs Generator
- TeamProtoForce added Slate API Docs Generator as alternative(s) to ProtoForce9 months ago
- Rhelython liked Slate API Docs Generator10 months ago
- developerhub added Slate API Docs Generator as alternative(s) to DeveloperHub10 months ago