[DEV] Can't embed wiki in colab

So, because of github security strategies, it seems impossible to embed the wiki in a or <embed> tag inside colab. After quite some researches, the only way I found to bypass that is a bit complicated. Basically, convert the wiki to a jekyll mini-site hosted directly by github. It can easily be done in the settings, but have some flaws:</p> <p>The wiki cannot be the direct source, so we would have to create a directory in the repo containing all the wiki md files and use this directory as the source. It will require to edit the links to point at pages instead of urls, and a few more edits (like the tables), and Home.md must be renamed README.md. Also, any change made in the wiki will require to be pasted to the folder page as well. We could also just remove the wiki and use this to avoid duplicate, since it will also support html (tags and files) much better.</p> <p>I prepared a test repo here: <a rel="noreferrer nofollow" target="_blank" href="https://github.com/machiavel23/test/">https://github.com/machiavel23/test/</a> you can see the result here (not edited, the links will redirect to actual wiki): <a rel="noreferrer nofollow" target="_blank" href="https://machiavel23.github.io/test/">https://machiavel23.github.io/test/</a> it uses Dinky theme, but others can be viewed here: <a rel="noreferrer nofollow" target="_blank" href="https://github.com/pages-themes">https://github.com/pages-themes</a></p> <p>So the question is do we set a mini jekyll site to be able to embed it in a "wiki" tab on colab, or it's not worth the hassle?</p> <p>@VBPXKSMI </p> <p>EDIT you can check the bug here <a rel="noreferrer nofollow" target="_blank" href="https://colab.research.google.com/github/VBPXKSMI/Open-CYOAI-Project/blob/beta/dev_v3.ipynb#scrollTo=65FBEgvGPN7U">https://colab.research.google.com/github/VBPXKSMI/Open-CYOAI-Project/blob/beta/dev_v3.ipynb#scrollTo=65FBEgvGPN7U</a> (wiki tab) the first iframe points to the jekyll mini site, and the second directly to the wiki url</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/VBPXKSMI"><img src="https://avatars.githubusercontent.com/u/58800629?v=4" />VBPXKSMI</a> commented <strong> 4 years ago</strong> </div> <div class="markdown-body"> <p>@machiavel23 Actually, I had already looked into using jekyll before (when I was first creating the Wiki), but at the time it didn't see like it was worth the hassle. I'm not sure, it could be an improvement but it can also become more difficult to use for the Wiki collaborators, not to mention the re-write that would imply.</p> <p>Also the iframe bug needs checking yes, if the output could be centered and scaled somehow it could work on Colab.</p> <p>Overall, I think using jekyll <strong>alone</strong> might be worth looking into (although I'm still not sure). But the implementation of it in Colab tabs would require a bit more work for it to look decent, otherwise a direct link to the WIki would be better.</p> <p>Maybe ran some tests on your side, but focus on the issue later? At least until I'm somewhat done with the re-formatting I'm doing.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/machiavel23"><img src="https://avatars.githubusercontent.com/u/30846033?v=4" />machiavel23</a> commented <strong> 4 years ago</strong> </div> <div class="markdown-body"> <p>don't worry for the iframe formatting, it's pretty easy. the main concern is <strong>do we want it in colab or not</strong>? If not, I'll have to add quite some text and links as small helpers through more or less everything because retards, but if yes, then the iframe will be there so no bloating in other stuff, that's it for the basics.</p> <p>Another thing on using jekyll. We should be able to do html pages in it, so we can do one with a jupyter wrapper like Voilà to make the colab look more like a web-app. So if we decide to use jekyll, the best way to do it would be to create a repo dedicated to it, that would allow us to manage the pages and the theme more conveniently than just use a pre-made theme that doesn't correctly fit what we want. But someone with good html/css skill would be good to find to take care of it, because I won't be able to work on the colab AND the jekyll same time.</p> <p>so, to make it short. with jekyll, we can have cute iframe in colab to show the wiki and maybe even make the colab look like a web-app. without jekyll, there will be some help bloat in each of the colab output tabs, and not much more custom design as it is now.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/VBPXKSMI"><img src="https://avatars.githubusercontent.com/u/58800629?v=4" />VBPXKSMI</a> commented <strong> 4 years ago</strong> </div> <div class="markdown-body"> <blockquote> <p>do we want it in colab or not?</p> </blockquote> <p>That's the issue isn't it? I'm not sure, I would wait for the next version of Colab to be finished to see how everything looks, implementing the Wiki after shouldn't take that much time.</p> <blockquote> <p>But someone with good html/css skill would be good to find to take care of it</p> </blockquote> <p>And this is another issue entirely, either some of us takes care of it aside from maintening the Wiki, or we seek another Anon for help.</p> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>

VBPXKSMI / Open-CYOAI-Project

[DEV] Can't embed wiki in colab #176