Beautiful! It helps me. I'm going to implement this. I'll provide you with any feedback once I get going. At a glance your code looks great.
@todo Create A GitHub update hook file, to keep the docs in sync with GitHub That would be pimp :) Great Job! On Sun, Mar 22, 2009 at 1:33 AM, Jay <[email protected]> wrote: > > I wanted to give you all an update. I've got a simple, yet functional > version of mDocs up and running. The script takes Markdown formatted > doc files, and turns them into a docs site, just like mootools.net/ > docs/ <http://mootools.net/%0Adocs/>, on the fly, using the PHP scripting > language. > > You can check out the code here: > http://github.com/jaywilliams/mdocs/ > > And you can see a working demo here: > http://dev.d3done.com/mdocs/ > > Any feedback/suggestions are welcome. I hope it helps someone! > > -- Jay Williams > > On Mar 16, 11:24 am, nutron <[email protected]> wrote: > > I'm going to say that there is no specific license for the css, but go > ahead > > and use it anyway. We're not going to sue you over some css. > > > > On Mon, Mar 16, 2009 at 9:21 AM, Jay-11 (via Nabble) < > > [email protected]<ml-user%[email protected]> > <ml-user%[email protected]<ml-user%[email protected]> > > > > > > > > > > > wrote: > > > > > Thanks for the link to the TM version, I'll check that our for sure. > > > > > That html/js docs system you have running on Clientside is pretty > > > amazing, especially considering it's all powered by JS. But perhaps > > > I'm just old school, but I prefer to have the server create the actual > > > page, and use JS to add enhancements. That way search engines and > > > people with javascript turned off can still view and use the site. > > > > > By the way, would you happen to know if the MooTools Docs site css/ > > > html code is released under the same MIT license that the Docs are > > > under? Because I'd love to use the same layout for my open source > > > mDocs project. > > > > > Thanks! > > > > > -- Jay Williams > > > > > On Mar 15, 10:58 pm, nutron <anut...@...< > http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2487049&i=0>> > > > wrote: > > > > > >http://github.com/nw/moodocs-for-textmate/tree/master<< textmate > version > > > of > > > > the coda plugin with some minor improvements (by nathan white) > > > > I wholeheartedly support you guys making a docs renderer that's > > > standalone > > > > and usable by anyone and releasing it. > > > > > > If you want it, there's an html/js powered renderer available in my > > > > clientcide repos > > > > > > you can see it's output here: > http://www.clientcide.com/cnet.gf/svn/Docs/ > > > > > > On Sun, Mar 15, 2009 at 10:27 AM, Jay-11 (via Nabble) < > > > > ml-user+191949-1675436...@...< > http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2487049&i=1> > > > <ml-user%2b191949-1675436...@...< > http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2487049&i=2>> > > > > > > > wrote: > > > > > > > Thanks pradador for your helpful post! > > > > > > > Your Coda plugin looks like a real timesaver. However, I use > TextMate > > > > > as my editor of choice, but I was able to take your plugin's php > file, > > > > > and dump it straight into a TM bundle and it worked, right out of > the > > > > > box. Very nice! > > > > > > > I've started working on some PHP code which will take a MooTools > like > > > > > "Docs" folder, and render the Markdown formatted files with the > > > > > correct HTML and also create the TOC and side navigation, based off > of > > > > > the files and folders in the documentation folder. I've got the > rough > > > > > code up on GitHub right now:http://github.com/jaywilliams/mdocs/ > > > > > > > My goal will be to have this script running on a web server, and > then > > > > > tell GitHub to notify the script whenever a new change is made to > the > > > > > documentation. When the script gets the notification, It will > > > > > download the latest docs from GitHub and make the necessary > > > > > adjustments on the server. So you'll always have up to date > > > > > documentation, by simply committing the changed documentation. > > > > > > > -- Jay Williams > > > > > > > On Mar 13, 10:47 am, pradador <prada...@...< > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2482107&i=0>> > > > > > wrote: > > > > > > I've had the same idea for a while but I haven't found any > scripts so > > > > > > > > far that do what you want. I have my own semi-automated process > going > > > > > > > > on right now. > > > > > > > > First off, I ended up writing a small PHP parser for MooTools > classes > > > > > > > > and made a plugin for my IDE so that at least the Code -> Docs > > > process > > > > > > is more automated. > > > > > > > > Second, In my latest update, I've made it output links to the > methods > > > > > > > > and classes just like the right side-bar of the MooTools docs. > Once I > > > > > > > > do the MarkDown -> HTML conversion, I simply put these links in a > > > > > > "sidebar" div and a standard CSS file takes care of styling > > > everything > > > > > > perfectly. You could do this from the MarkDown template directly > > > since > > > > > > you can use inline HTML and this would make it automatic. Note > that I > > > > > > > > never have to touch the HTML created from MarkDown... it's easy > > > enough > > > > > > to style things using the hooks the output provides. > > > > > > > > Finally, for the left sidebar, I have a basic HTML file which > > > contains > > > > > > the links and titles of all the Classes I want to document. This > file > > > > > > > > is pulled via a Request.HTML call using MooTools with a script > that > > > is > > > > > > also common to all the files. A simple > "$('nav').load('nav.html');" > > > > > > call takes care of that. > > > > > > > > The only work I have to do is create the template for the > individual > > > > > > pages, create the CSS styles I want, and it's good to go. Well > minus > > > > > > the hours of documentation :-). > > > > > > > > You can look at my plugin @ > > >http://pradador.com/code/coda/moodocs.html > > > > > > or at the PHP script directly from my svn repo @ > > > > >http://moodocs.svn.pradador.com/ > > > > > > > > I also put up a small docs set of stuff I've been working on like > a > > > > > > Syntax Highlighter using MooTools @ > > > > >http://pradador.com/code/docs/lighter.html > > > > > > Check out Quickie.js for a slightly different style just changing > the > > > > > > > > stylesheet. > > > > > > > > Hope this helps! > > > > > > > > On Mar 13, 7:50 am, Jay <d3desi...@...< > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2482107&i=1>> > > > > > wrote: > > > > > > > > > @nutron > > > > > > > > > Just to clarify, I'm well aware that there are many Markdown to > > > HTML > > > > > > > converters out there, in many different languages, that's not > the > > > > > > > question. I was simply wondering if there was any code out > there > > > that > > > > > > > would take the of static markdown doc files and turn them into > a > > > > > > > cohesive documentation site, like MooTool's uses on their site. > > > > > > > > > What I'm planning to do at this point is create a open source > PHP > > > > > > > based clone of the Mootools docs system. And link it to Github, > so > > > > > > > when there is a new commit to the docs, the PHP script will > grab > > > the > > > > > > > new docs, and re-index the documentation. That's the idea at > least. > > > > > > > > > Take care! > > > > > > > > > -- Jay Williams > > > > > > > > > On Mar 13, 12:39 am, nutron <anut...@...< > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2482107&i=2>> > > > > > wrote: > > > > > > > > > > There are a LOT of these already. TextMate has a markdown > > html > > > > > converter > > > > > > > > for instance. I don't think this is something you should > > > reinvent. > > > > > > > > > > On Thu, Mar 12, 2009 at 5:36 PM, d3designs (via Nabble) < > > > > > > > > ml-user+191949-1675436...@...< > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2482107&i=3> > > > > > <ml-user%2b191949-1675436...@...< > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2482107&i=4>> > > > > > > > > > > > wrote: > > > > > > > > > > > Ok, thanks everyone for your input, I guess I'll have to go > out > > > and > > > > > > > > > > > create my own Markdown & Git powered docs system. I just > wanted > > > to > > > > > > > > > check first before I started on it. > > > > > > > > > > > -- Jay Williams > > > > > > > > > > > On Mar 11, 11:52 am, nutron <anut...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2470987&i=0 > >> > > > > > > > > > wrote: > > > > > > > > > > > > They were never meant to be released (the version I sent > is > > > > > actually > > > > > > > > > rather > > > > > > > > > > old, the one powering the mootools.net site much more > > > > > robust...). > > > > > > > > > > That said, there are numerous things out there that > transform > > > > > > > markdown > > > > > > > > > into > > > > > > > > > > html. There's even one written in javascript that you can > > > find in > > > > > the > > > > > > > > > > clientcide libraries. > > > > > > > > > > > > On Wed, Mar 11, 2009 at 8:55 AM, cheeaun (via Nabble) < > > > > > > > > > > ml-user+57134-891164...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2470987&i=1> > > > > > > > > > <ml-user%2b57134-891164...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2470987&i=2 > >> > > > > > > > > > > > > > wrote: > > > > > > > > > > > > > On Mar 11, 11:36 pm, d3designs <d3desi...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2462093&i=0>> > > > > > > > > > > > > > wrote: > > > > > > > > > > > > I really like how the Docs page is setup onhttp:// > > > > > mootools.net/docs/, > > > > > > > > > > > > > > and I was wondering, does anyone know how they're > pulling > > > > > > > that off? > > > > > > > > > > > > Because I'm working on another Open Source project > and > > > would > > > > > love to > > > > > > > > > > > > use a similar Git/Markdown powered docs setup, and > would > > > > > rathe not > > > > > > > > > re- > > > > > > > > > > > > invent the wheel if there is a script out there that > can > > > do > > > > > this. If > > > > > > > > > > > > there isn't a published way to do this, perhaps I'll > > > start a > > > > > new > > > > > > > > > > > > project on Git Hub and create my own. > > > > > > > > > > > > > I've actually asked for the scripts from David Walsh > > > > > (@davidwalshblog) > > > > > > > > > > > and Aaron Newton (@anutron) and got to say, the scripts > are > > > > > > > really > > > > > > > > > > > messy :) I'm planning to write my own as well, using > their > > > > > scripts as > > > > > > > > > > > reference. > > > > > > > > > > > > > Cheers. > > > > > > > > > > > > > ------------------------------ > > > > > > > > > > > View message @ > > > > > > http://n2.nabble.com/Mootools-Git-Md-powered-Docs-tp2461967p2462093.html > > > > > > > > > > > To start a new topic under MooTools Users, email > > > > > > > > > > > ml-node+660466-1583815...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2470987&i=3> > > > > > > > > > <ml-node%2b660466-1583815...@...< > > > > >http://n2.nabble.com/user/SendEmail.jtp?type=node&node=2470987&i=4 > >> > > > > > > > > > > > > > To unsubscribe from MooTools Users, click here< (link > > > removed) > > > > > >. > > > > > > > > > > > > ----- > > > > > > > > > > The MooTools Tutorial: > > > > >http://www.mootorial.comwww.mootorial.com > > > > > > > > > > Clientcide: http://www.clientcide.comwww.clientcide.com > > > > > > > > > > -- > > > > > > > > > > View this message in context: > > > > ... > > > > read more ยป
