This project is archived and is in readonly mode.

#1260 ✓resolved
youarefunny

Offline Documentation

Reported by youarefunny | July 28th, 2011 @ 04:06 PM

When I have to go offline and still wish to work with mootools it is very dificult because I have no access to the documentation. I can write a quick spider but it is not easy. It would be nice if offline documention was provided like PHP or MySQL do.

Comments and changes to this ticket

  • Arian

    Arian July 31st, 2011 @ 04:36 PM

    • Assigned user set to “fakedarren”
    • State changed from “new” to “open”

    You can just use the markdown files for most things. If you would like to see it in a webbrowser and have php running, you could use https://github.com/arian/MooDocs or https://github.com/fakedarren/mootools-docs. With python you can use https://github.com/anutron/mootools-development.

    It's not really on our priority list, but if someone would like to volunteer to make the html files in a zip, or even better, use the html5 offline stuff.

  • youarefunny

    youarefunny August 8th, 2011 @ 07:18 PM

    I have created a python script that will turn the markdown files into html. It also generates a navbar similar to the one at mootools.net/docs. It also has the option to zip them up for easy distributing.

    It depends on some markdown implementation but most should work. (It assumes that it is available at "markdown" in your path) You just might have to change how you enable extensions.

    It also optionally depends on highlight for syntax highlighting and YUI compressor if you wish to compress your css. It has a few options at the top of the script most importantly point docdir to where the documentation is. Hope this works on other peoples computers.

    Currently, links to different pages are broken and the version of markdown that I am running has a bug that header id's don't work so you will see that in the sample and the in-page links won't work (they will go to the right page but there is no proper id on that page).

  • youarefunny

    youarefunny August 9th, 2011 @ 03:03 AM

    Ignore that last post. It was a bad solution made with what I had available. I am going to port it to PHP and do it properly with what you guys already have.

  • Christoph Pojer

    Christoph Pojer August 19th, 2011 @ 12:13 AM

    • State changed from “open” to “resolved”

    There are a couple of solutions out there. Use them. We should maybe link to them from our docs though.

  • youarefunny

    youarefunny August 19th, 2011 @ 06:06 PM

    A link or note would be very much appreciated. I didn't even know I could find them in the git repository.

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

Shared Ticket Bins

Attachments

Pages