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 <[email protected]> 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 <[email protected]> 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) <
> > [email protected]<ml-user%[email protected]>
>
> > > 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:
> > >http://n2.nabble.com/Mootools-Git-Md-powered-Docs-tp2461967p2462451.html
> > > > Sent from the MooTools Users mailing list archive at Nabble.com.
>
> > > ------------------------------
> > > View message @
> > >http://n2.nabble.com/Mootools-Git-Md-powered-Docs-tp2461967p2470987.html
> > > To start a new topic under MooTools Users, email
> > > [email protected]<ml-node%[email protected]>
> > > 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:http://n2.nabble.com/Mootools-Git-Md-powered-Docs-tp2461967p2471868.html
> > Sent from the MooTools Users mailing list archive at Nabble.com.
