Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy
by ccleve on Tuesday October 07, 2014 @04:45PM
(#8423917)
How does this connect to an API? Does it read Swagger? Or is all the setup (paths, parameters, etc) done manually?
[ Parent
| on HN ]
Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy
by gkoberger on Tuesday October 07, 2014 @04:52PM
(#8423954)
Currently, you can do it manually or using http://apidocjs.com. (The latter is disabled for new accounts due to heavy load; will be back this week.)
Swagger (and a few other even cooler options) are on their way!
Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy
by prottmann on Wednesday October 08, 2014 @04:05AM
(#8425771)
Creator of apiDoc here.... really nice that you use apiDoc :-)
I really like your nice and clean template.
A similar project was in my mind since i create apiDoc, but due the lack of time i am happy now that you create such a project.
Will link to your site soon, so that apiDoc users can see your good alternative for creating and hosting a documentation.
Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy
by gkoberger on Wednesday October 08, 2014 @04:09AM
(#8425788)
Awesome! I looked at a lot of "standards" (Blueprint, RAML, etc), and yours was the first that felt right.
I'd love to talk more! My email is [email protected]. Awesome work on apiDoc; it's been great.
Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy
by ccleve on Tuesday October 07, 2014 @04:58PM
(#8423978)
Swagger would be great. Make sure that you can regen the docs without losing anything when the Swagger spec changes.
What are the cooler options?
(Also, the Blog link in your main menu on the home page 404s)