Featured comment
Marcel Pociot
@marcelpociot · Web/App developer, ORT interactive GmbH
Writing API documentation isn't a very fun thing to do. And most of the documentations (even when using markdown) just look ugly. The Stripe API documentation is a perfect example of how a good API documentation must look like. It also provides code snippets for multiple languages.
There's already an existing tool that outputs this kind of documentation, bu… See more
3sharetweet・
Hunter
Makers
Discussion
M
Marcel Pociot
@marcelpociot · Web/App developer, ORT interactive GmbH
Writing API documentation isn't a very fun thing to do. And most of the documentations (even when using markdown) just look ugly. The Stripe API documentation is a perfect example of how a good API documentation must look like. It also provides code snippets for multiple languages.
There's already an existing tool that outputs this kind of documentation, bu… See more
Elia Morling
@tribaling · IdeaHunt.io
I was slightly confused by the image actually :) I thought it was a physical product
Ben Tossell
@bentossell · Community Lead, Product Hunt
@marcelpociot tell us the inspiration here :)
Vali Draganescu
@vfdraganescu · Mobile app developer
It's nice but still not what I would expect. There must be a way to generate API documentation seamlessly. You're on the right track though I would prefer a more UI based solution because I think writing MD is boring. But hey, that's just my opinion.
Brian J King
@brianjking
Nice, thanks for sharing! I currently use MkDocs or Sphinx for most documentation I am writing as most of it is prose content with small snippets of code. However, I can definitely see where this would work nicely.