Subscribe
Sign in
Slate
p/slate-5Beautiful static documentation for your API
Start new thread
Dan Rowden

Slate - Beautiful static documentation for your API

by•

Add a comment

Replies

Best
Devan Koshal
Just started moving over from Readme.io to Slate. Super easy to customise. http://commercejs.com/docs/
Gregory Koberger
@devankoshal Hey Devan! Would love to hear more about why :)
Robert Lord
Maker
@devankoshal Glad you're enjoying Slate! \o/ Your docs look great.
Devan Koshal
@gkoberger Hey Greg, just came down to customization + price for us right now. We also wanted to have multiple doc styles i.e. api reference (3 column) + guides (2 column)
Karim Jedda
Seriously awesome, I wish there would be some integration with Swagger (which I use extensively). I like the look & feel but most importantly the easy installation. gg!
Bobby Brennan
@karimjdda @stevesun21 if you need swagger/apibp integration, check out our open source API console: https://github.com/lucybot/lucy-...
Robert Lord
Maker
@karimjdda I haven't tried it out, but this project exists: https://github.com/E96/swagger2s...
stevesun21
Really cool. I wonder if this support API blueprint syntax?
Robert Lord
Maker
@stevesun21 hmm, haven't seen a project anywhere that does this.
Robert Lord
Maker
@stevesun21 hmm, don't see Slate on that list anywhere? I'm familiar with API Blueprint, just hadn't seen a Slate converter for it before.
stevesun21
@rl0rd I just try to figure out how's the markdown looks like in Slate. What's the rule of the markdown to describe APIs? Maybe I missed read some info from the README?
Mike Lehmann
I think Stripe uses this as well for their API
Robert Lord
Maker
@mike_lehmann Haha, they don't — I actually based this project off their wonderful documentation.
Kevin Gauthier
We've been using Slate extensively for all of our docs at Smooch.io (docs.smooch.io & docs.smooch.io/rest/) and we love it. We've done quite a lot of customization to it as well, without too much effort. Comes highly recommended.
igor komarnitskiy
Great tool, thank you, offer it to our development team.
Joe Blau
Is there a way to run State inside a node application without requiring a separate server? I run gitignore.io and I've been looking for an alternative to flatdoc since it's not longer maintained.
Paul Williams
Big fan of this style of documentation. Great work by the team behind Slate!
Mathias Hansen
We're a huge fan of Slate over at geocod.io. We've been using it for our docs for more than 2 years now. A cool side-effect to having separate, statically generated docs is that we're able to open source it an accept issues/pull-requests: https://github.com/geocodio/docs