Show HN: Instant documentation site for Github projects
documentup.com
Show HN: Instant documentation site for Github projects
1–10 of 22 posts
Re: Show HN: Instant documentation site for Github projects
#2I needed it for one of my projects and so I whipped up this simple documentation generator. It takes your README.md and turns it into an easier to navigate documentation site. Meant to be used on a gh-pages branch.
There's still much to do. This is an MVP.
Re: Show HN: Instant documentation site for Github projects
#3I needed it for one of my projects and so I whipped up this simple documentation generator. It takes your README.md and turns it into an easier to navigate documentation site. Meant to be used on a gh-pages branch. There's still much to do. This is an MVP.
this is good.. have you shown it to the github guys and gals yet?
Re: Show HN: Instant documentation site for Github projects
#4I needed it for one of my projects and so I whipped up this simple documentation generator. It takes your README.md and turns it into an easier to navigate documentation site. Meant to be used on a gh-pages branch. There's still much to do. This is an MVP.
this is good.. have you shown it to the github guys and gals yet?
I haven't. Just having some fun, built this to hone my front-end skills and because I needed it.
Re: Show HN: Instant documentation site for Github projects
#5This 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 turn on javascript. Read text version here a:github.com/user/project/README.md" or something. I understand modern web apps not always degrading but this is almost 100% flat text, there should be some way to serve all users.
Looks nice tho!!
Re: Show HN: Instant documentation site for Github projects
#6Oh, also, what do you mean by "deep linking"? I'm not sure what you'd deep-link to... is anything loaded dynamically?
Re: Show HN: Instant documentation site for Github projects
#7This 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 turn on javascript. Read text version here a:github.com/user/project/README.md" or something. I understand modern web apps not always degrading but this is almost 100% flat text, there should be some way to serve all users. Looks nice tho!!
Good point. Noted here: https://github.com/jeromegn/DocumentUp/issues/2
Re: Show HN: Instant documentation site for Github projects
#8Oh, also, what do you mean by "deep linking"? I'm not sure what you'd deep-link to... is anything loaded dynamically?
I 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 completely untested.)
Re: Show HN: Instant documentation site for Github projects
#9One nice thing about GitHub and Bitbucket's focus on the project's README is that more software projects are providing a good, instantly-readable summary of their project in the README instead of making you have to go elsewhere to find out what it's all about and how to get started.
One not-so-nice thing about GitHub and Bitbucket's focus on the project's README is that I have noticed several projects that dump all their project's documentation into the README and the examples instead of having proper narrative and API documentation.
Re: Show HN: Instant documentation site for Github projects
#10Heard about this on Twitter, and in under 3 minutes had this: http://samuelclay.github.com/NewsBlur. Gorgeous and very easy to install. Kudos!