search

jeromegn / DocumentUp

Pretty documentation generator for Github projects with proper Readme.
http://documentup.com
883 stars 90 forks source link

DocumentUp for wiki pages #38

Open ForbesLindesay opened 12 years ago

ForbesLindesay commented 12 years ago

It would be great to have DocumentUp be available for wiki pages.

jeromegn commented 12 years ago

Please explain :) I don't see it. You mean, it could use markdown from the wiki?

ForbesLindesay commented 12 years ago

I mean, when you write wiki pages in github, you write them in markdown. It would be good to be able to view these in DocumentUp in the same way you can the readme files. e.g. https://github.com/LearnBoost/Socket.IO/wiki/Configuring-Socket.IO would be viewable when you went to https://documentup.com/LearnBoost/Socket.IO/wiki/Configuring-Socket.IO but would have all the extra niceties that documentup adds in terms of navigation etc.

jeromegn commented 12 years ago

Not a bad idea. Similar to the "multiple pages" (#1) feature.

ForbesLindesay commented 12 years ago

Yeh, the advantage would be that in most repositories, anyone can edit the wiki pages, so they are sometimes more detailed/complete, and when they have errors in the markdown that cause documentup to fail, anyone can fix those bugs without having to submit pull requests.

jeromegn commented 12 years ago

That makes sense.

From what I gather, that means I need to set an expiration for wiki pages so that I'd be able to recompile at some point without user intervention. (since there's no post-receive hook for wiki pages)

I'll look into that.

ForbesLindesay commented 12 years ago

Yeh, I think you're right.

neerajsingh0101 commented 12 years ago

@jeromegn try asking github to add post-receive hook for wiki pages. who knows they might support it.