DocumentUp
Dev tools
documentation generator
SHOW HN2012
How HN took it
3 positive, 1 neutral or asking, 3 mixed, 3 critical, out of 10 comments about the project. Thread score -0.09.
Design: 0 for, 2 againstDocs: 1 for, 0 againstExecution: 1 for, 0 againstIdea: 0 for, 1 against
The thread, comment by comment
Each row is a top-level comment and its replies, in HN's order. Select a cell to open that comment on HN.
positive neutral or mixed critical about another commenter or something else the maker
What HN said
What people liked
Nice navigation makes long READMEs manageable
From 1 comment
I think all-in-one-README works well for some things, but some of our projects at work would result in HUUUGE readme files. Not so pleasant if those were a single file. We have…
stock_toaster on HN
Easy to install and attractive presentation
From 2 comments
Heard about this on Twitter, and in under 3 minutes had this: http://samuelclay.github.com/NewsBlur. Gorgeous and very easy to install. Kudos!
conesus on HNGreat project, easy to install, beautiful presentation. Why limiting to GH pages though? I would love to use it with my markdown documentation, but my project is not on github.
huguesalary on HN
Objections
Breaks or obscures the menu on iOS and zoomed mobile views
From 2 comments
Cool, but the menu gets in your way when you zoom on iPhone.
lux on HNThis would be great if it had a reliable style sheet. This one, however, breaks on iOS, for example. May I recommend BS2?
shpoonj on HN
Lacks a reliable stylesheet
From 1 comment
This would be great if it had a reliable style sheet. This one, however, breaks on iOS, for example. May I recommend BS2?
shpoonj on HN
Serves no content without JavaScript
From 1 comment
This is pretty cool and I know non-javascript users (besides some screen readers) aren't as common but you've gotta give something to people w/o JS, even if it's just "Please…
sequoia on HN
Requests
Support projects not hosted on GitHub (bring your own Markdown)
From 1 comment
Great project, easy to install, beautiful presentation. Why limiting to GH pages though? I would love to use it with my markdown documentation, but my project is not on github.
huguesalary on HN
Add SmartyPants formatting
From 1 comment
Are you considering adding SmartyPants to the formatting? Then again, SmartyPants takes options for which kind of formatting you want to use, and, at least in the Python version,…
kmfrk on HN
Working deep linking to headings
From 1 comment
Oh, also, what do you mean by "deep linking"? I'm not sure what you'd deep-link to... is anything loaded dynamically?
sequoia on HN
Questions
What deep linking means and whether it works
From 2 comments
Oh, also, what do you mean by "deep linking"? I'm not sure what you'd deep-link to... is anything loaded dynamically?
sequoia on HNI mean, being able to link to a specific point (like a H2 or H3) in the README and have the page actually scroll there. Right now I don't think it works (or at least it's…
jeromegn on HN
Alternatives named
Read the Docs (Sphinx-based docs hosting)
From 1 comment
If you're looking for a more mature service, particularly if you're already using Sphinx, checkout http://readthedocs.org/ which includes nice things like full text search, PDF…
acdha on HN
gollum-site
From 1 comment
I think all-in-one-README works well for some things, but some of our projects at work would result in HUUUGE readme files. Not so pleasant if those were a single file. We have…
stock_toaster on HN