Slate – beautiful static documentation for your API

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

Slate generates static HTML, JavaScript, and CSS, so it’s easy to host.

This is free and open source software.

Key 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. 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 over 100 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.
• 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.
• RTL Support Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc.

Website: code.lord.io/slate
Support:
Developer: Slate developers
License: Apache License 2.0

Slate is written in Ruby. Learn Ruby with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software. We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.