Allow IFRAME in README
Reported by David Baldwin | August 29th, 2008 @ 10:59 AM
I would like to make the documentation for each of my projects more easily accessible and centralized from the README. I find that the documentation for many projects is strewn across blog posts, example applications, GitHub README's, GitHub Wikis, Trac, etc. While it works to just insert links into the README to all of these resources, I think it would be nice to have the ability to include iframes that display this additional content. If a picture is worth a thousand words, a functional example is worth ten thousand.
The main problem that I see with allowing iframes is that it could disrupt the clean and professional look of GitHub. I think this could be solved by initially hiding the iframe and instead displaying some sort of consistent design element that fits in with the GitHub branding. Perhaps just a thin gray button/box that stretches across the screen. Upon clicking on this box it could blind down the iframe. Or it could open the iframe in a lightbox. Either way it keeps the content together with the project, yet does not detract from the GitHub look.
Additionally, a GitHub CSS standard could be offered for developers that want their framed content to blend in even better.
Best Regards, David Baldwin
Comments and changes to this ticket
-
Tekkub September 2nd, 2008 @ 12:25 PM
- → Assigned user changed from “” to “defunkt”
- → State changed from “new” to “open”
Iframes could potentially be abused, this may not be something we want. But that decision is not mine to make...
-
defunkt September 15th, 2008 @ 07:44 PM
What if we allow iframes in the wiki? I don't want a slow loading README file on a tree browse page to be seen as slow GitHub.
-
David Baldwin September 15th, 2008 @ 08:15 PM
I can appreciate that. What about opening up a remote page in a facebox if the class of "facebox" is added to an anchor tag ("rel" doesn't seem to be allowed)?
By the way, here is a link to the centralization I am pushing towards. I'm now attempting to use GitHub to host my blog...http://github.com/bilson/blog
Best Regards, David Baldwin
Please Login or create a free account to add a new comment.
You can update this ticket by sending an email to from your email client. (help)
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile »
