Create Github page with documentation

[daaain]

There's a lot of nice documentation in the project which is not accessible directly in Github making it impossible to read without doing a clone.

Github provides a super simple way of rendering documentation by creating a branch called gh-pages and committing relevant files in there, see http://pages.github.com.

It would be great to set this up, I'm happy to make a pull request with the relevant files if someone sets the branch up.

See page here: http://w3c.github.com/tidy-html5/

[sideshowbarker]

OK I created a gh-pages branch. I just used the default automatic-creator thing, so feel free to just clobber that default index file with whatever you want to have show up there instead.

[daaain]

Moving further ideas here for discussion:

1. I'm considering linking the Quick Reference in index.html as a next step, maybe even creating some sort of navigation on the top with all the essential links – first few paragraphs of the documentation are links anyway.
2. Maybe adding zip- / tar-ball download links and "Fork me on Github" banner as it was on the auto-generated page could be useful too?
3. Oh and of course we should link to this URL in the master readme once it's up!

[sideshowbarker]

http://w3c.github.com/tidy-html5/ is live now. Thanks

There's a link to the quickref already but if you want to link to it somewhere else on the page that'd be fine too.

Adding links to the tarball and zip would be good.

I have updated the readme.

[daaain]

Finally got around to put these links in (sorry for the delay) and just submitted a pull request, take a look!

[sideshowbarker]

The tar and zip download icons are really just too big and ugly. I'm not sure how useful they really are to people anyway, but I'll try to think of some way to add them that's less obtrusive.

I'm also not sure we really need the "fork me on github" band here. Given the fact the first sentence of the page is a link to github, the banner's just sort of window dressing.

[daaain]

I think it's nice to have download links, sometimes people will just want to get Tidy quickly without having to clone the repo. That being said, it would make much more sense having links to compiled binaries for each platform or even an online tool (after all the compilation is a much bigger hurdle than figuring Git out), but these would be a bit more effort to set up :) Hopefully Travis or some similar platform will do C at some point, but I'm not holding my breath.

I've added the banner as a standard thing which most Github Pages have, but you're completely right about it just repeating info in the first sentence so it should be either / or.

[daaain]

Wait a second, Travis does actually do C apparently: http://groups.google.com/group/travis-ci/browse_thread/thread/cfd24d0c68cacfef

It's only going to be useful for Linux builds (VMs are 32-bit Ubuntu Linux 11.04 (server edition)), but might still be useful to have a CI server with tests running. This sounds like something which should be discussed as a separate issue though...

[sideshowbarker]

Closing this out. For any further changes needed to the Web page, please just open new issues.