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