Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: ReadMe.io – Beautiful Documentation Made Easy

readme.io

Post reply on HN
Print view View original

71–80 of 82 posts

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#71

Post by gkoberger »

prottmann wrote: post #70
gkoberger wrote: post #53

Earlier quoted context omitted.

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!

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.

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 greg@readme.io. Awesome work on apiDoc; it's been great.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#72

Post by prottmann »

phaer wrote: post #58
amanvir_sangha wrote: post #54

Earlier quoted context omitted.

It saves a lot of developer time, you would just have to write the docs in markdown, not have to worry about the layout, hosting or building another app just to manage your docs. IMO it provides a lot of value for money. You could always just use the free plan and then upgrade later. With markdown files, you wouldn't really get locked into the platform.

As far as I see, Readme.io has additional features but everything you've listed is available for free on readthedocs.org, built on Sphinx which is free software.

Why should they not coexist? Some want it for free and some want to pay for e.g. support or additional features.

Last time i watch at RTD it was a plain .md project import from e.g. GitHub only to show a plain documentation.

In Readme.io you can edit/write your docs, have blog function and an integrated discussion plattform (for support your users). If you not need this features, you can use RTD or directly sphinx.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#74

Post by StavrosK »

gkoberger wrote: post #37
benbristow wrote: post #21

"ReadMe has made our lives infinitely easier. We've had it on our todo list for over a year, and a day after finding ReadMe we had our docs launched. We're super impressed. You guys have built a fucking awesome tool." I don't know, but having swearing on a professional website is probably not the best way to go. Looks like a nice startup though.

We debated about this a lot. Jesse wrote to us via our Olark plugin, so there was a back-and-forth – he didn't just start swearing. He was one of our first customers, and having someone we didn't know love our product was awesome. We liked how enthusiastic and genuine it sounded, and I've personally never liked when people type "f*cking" (we're all adults; that asterisk isn't tricking anyone.). But alas, we've remove…

    I usually type fuck*ng or m*therfucking.
EDIT: OH MY GOD HOW DO YOU TYPE A FUCKING ASTERISK

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#76

Post by mattstreet »

dkural wrote: post #46
curiously wrote: post #27

Earlier quoted context omitted.

to be fair the people who get appalled by reading the f-word are probably not the target customer. who drops f-word all the time? programmers, entrepreneurs, designers, developers, managers. certainly not established 100 year old corporation, but most certainly the hip, fast moving, horny, 20~30 something olds who eat and breathe technology.

More like insecure, inarticulate brogrammers who are getting burnt out overworking but think it's cool. I don't find swearing to be a conducive way of creating an inclusive, thoughtful work environment. I had enough of this fucking bullshit in college. Time to grow the fuck up.

Okay now I can't tell if you're serious due to the last two fucking sentences.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#80

Post by kordless »

rev_bird wrote: post #28
benbristow wrote: post #21

"ReadMe has made our lives infinitely easier. We've had it on our todo list for over a year, and a day after finding ReadMe we had our docs launched. We're super impressed. You guys have built a fucking awesome tool." I don't know, but having swearing on a professional website is probably not the best way to go. Looks like a nice startup though.

I'm not in any way opposed to vulgarity in general, but I have to admit that this stuck out to me too. Not really necessary. (Though my first thought wasn't "Who puts 'fucking' in their testimonials section," it was "Who puts 'fucking' in a business email to a new vendor?")

It's a word. Specifically, its a word indicating magnitude. I'm not bothered by such words.
Post reply on HN