Serving Demos directly from GitHub

[DonKarlssonSan]

I am experimenting with letting GitHub serve the Kendo demos (kendo-global/demo/*) directly from the repository. So that you can have clickable links in README.md, displayed when you browse to https://github.com/loudenvier/kendo-global.

Benefit: you don't have to download the repository first before you can try the demos.

This is possible by using GitHub Pages (gh-pages). I have a proof of concept in my fork at: https://github.com/DonKarlssonSan/kendo-global/tree/gh-pages, click the links in the Language column in the Credits table. Note that some of the links does not work because the demo file is missing for some translations.

Steps I have taken:

1. Created a branch called 'gh-pages'
2. Inserted hard coded links in README.md to http://donkarlssonsan.github.io/kendo-global/demo/kendo_global.xx-YY.html

The proper way to handle this seems to be:

• Keep your code in branch 'master'
• Have the pages (the web site) you would like GitHub to serve in the branch 'gh-pages'
• Find a way to synch the two branches
  See:
  http://jgoodall.me/posts/2012/10/26/keep-gh-pages-in-sync-with-master/ and
  https://gist.github.com/chrisjacob/833223

But there is a short cut that many seems to use and which I think i perfectly fine in this case:

• Just keep everything in branch 'gh-pages'
• Optionally delete 'master'

What do you think about this idea?

[loudenvier]

I think it is very, very nice... Just commit it to master and make a pull request for me, and I'll iron out any conflicts!

Very nice indeed!!!

Great idea!

[DonKarlssonSan]

Thanks!

Just to make sure I understand you:

You are going for the short cut alternative, keeping everything in 'gh-pages' branch
I commit to 'master' in my fork. I.e. copying what I have in gh-pages to master.
I make a pull request
You put everything in 'gh-pages'

Correct?

But according to https://help.github.com/articles/using-pull-requests you can select which branch the changes should be applied to during pull.

Sorry, I am a GitHub and git newbee.