claudioc / jingo

Node.js based Wiki
MIT License
1.02k stars 184 forks source link

Make demo using GitHub Wiki #47

Closed erlend-sh closed 9 years ago

erlend-sh commented 9 years ago

Unless I've completely misunderstood how Jingo works, it should be possible to use Jingo essentially as an alternative front-end for a GitHub Wiki, correct? (If I'm mistaken then I'd appreciate some explanation on what you mean by "compatible".)

Then how about making a demo site that's hooked up with a live GitHub Wiki, so we can see this in action? I'm not very keen on signing up to a demo app, but I'd have no qualms about making edits via GitHub's interface and seeing how they're reflected in Jingo.

claudioc commented 9 years ago

Yes, Jingo is compatible with a Github wiki, but this is true only with version 1.0+. Previous versions are not compatible as-is (you'd have to make some modifications to the documents' name).

Compatibility means that you can checkout a github wiki (which is a "feature" that was not present when Jingo started, if I remember correctly) and then have Jingo use the checked out directory as its documents folder. The README contains additional notes about this procedure.

This does not mean that you can use "transparently" Jingo as a substitute editor/front-end for a live github wiki.

Your idea, at the moment, could not be implemented directly by Jingo due to a limitation on jingo: it does not automatically pull from a repository. It is a design choice, because handling conflicts would be terrible and I see the use case for this not worth the hassles, for now.

So, to recap: Jingo is "compatible" with the wiki format of a github wiki repository in that it can use it as-is locally. It is not meant to be able to "interact" with a live github wiki, unless someone would put in place some trick (a scheduled pull, for example).

erlend-sh commented 9 years ago

Oh I see. Thank you very much for taking the time to clarify.