Our mission is to make you a search expert. Push data to our API to make it searchable in real time. Build your dream front end with one of our web or mobile UI libraries. Tune relevance and get analytics right from your dashboard. | It is an easy-to-use tool to help you build out documentation! Each documentation site that you publish is a project where there is space for documentation, interactive API reference guides, a changelog, and much more. | Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. |
Database search;Multi-attributes;Search as you type;Analytics dashboard; Ranking; Mobile;
Search in any language;Understand users mistakes;Smart Highlighting;Realtime indexing;Protect your indexes from misuse;Discover realtime faceting;Search objects by location | Collaboration - Crowdsource your docs! Users can keep docs current by suggesting changes.;API Explorer - Let users play with your API right inside the documentation.;GitHub Sync - Keep auto-generated reference docs synced with your actual code.;Editor - Markdown-based drag-and-drop editor makes documentation almost fun.;Theme Builder - Easily create a beautiful dev community that matches your brand.;Support - Let users ask questions and request features in the support forums.;Versioning - Maintaining old or testing beta versions of your docs is a breeze!;Application Keys - Your users can view their application keys embedded right in the docs. | 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! |
