Your example page is kinda busted when scrolling horizontally. (on Chrome 37)
Looks good otherwise though.
Show HN: ReadMe.io – Beautiful Documentation Made Easy
11–20 of 82 posts
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#12This seems highly dependent on Javascript for displaying its (actually static) content. As someone who likes his notebook fan to stay calm and not have websites shove obnoxious things into her face and thus browses with JS off by default, please do not require Javascript to read your documentation. JS is nice for animations or truly dynamic content, but why require it for static things like this?
I am just guessing, but the site uses CodeMirror (JS) to do syntax highlighting.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#13Hey all, founder here! I've worked at a bunch of startups, and inevitably we'd have to make a dev.startup.com and I'd wonder why we were re-inventing the wheel each time. Every startup needs this, they all have the same basic features, yet every startup has to do it themselves. Ergo, ReadMe! I wanted to do more than just documentation; it's a full developer hub for your community. The goal is to make it so any startu…
Looks great. Wish there was a plan for opensource projects, which allowed me to use customized landing page etc.
E-mail me (support@readme.io); we'll hook you up :)
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#14Heap Analytics is in the process of moving over our documentation to ReadMe.io and so far the process has been amazing.
The ReadMe team is really responsive and helpful, the documentation is beautiful and the interface goes above and beyond.
Just to give you an idea of how polished the service is, if you select a background color that contrasts poorly with the text, the interface will let you know. It also automatically generates a "white" logo for darker pages. This has almost nothing to do with writing documentation, but has a lot to do with making documents readable for users, which is easy to overlook if you're not a designer.
See our docs: http://docs.heapanalytics.com/
Right now they are a transcription from http://heapanalytics.com/docs but we're planning more robust docs and ReadMe will make that process a lot smoother.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#15This seems highly dependent on Javascript for displaying its (actually static) content. As someone who likes his notebook fan to stay calm and not have websites shove obnoxious things into her face and thus browses with JS off by default, please do not require Javascript to read your documentation. JS is nice for animations or truly dynamic content, but why require it for static things like this?
I am just guessing, but the site uses CodeMirror (JS) to do syntax highlighting.
Check out the examples, they load content via JS.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#16The most important feature for documentation is /a really good/ search. I can't see anything about searching on the site? Can you clarify? IMO everybody should use https://readthedocs.org/ for documentation since all the docs will be put into elasticsearch (backed by Rackspace FYI) and the results when searching are of really good quality.
Agreed! ReadMe does search, with the added benefit of also searching user questions, blog posts and errors.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#17Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#18Heap Analytics is in the process of moving over our documentation to ReadMe.io and so far the process has been amazing. The ReadMe team is really responsive and helpful, the documentation is beautiful and the interface goes above and beyond. Just to give you an idea of how polished the service is, if you select a background color that contrasts poorly with the text, the interface will let you know. It also automatica…
[deleted]
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#19Heap Analytics is in the process of moving over our documentation to ReadMe.io and so far the process has been amazing. The ReadMe team is really responsive and helpful, the documentation is beautiful and the interface goes above and beyond. Just to give you an idea of how polished the service is, if you select a background color that contrasts poorly with the text, the interface will let you know. It also automatica…
[deleted]
This came up when we were working on this, the team at ReadMe has been very responsive about this and I don't feel like we'll be trapped on the platform. They use Markdown for almost everything except some widgets, and since I'm going to use mainly Markdown I don't feel locked in.
I also feel confident that if I kindly asked for the contents of my site, the team at ReadMe would send it on over in what ever way they could. That may change in a year, but I doubt it, if anything, I bet they'll have a more automated way to get content in and out.
The ToS sounds pretty standard for "content" sites... that is, they have to have the rights to display the content, since they are the host. In my experience you're much more likely to get a shady crawler copying your content and reposting it than the service you pay using it in ways you didn't expect.
edit: woops you deleted. I think your questions were very valid, so I'll leave my reply :)
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#20Hey all, founder here! I've worked at a bunch of startups, and inevitably we'd have to make a dev.startup.com and I'd wonder why we were re-inventing the wheel each time. Every startup needs this, they all have the same basic features, yet every startup has to do it themselves. Ergo, ReadMe! I wanted to do more than just documentation; it's a full developer hub for your community. The goal is to make it so any startu…
Congrats Greg for your first product! At least it looks fantastic! I haven't tried it properly yet. But I hope to see many more awesome things like ReadMe in the future.
And I am amazed to see that you guys pulled it off with the living in a different country bit. Amazing! :)